From 5a72e0ceb5373c495343e9ea590e9d8a3a7d2341 Mon Sep 17 00:00:00 2001 From: csviri Date: Mon, 7 Mar 2022 09:33:48 +0100 Subject: [PATCH] fix: javadoc for fails snapshot release --- .../external/AbstractSimpleDependentResource.java | 7 ++++++- .../event/ExternalResourceCachingEventSource.java | 3 +-- .../processing/event/source/CachingEventSource.java | 6 ------ 3 files changed, 7 insertions(+), 9 deletions(-) diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResource.java index 18de3390e0..564646b217 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResource.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResource.java @@ -34,7 +34,12 @@ public Optional getResource(HasMetadata primaryResource) { return cache.get(ResourceID.fromResource(primaryResource)); } - /** Actually read the resource from the target API */ + /** + * Actually read the resource from the target API + * + * @param primaryResource the primary associated resource + * @return fetched resource if present + **/ public abstract Optional fetchResource(HasMetadata primaryResource); @Override diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/ExternalResourceCachingEventSource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/ExternalResourceCachingEventSource.java index 5ffa9b2166..f69b33dd43 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/ExternalResourceCachingEventSource.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/ExternalResourceCachingEventSource.java @@ -5,8 +5,7 @@ import io.javaoperatorsdk.operator.processing.event.source.CachingEventSource; public class ExternalResourceCachingEventSource - extends CachingEventSource - implements RecentOperationCacheFiller { + extends CachingEventSource implements RecentOperationCacheFiller { public ExternalResourceCachingEventSource(Class resourceClass) { super(resourceClass); diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/CachingEventSource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/CachingEventSource.java index cfc065331d..57d94d8922 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/CachingEventSource.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/CachingEventSource.java @@ -10,12 +10,6 @@ /** * Base class for event sources with caching capabilities. *

- * {@link #handleDelete(ResourceID)} - if the related resource is present in the cache it is removed - * and event propagated. There is no event propagated if the resource is not in the cache. - *

- * {@link #handleEvent(Object, ResourceID)} - caches the resource if changed or missing. Propagates - * an event if the resource is new or not equals to the one in the cache, and if accepted by the - * filter if one is present. * * @param represents the type of resources (usually external non-kubernetes ones) being handled. */