Address review comments

Author: russgold

operator/src/main/java/oracle/kubernetes/operator/DomainProcessor.java

@@ -1,4 +1,4 @@
-// Copyright 2018, Oracle Corporation and/or its affiliates.  All rights reserved.
+// Copyright 2018, 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
 // Licensed under the Universal Permissive License v 1.0 as shown at
 // http://oss.oracle.com/licenses/upl.
 

operator/src/main/java/oracle/kubernetes/operator/DomainProcessorDelegate.java

@@ -10,19 +10,61 @@
 import oracle.kubernetes.operator.work.FiberGate;
 import oracle.kubernetes.operator.work.Step;
 
+/** A set of underlying services required during domain processing. */
 public interface DomainProcessorDelegate {
+  /**
+   * Returns the namespace associated with the operator itself.
+   *
+   * @return a namespace string
+   */
   String getOperatorNamespace();
 
+  /**
+   * Returns a factory that creates a step to wait for a pod in the specified namespace to be ready.
+   *
+   * @param namespace the namespace for the pod
+   * @return a step-creating factory
+   */
   PodAwaiterStepFactory getPodAwaiterStepFactory(String namespace);
 
+  /**
+   * Returns true if the namespace is running.
+   *
+   * @param namespace the namespace to check
+   * @return the 'running' state of the namespace
+   */
   boolean isNamespaceRunning(String namespace);
 
+  /**
+   * Returns the version of the Kubernetes environment in which the operator is running
+   *
+   * @return an object that represents the Kubernetes version
+   */
   KubernetesVersion getVersion();
 
+  /**
+   * Creates a new FiberGate.
+   *
+   * @return the created instance
+   */
   FiberGate createFiberGate();
 
+  /**
+   * Runs a chain of steps
+   *
+   * @param firstStep the first step to run
+   */
   void runSteps(Step firstStep);
 
+  /**
+   * Schedules the specified command to run periodically.
+   *
+   * @param command the command to run
+   * @param initialDelay the number of time units to wait before running the command the first time
+   * @param delay the number of time units to delay between successive runs
+   * @param unit the time unit for the above delays
+   * @return a future which indicates completion of the command
+   */
   ScheduledFuture<?> scheduleWithFixedDelay(
       Runnable command, long initialDelay, long delay, TimeUnit unit);
 }

operator/src/main/java/oracle/kubernetes/operator/DomainProcessorImpl.java

@@ -141,11 +141,10 @@ public void dispatchPodWatch(Watch.Response<V1Pod> item) {
       String domainUID = metadata.getLabels().get(LabelConstants.DOMAINUID_LABEL);
       String serverName = metadata.getLabels().get(LabelConstants.SERVERNAME_LABEL);
       if (domainUID != null && serverName != null) {
-        DomainPresenceInfo existing =
-            getExistingDomainPresenceInfo(metadata.getNamespace(), domainUID);
-        if (existing != null) {
+        DomainPresenceInfo info = getExistingDomainPresenceInfo(metadata.getNamespace(), domainUID);
+        if (info != null) {
           ServerKubernetesObjects sko =
-              existing.getServers().computeIfAbsent(serverName, k -> new ServerKubernetesObjects());
+              info.getServers().computeIfAbsent(serverName, k -> new ServerKubernetesObjects());
           switch (item.type) {
             case "ADDED":
               sko.getPod()
@@ -194,11 +193,11 @@ public void dispatchPodWatch(Watch.Response<V1Pod> item) {
                             }
                             return current;
                           });
-              if (oldPod != null && !existing.isDeleting()) {
+              if (oldPod != null && info.isNotDeleting()) {
                 // Pod was deleted, but sko still contained a non-null entry
                 LOGGER.info(
                     MessageKeys.POD_DELETED, domainUID, metadata.getNamespace(), serverName);
-                makeRightDomainPresence(existing, true, false, true);
+                makeRightDomainPresence(info, true, false, true);
               }
               break;
 
@@ -215,19 +214,18 @@ public void dispatchServiceWatch(Watch.Response<V1Service> item) {
     String domainUID = ServiceHelper.getServiceDomainUID(service);
     if (domainUID == null) return;
 
-    DomainPresenceInfo domainPresenceInfo =
+    DomainPresenceInfo info =
         getExistingDomainPresenceInfo(service.getMetadata().getNamespace(), domainUID);
-    if (domainPresenceInfo == null) return;
+    if (info == null) return;
 
     switch (item.type) {
       case "ADDED":
       case "MODIFIED":
-        ServiceHelper.updatePresenceFromEvent(domainPresenceInfo, item.object);
+        ServiceHelper.updatePresenceFromEvent(info, item.object);
         break;
       case "DELETED":
-        boolean removed = ServiceHelper.deleteFromEvent(domainPresenceInfo, item.object);
-        if (removed && !domainPresenceInfo.isDeleting())
-          makeRightDomainPresence(domainPresenceInfo, true, false, true);
+        boolean removed = ServiceHelper.deleteFromEvent(info, item.object);
+        if (removed && info.isNotDeleting()) makeRightDomainPresence(info, true, false, true);
         break;
       default:
     }
@@ -483,7 +481,7 @@ private class StartPlanStep extends Step {
     public NextAction apply(Packet packet) {
       registerDomainPresenceInfo(info);
       Step strategy = getNext();
-      if (!info.isPopulated() && !info.isDeleting()) {
+      if (!info.isPopulated() && info.isNotDeleting()) {
         strategy = Step.chain(readExistingPods(info), readExistingServices(info), strategy);
       }
       return doNext(strategy, packet);

operator/src/main/java/oracle/kubernetes/operator/JobWatcher.java

@@ -1,4 +1,4 @@
-// Copyright 2018, Oracle Corporation and/or its affiliates.  All rights reserved.
+// Copyright 2018, 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
 // Licensed under the Universal Permissive License v 1.0 as shown at
 // http://oss.oracle.com/licenses/upl.
 
@@ -18,6 +18,7 @@
 import java.util.concurrent.ThreadFactory;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.function.Function;
+import javax.annotation.Nonnull;
 import oracle.kubernetes.operator.TuningParameters.WatchTuning;
 import oracle.kubernetes.operator.builders.WatchBuilder;
 import oracle.kubernetes.operator.builders.WatchI;
@@ -45,16 +46,16 @@ public class JobWatcher extends Watcher<V1Job> implements WatchListener<V1Job> {
       new ConcurrentHashMap<>();
 
   /**
-   * If a JobWatcher has already been created, returns it.
+   * Returns a cached JobWatcher, if present; otherwise, creates a new one.
    *
    * @param domain the domain for which the job watcher is to be returned
-   * @return a cached jobwatcher, or null.
+   * @return a cached jobwatcher.
    */
-  public static JobWatcher getOrCreateFor(Domain domain) {
+  public static @Nonnull JobWatcher getOrCreateFor(Domain domain) {
     return JOB_WATCHERS.computeIfAbsent(getNamespace(domain), n -> factory.createFor(domain));
   }
 
-  static String getNamespace(Domain domain) {
+  private static String getNamespace(Domain domain) {
     return domain.getMetadata().getNamespace();
   }
 

operator/src/main/java/oracle/kubernetes/operator/helpers/DomainPresenceInfo.java

@@ -174,8 +174,8 @@ boolean deleteExternalServiceFromEvent(String serverName, V1Service event) {
     return deletedService != null;
   }
 
-  public boolean isDeleting() {
-    return isDeleting.get();
+  public boolean isNotDeleting() {
+    return !isDeleting.get();
   }
 
   public void setDeleting(boolean deleting) {