Skip to content

Commit cd50a73

Browse files
authored
docs: filter docs javadoc (#984)
1 parent 1e17e75 commit cd50a73

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ default boolean watchCurrentNamespace() {
6868
static boolean currentNamespaceWatched(Set<String> namespaces) {
6969
return namespaces != null
7070
&& namespaces.size() == 1
71-
&& namespaces.contains(
72-
Constants.WATCH_CURRENT_NAMESPACE);
71+
&& namespaces.contains(Constants.WATCH_CURRENT_NAMESPACE);
7372
}
7473

7574
/**
@@ -101,15 +100,17 @@ default RetryConfiguration getRetryConfiguration() {
101100
default void setConfigurationService(ConfigurationService service) {}
102101

103102
default boolean useFinalizer() {
104-
return !Constants.NO_FINALIZER
105-
.equals(getFinalizer());
103+
return !Constants.NO_FINALIZER.equals(getFinalizer());
106104
}
107105

108106
/**
109-
* Allow controllers to filter events before they are provided to the
110-
* {@link io.javaoperatorsdk.operator.processing.event.EventHandler}. Note that the provided
111-
* filter is combined with {@link #isGenerationAware()} to compute the final set of filters that
112-
* should be applied;
107+
* Allow controllers to filter events before they are passed to the
108+
* {@link io.javaoperatorsdk.operator.processing.event.EventHandler}.
109+
*
110+
* <p>
111+
* Resource event filters only applies on events of the main custom resource. Not on events from
112+
* other event sources nor the periodic events.
113+
* </p>
113114
*
114115
* @return filter
115116
*/

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ControllerConfiguration.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,10 @@
5151

5252

5353
/**
54-
* Optional list of classes providing custom {@link ResourceEventFilter}.
54+
* <p>
55+
* Resource event filters only applies on events of the main custom resource. Not on events from
56+
* other event sources nor the periodic events.
57+
* </p>
5558
*
5659
* @return the list of event filters.
5760
*/

0 commit comments

Comments
 (0)