Skip to content

Commit f406193

Browse files
committed
fix(javadoc): invalid method ref blocks snapshot release (#3076)
simplified the javadoc Signed-off-by: Attila Mészáros <[email protected]>
1 parent c340849 commit f406193

File tree

1 file changed

+2
-27
lines changed
  • operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer

1 file changed

+2
-27
lines changed

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -40,33 +40,8 @@
4040
/**
4141
* Wraps informer(s) so they are connected to the eventing system of the framework. Note that since
4242
* this is built on top of Fabric8 client Informers, it also supports caching resources using
43-
* caching from informer caches as well as additional caches described below.
44-
*
45-
* <p>InformerEventSource also supports two features to better handle events and caching of
46-
* resources on top of Informers from the Fabric8 Kubernetes client. These two features are related
47-
* to each other as follows:
48-
*
49-
* <ol>
50-
* <li>Ensuring the cache contains the fresh resource after an update. This is important for
51-
* {@link io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource} and mainly
52-
* for {@link
53-
* io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource} so
54-
* that {@link
55-
* io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource#getSecondaryResource(HasMetadata,
56-
* Context)} always returns the latest version of the resource after a reconciliation. To
57-
* achieve this {@link #handleRecentResourceUpdate(ResourceID, HasMetadata, HasMetadata)} and
58-
* {@link #handleRecentResourceCreate(ResourceID, HasMetadata)} need to be called explicitly
59-
* after a resource is created or updated using the kubernetes client. These calls are done
60-
* automatically by the KubernetesDependentResource implementation. In the background this
61-
* will store the new resource in a temporary cache {@link TemporaryResourceCache} which does
62-
* additional checks. After a new event is received the cached object is removed from this
63-
* cache, since it is then usually already in the informer cache.
64-
* <li>Avoiding unneeded reconciliations after resources are created or updated. This filters out
65-
* events that are the results of updates and creates made by the controller itself because we
66-
* typically don't want the associated informer to trigger an event causing a useless
67-
* reconciliation (as the change originates from the reconciler itself). For the details see
68-
* {@link #canSkipEvent(HasMetadata, HasMetadata, ResourceID)} and related usage.
69-
* </ol>
43+
* caching from informer caches as well as filtering events which are result of the controller's
44+
* update.
7045
*
7146
* @param <R> resource type being watched
7247
* @param <P> type of the associated primary resource

0 commit comments

Comments
 (0)