Skip to content

docs: fix javadoc issues #1887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 5, 2023
Merged

docs: fix javadoc issues #1887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...src/main/java/io/javaoperatorsdk/operator/api/config/ResolvedControllerConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ public ResourceEventFilter<P> getEventFilter() {
/**
* @deprecated Use {@link OnAddFilter}, {@link OnUpdateFilter} and {@link GenericFilter} instead
*
* @param eventFilter
* @param eventFilter generic event filter
*/
@Deprecated(forRemoval = true)
protected void setEventFilter(ResourceEventFilter<P> eventFilter) {
Expand Down
2 changes: 2 additions & 0 deletions .../io/javaoperatorsdk/operator/processing/dependent/DependentResourceWithExplicitState.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ default Optional<String> eventSourceName() {

/**
* Class of the state resource.
*
* @return the type of the resource that stores state
*/
Class<S> stateResourceClass();

Expand Down
6 changes: 4 additions & 2 deletions ...peratorsdk/operator/processing/dependent/kubernetes/GenericKubernetesResourceMatcher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,20 @@ static <R extends HasMetadata, P extends HasMetadata> Matcher<R, P> matcherFor(

/**
* {@inheritDoc}
* <p/>
* <p>
* This implementation attempts to cover most common cases out of the box by considering
* non-additive changes to the resource's spec (if the resource in question has a {@code spec}
* field), making special provisions for {@link ConfigMap} and {@link Secret} resources. Additive
* changes (i.e. a field is added that previously didn't exist) are not considered as triggering a
* mismatch by default to account for validating webhooks that might add default values
* automatically when not present or some other controller adding labels and/or annotations.
* <p/>
* </p>
* <p>
* It should be noted that this implementation is potentially intensive because it generically
* attempts to cover common use cases by performing diffs on the JSON representation of objects.
* If performance is a concern, it might be easier / simpler to provide a {@link Matcher}
* implementation optimized for your use case.
* </p>
*/
@Override
public Result<R> match(R actualResource, P primary, Context<P> context) {
Expand Down