Skip to content

Commit

Permalink
Merge pull request #1465 from yue9944882/watch-event-filter
Browse files Browse the repository at this point in the history
Swap javadoc for filter annotations
  • Loading branch information
k8s-ci-robot committed Jan 3, 2021
2 parents 42b5069 + f7279e1 commit cd84eaa
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
Expand Up @@ -19,12 +19,13 @@
import java.lang.annotation.Target;

/**
* Indicates that the method is a filter for {@link io.kubernetes.client.informer.EventType#DELETED}
* from watches.
* Indicates that the method is a filter for {@link
* io.kubernetes.client.informer.EventType#MODIFIED} from watches.
*
* <p>A delete-event filter must have the signature as {@link
* java.util.function.BiPredicate<ApiType,ApiType>} where the 1st parameter is the old state of the
* resource and the 2nd is the new state.
* <p>A update-event filter must have the signature as {@link
* java.util.function.BiPredicate<ApiType, Boolean>} where the 1st parameter is the
* "before-deletion" state of the resource and the 2nd indicates whether the cache entry for the
* resource is stale.
*/
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
Expand Down
Expand Up @@ -18,13 +18,12 @@
import java.lang.annotation.Target;

/**
* Indicates that the method is a filter for {@link
* io.kubernetes.client.informer.EventType#MODIFIED} from watches.
* Indicates that the method is a filter for {@link io.kubernetes.client.informer.EventType#DELETED}
* from watches.
*
* <p>A update-event filter must have the signature as {@link
* java.util.function.BiPredicate<ApiType, Boolean>} where the 1st parameter is the
* "before-deletion" state of the resource and the 2nd indicates whether the cache entry for the
* resource is stale.
* <p>A delete-event filter must have the signature as {@link
* java.util.function.BiPredicate<ApiType,ApiType>} where the 1st parameter is the old state of the
* resource and the 2nd is the new state.
*/
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
Expand Down

0 comments on commit cd84eaa

Please sign in to comment.