refactor: deprecate ManagedDependentResourceContext#put

The javadoc declares it returns Optional and the implementation returns
Optional, but the method declares it returns T. put is replaced by
putOrRemove with a consistent signature.

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

Author: robobario

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

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

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

@@ -36,8 +36,10 @@ public interface ManagedDependentResourceContext {
    *        associated with the specified key
    * @return an Optional containing the previous value associated with the key or
    *         {@link Optional#empty()} if none existed
+   * @deprecated use {@link #putOrRemove(Object, Object)} instead
    */
   @SuppressWarnings("unchecked")
+  @Deprecated(forRemoval = true)
   <T> T put(Object key, T value);
 
   /**
@@ -52,7 +54,6 @@ public interface ManagedDependentResourceContext {
    * @return an Optional containing the previous value associated with the key or
    *         {@link Optional#empty()} if none existed
    */
-  @SuppressWarnings("unchecked")
   <T> Optional<T> putOrRemove(Object key, T value);
 
   /**

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/DefaultWorkflow.java

@@ -93,7 +93,7 @@ public WorkflowReconcileResult reconcile(P primary, Context<P> context) {
         new WorkflowReconcileExecutor<>(this, primary, context);
     var result = workflowReconcileExecutor.reconcile();
     context.managedDependentResourceContext()
-        .put(DefaultManagedDependentResourceContext.RECONCILE_RESULT_KEY, result);
+        .putOrRemove(DefaultManagedDependentResourceContext.RECONCILE_RESULT_KEY, result);
     if (throwExceptionAutomatically) {
       result.throwAggregateExceptionIfErrorsPresent();
     }
@@ -106,7 +106,7 @@ public WorkflowCleanupResult cleanup(P primary, Context<P> context) {
         new WorkflowCleanupExecutor<>(this, primary, context);
     var result = workflowCleanupExecutor.cleanup();
     context.managedDependentResourceContext()
-        .put(DefaultManagedDependentResourceContext.CLEANUP_RESULT_KEY, result);
+        .putOrRemove(DefaultManagedDependentResourceContext.CLEANUP_RESULT_KEY, result);
     if (throwExceptionAutomatically) {
       result.throwAggregateExceptionIfErrorsPresent();
     }