switching to nested, rather than a builder

and adding a changelog

Author: shawkins

CHANGELOG.md

@@ -16,6 +16,7 @@
 * Fix #3225: Pod metric does not have corresponding label selector variant
 * Fix #3243: pipes provided to exec command are no longer closed on connection close, so that client can fully read the buffer after the command finishes.
 * Fix #3272: prevent index npe after informer sees an empty list
+* Fix #3275: filter related dsl methods withLabel, withField, etc. should not modify the current context.  If you need similar behavior to the previous use `Filterable.withNewFilter`.
 
 #### Improvements
 * Fix #3078: adding javadocs to further clarify patch, edit, replace, etc. and note the possibility of items being modified.

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/FilterBuilder.java renamed to kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/FilterNested.java

@@ -16,8 +16,12 @@
 
 package io.fabric8.kubernetes.client.dsl;
 
-import io.fabric8.kubernetes.api.builder.Builder;
+import io.fabric8.kubernetes.api.builder.Nested;
 
-public interface FilterBuilder<T> extends Filterable<FilterBuilder<T>>, Builder<T> {
+public interface FilterNested<T> extends Filterable<FilterNested<T>>, Nested<T> {
+  
+  default T endFilter() {
+    return and();
+  }
 
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/FilterWatchListDeletable.java

@@ -18,9 +18,9 @@
 public interface FilterWatchListDeletable<T, L> extends Filterable<FilterWatchListDeletable<T, L>>, WatchListDeletable<T, L> {
 
   /**
-   * Accumulate a filter on the context, when done {@link FilterBuilder#build()} must be called
-   * @return a filter builder
+   * Accumulate a filter on the context, when done {@link FilterNested#endFilter()} or and must be called
+   * @return a {@link FilterNested}
    */
-  FilterBuilder<FilterWatchListDeletable<T, L>> withFilter(); 
+  FilterNested<FilterWatchListDeletable<T, L>> withNewFilter(); 
 
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/base/BaseOperation.java

@@ -42,7 +42,7 @@
 import io.fabric8.kubernetes.client.Watch;
 import io.fabric8.kubernetes.client.Watcher;
 import io.fabric8.kubernetes.client.dsl.EditReplacePatchDeletable;
-import io.fabric8.kubernetes.client.dsl.FilterBuilder;
+import io.fabric8.kubernetes.client.dsl.FilterNested;
 import io.fabric8.kubernetes.client.dsl.FilterWatchListDeletable;
 import io.fabric8.kubernetes.client.dsl.Gettable;
 import io.fabric8.kubernetes.client.dsl.Informable;
@@ -406,70 +406,70 @@ public final T createOrReplace(T... items) {
 
   @Override
   public FilterWatchListDeletable<T, L> withLabels(Map<String, String> labels) {
-    return withFilter().withLabels(labels).build();
+    return withNewFilter().withLabels(labels).endFilter();
   }
 
   @Override
   public FilterWatchListDeletable<T, L> withLabelSelector(LabelSelector selector) {
-    return withFilter().withLabelSelector(selector).build();
+    return withNewFilter().withLabelSelector(selector).endFilter();
   }
 
   @Override
   public FilterWatchListDeletable<T, L> withoutLabels(Map<String, String> labels) {
-    return withFilter().withoutLabels(labels).build();
+    return withNewFilter().withoutLabels(labels).endFilter();
   }
 
   @Override
   public FilterWatchListDeletable<T, L> withLabelIn(String key, String... values) {
-    return withFilter().withLabelIn(key, values).build();
+    return withNewFilter().withLabelIn(key, values).endFilter();
   }
 
   @Override
   public FilterWatchListDeletable<T, L> withLabelNotIn(String key, String... values) {
-    return withFilter().withLabelNotIn(key, values).build();
+    return withNewFilter().withLabelNotIn(key, values).endFilter();
   }
 
   @Override
   public FilterWatchListDeletable<T, L> withLabel(String key, String value) {
-    return withFilter().withLabel(key, value).build();
+    return withNewFilter().withLabel(key, value).endFilter();
   }
 
   @Override
   public FilterWatchListDeletable<T, L> withoutLabel(String key, String value) {
-    return withFilter().withoutLabel(key, value).build();
+    return withNewFilter().withoutLabel(key, value).endFilter();
   }
 
   @Override
   public FilterWatchListDeletable<T, L> withFields(Map<String, String> fields) {
-    return withFilter().withFields(fields).build();
+    return withNewFilter().withFields(fields).endFilter();
   }
 
   @Override
   public FilterWatchListDeletable<T, L> withField(String key, String value) {
-    return withFilter().withField(key, value).build(); 
+    return withNewFilter().withField(key, value).endFilter(); 
   }
 
   @Override
   public FilterWatchListDeletable<T, L> withInvolvedObject(ObjectReference objectReference) {
     if (objectReference != null) {
-      return withFilter().withInvolvedObject(objectReference).build();
+      return withNewFilter().withInvolvedObject(objectReference).endFilter();
     }
     return this;
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withFilter() {
-    return new FilterBuilderImpl<>(this);
+  public FilterNested<FilterWatchListDeletable<T, L>> withNewFilter() {
+    return new FilterNestedImpl<>(this);
   }
 
   @Override
   public FilterWatchListDeletable<T, L> withoutFields(Map<String, String> fields) {
-    return withFilter().withoutFields(fields).build();
+    return withNewFilter().withoutFields(fields).endFilter();
   }
 
   @Override
   public FilterWatchListDeletable<T, L> withoutField(String key, String value) {
-    return withFilter().withoutField(key, value).build();
+    return withNewFilter().withoutField(key, value).endFilter();
   }
 
   public String getLabelQueryParam() {

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/base/FilterBuilderImpl.java renamed to kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/base/FilterNestedImpl.java

@@ -21,7 +21,7 @@
 import io.fabric8.kubernetes.api.model.LabelSelector;
 import io.fabric8.kubernetes.api.model.LabelSelectorRequirement;
 import io.fabric8.kubernetes.api.model.ObjectReference;
-import io.fabric8.kubernetes.client.dsl.FilterBuilder;
+import io.fabric8.kubernetes.client.dsl.FilterNested;
 import io.fabric8.kubernetes.client.dsl.FilterWatchListDeletable;
 import io.fabric8.kubernetes.client.dsl.Resource;
 import io.fabric8.kubernetes.client.utils.Utils;
@@ -31,7 +31,7 @@
 import java.util.List;
 import java.util.Map;
 
-final class FilterBuilderImpl<T extends HasMetadata, L extends KubernetesResourceList<T>, R extends Resource<T>> implements FilterBuilder<FilterWatchListDeletable<T, L>> {
+final class FilterNestedImpl<T extends HasMetadata, L extends KubernetesResourceList<T>, R extends Resource<T>> implements FilterNested<FilterWatchListDeletable<T, L>> {
 
   private static final String INVOLVED_OBJECT_NAME = "involvedObject.name";
   private static final String INVOLVED_OBJECT_NAMESPACE = "involvedObject.namespace";
@@ -44,10 +44,7 @@ final class FilterBuilderImpl<T extends HasMetadata, L extends KubernetesResourc
   private final BaseOperation<T, L, R> baseOperation;
   private OperationContext context;
 
-  /**
-   * @param baseOperation
-   */
-  FilterBuilderImpl(BaseOperation<T, L, R> baseOperation) {
+  FilterNestedImpl(BaseOperation<T, L, R> baseOperation) {
     this.baseOperation = baseOperation;
     // create a context copy
     context = this.baseOperation.context;
@@ -63,38 +60,38 @@ final class FilterBuilderImpl<T extends HasMetadata, L extends KubernetesResourc
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withLabels(Map<String, String> labels) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withLabels(Map<String, String> labels) {
     this.context.labels.putAll(labels);
     return this;
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withoutLabels(Map<String, String> labels) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withoutLabels(Map<String, String> labels) {
     // Re-use "withoutLabel" to convert values from String to String[]
     labels.forEach(this::withoutLabel);
     return this;
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withLabelIn(String key, String... values) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withLabelIn(String key, String... values) {
     context.labelsIn.put(key, values);
     return this;
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withLabelNotIn(String key, String... values) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withLabelNotIn(String key, String... values) {
     context.labelsNotIn.put(key, values);
     return this;
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withLabel(String key, String value) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withLabel(String key, String value) {
     context.labels.put(key, value);
     return this;
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withoutLabel(String key, String value) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withoutLabel(String key, String value) {
     context.labelsNot.merge(key, new String[]{value}, (oldList, newList) -> {
       final String[] concatList = (String[]) Array.newInstance(String.class, oldList.length + newList.length);
       System.arraycopy(oldList, 0, concatList, 0, oldList.length);
@@ -105,26 +102,26 @@ public FilterBuilder<FilterWatchListDeletable<T, L>> withoutLabel(String key, St
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withFields(Map<String, String> fields) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withFields(Map<String, String> fields) {
     this.context.fields.putAll(fields);
     return this;
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withField(String key, String value) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withField(String key, String value) {
     this.context.fields.put(key, value);
     return this;
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withoutFields(Map<String, String> fields) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withoutFields(Map<String, String> fields) {
     // Re-use "withoutField" to convert values from String to String[]
     fields.forEach(this::withoutField);
     return this;
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withoutField(String key, String value) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withoutField(String key, String value) {
     context.fieldsNot.merge(key, new String[]{value}, (oldList, newList) -> {
       if (Utils.isNotNullOrEmpty(newList[0])) { // Only add new values when not null
         final String[] concatList = (String[]) Array.newInstance(String.class, oldList.length + newList.length);
@@ -139,7 +136,7 @@ public FilterBuilder<FilterWatchListDeletable<T, L>> withoutField(String key, St
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withLabelSelector(LabelSelector selector) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withLabelSelector(LabelSelector selector) {
     Map<String, String> matchLabels = selector.getMatchLabels();
     if (matchLabels != null) {
       withLabels(matchLabels);
@@ -171,7 +168,7 @@ public FilterBuilder<FilterWatchListDeletable<T, L>> withLabelSelector(LabelSele
   }
 
   @Override
-  public FilterBuilder<FilterWatchListDeletable<T, L>> withInvolvedObject(ObjectReference objectReference) {
+  public FilterNested<FilterWatchListDeletable<T, L>> withInvolvedObject(ObjectReference objectReference) {
     if (objectReference.getName() != null) {
       context.fields.put(INVOLVED_OBJECT_NAME, objectReference.getName());
     }
@@ -197,7 +194,7 @@ public FilterBuilder<FilterWatchListDeletable<T, L>> withInvolvedObject(ObjectRe
   }
 
   @Override
-  public FilterWatchListDeletable<T, L> build() {
+  public FilterWatchListDeletable<T, L> and() {
     return this.baseOperation.newInstance(context);
   }
 }