Update declaration to return Optional

It was declared as returning T, but javadocced and implemented returning
Optional<T>

Signed-off-by: Robert Young <[email protected]>

Author: robobario

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/DefaultManagedDependentResourceContext.java

@@ -21,11 +21,11 @@ public <T> Optional<T> get(Object key, Class<T> expectedType) {
 
   @Override
   @SuppressWarnings("unchecked")
-  public <T> T put(Object key, T value) {
+  public <T> Optional<T> put(Object key, T value) {
     if (value == null) {
-      return (T) Optional.ofNullable(attributes.remove(key));
+      return (Optional<T>) Optional.ofNullable(attributes.remove(key));
     }
-    return (T) Optional.ofNullable(attributes.put(key, value));
+    return (Optional<T>) Optional.ofNullable(attributes.put(key, value));
   }
 
   @Override

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/ManagedDependentResourceContext.java

@@ -38,7 +38,7 @@ public interface ManagedDependentResourceContext {
    *         {@link Optional#empty()} if none existed
    */
   @SuppressWarnings("unchecked")
-  <T> T put(Object key, T value);
+  <T> Optional<T> put(Object key, T value);
 
   /**
    * Retrieves the value associated with the key or fail with an exception if none exists.

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/DefaultManagedDependentResourceContextTest.java

@@ -1,84 +1,95 @@
 package io.javaoperatorsdk.operator.api.reconciler.dependent.managed;
 
-import io.javaoperatorsdk.operator.processing.dependent.workflow.WorkflowReconcileResult;
-import org.junit.jupiter.api.Test;
-
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 
+import org.junit.jupiter.api.Test;
+
+import io.javaoperatorsdk.operator.processing.dependent.workflow.WorkflowReconcileResult;
+
 import static io.javaoperatorsdk.operator.api.reconciler.dependent.managed.DefaultManagedDependentResourceContext.RECONCILE_RESULT_KEY;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
 class DefaultManagedDependentResourceContextTest {
 
-    private ManagedDependentResourceContext context = new DefaultManagedDependentResourceContext();
-
-    @Test
-    void getWhenEmpty() {
-        Optional<String> actual = context.get("key", String.class);
-        assertThat(actual).isEmpty();
-    }
-
-    @Test
-    void get() {
-        context.put("key", "value");
-        Optional<String> actual = context.get("key", String.class);
-        assertThat(actual).contains("value");
-    }
-
-    @Test
-    void putNewValueOverwrites() {
-        context.put("key", "value");
-        context.put("key", "valueB");
-        Optional<String> actual = context.get("key", String.class);
-        assertThat(actual).contains("valueB");
-    }
-
-    @Test
-    void putNewValueReturnsPriorValue() {
-        context.put("key", "value");
-        Optional<String> actual = (Optional<String>) (Object)context.put("key", "valueB");
-        assertThat(actual).contains("value");
-    }
-
-    @Test
-    void putNullRemoves() {
-        context.put("key", "value");
-        context.put("key", null);
-        Optional<String> actual = context.get("key", String.class);
-        assertThat(actual).isEmpty();
-    }
-    
-    @Test
-    void putNullReturnsPriorValue() {
-        context.put("key", "value");
-        Optional<String> actual = context.put("key", null);
-        assertThat(actual).contains("value");
-    }
-
-    @Test
-    void getMandatory() {
-        context.put("key", "value");
-        String actual = context.getMandatory("key", String.class);
-        assertThat(actual).isEqualTo("value");
-    }
-
-    @Test
-    void getMandatoryWhenEmpty() {
-        assertThatThrownBy(() -> {
-            context.getMandatory("key", String.class);
-        }).isInstanceOf(IllegalStateException.class)
-                .hasMessage("Mandatory attribute (key: key, type: java.lang.String) is missing or not of the expected type");
-    }
-
-    @Test
-    void getWorkflowReconcileResult() {
-        WorkflowReconcileResult result = new WorkflowReconcileResult(List.of(), List.of(), Map.of(), Map.of());
-        context.put(RECONCILE_RESULT_KEY, result);
-        Optional<WorkflowReconcileResult> actual = context.getWorkflowReconcileResult();
-        assertThat(actual).containsSame(result);
-    }
-
-}
+  private ManagedDependentResourceContext context = new DefaultManagedDependentResourceContext();
+
+  @Test
+  void getWhenEmpty() {
+    Optional<String> actual = context.get("key", String.class);
+    assertThat(actual).isEmpty();
+  }
+
+  @Test
+  void get() {
+    context.put("key", "value");
+    Optional<String> actual = context.get("key", String.class);
+    assertThat(actual).contains("value");
+  }
+
+  // a bit scary that it could mask a typing issue by returning empty
+  @Test
+  void getTypeMismatch() {
+    context.put("key", 1L);
+    Optional<String> actual = context.get("key", String.class);
+    assertThat(actual).isEmpty();
+  }
+
+  @Test
+  void putNewValueOverwrites() {
+    context.put("key", "value");
+    context.put("key", "valueB");
+    Optional<String> actual = context.get("key", String.class);
+    assertThat(actual).contains("valueB");
+  }
+
+  @Test
+  void putNewValueReturnsPriorValue() {
+    context.put("key", "value");
+    Optional<String> actual = context.put("key", "valueB");
+    assertThat(actual).contains("value");
+  }
+
+  @Test
+  void putNullRemoves() {
+    context.put("key", "value");
+    context.put("key", null);
+    Optional<String> actual = context.get("key", String.class);
+    assertThat(actual).isEmpty();
+  }
+
+  @Test
+  void putNullReturnsPriorValue() {
+    context.put("key", "value");
+    Optional<String> actual = context.put("key", null);
+    assertThat(actual).contains("value");
+  }
+
+  @Test
+  void getMandatory() {
+    context.put("key", "value");
+    String actual = context.getMandatory("key", String.class);
+    assertThat(actual).isEqualTo("value");
+  }
+
+  @Test
+  void getMandatoryWhenEmpty() {
+    assertThatThrownBy(() -> {
+      context.getMandatory("key", String.class);
+    }).isInstanceOf(IllegalStateException.class)
+        .hasMessage(
+            "Mandatory attribute (key: key, type: java.lang.String) is missing or not of the expected type");
+  }
+
+  @Test
+  void getWorkflowReconcileResult() {
+    WorkflowReconcileResult result =
+        new WorkflowReconcileResult(List.of(), List.of(), Map.of(), Map.of());
+    context.put(RECONCILE_RESULT_KEY, result);
+    Optional<WorkflowReconcileResult> actual = context.getWorkflowReconcileResult();
+    assertThat(actual).containsSame(result);
+  }
+
+}