Enforce checkstyle format (#37)

Author: ddsharpe

build-tools/src/main/resources/weblogic-image-tool/checkstyle/customized_google_checks.xml

@@ -27,6 +27,11 @@
         <property name="eachLine" value="true"/>
     </module>
 
+    <module name="RegexpHeader">
+        <property name="headerFile" value="build-tools/src/main/resources/weblogic-image-tool/checkstyle/java.header"/>
+        <property name="fileExtensions" value="java"/>
+    </module>
+
     <module name="TreeWalker">
         <module name="OuterTypeFilename"/>
         <module name="IllegalTokenText">
@@ -193,7 +198,7 @@
         <module name="CustomImportOrder">
             <property name="sortImportsInGroupAlphabetically" value="true"/>
             <property name="separateLineBetweenGroups" value="true"/>
-            <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
+            <property name="customImportOrderRules" value="STANDARD_JAVA_PACKAGE###THIRD_PARTY_PACKAGE###STATIC"/>
         </module>
         <module name="MethodParamPad"/>
         <module name="NoWhitespaceBefore">

build-tools/src/main/resources/weblogic-image-tool/checkstyle/java.header

@@ -0,0 +1,2 @@
+^// Copyright (\d\d\d\d, )+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\.$

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/FileResolver.java

@@ -1,7 +1,5 @@
-/* Copyright (c) 2019 Oracle 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. 
-*/
+// Copyright 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.
 
 package com.oracle.weblogic.imagetool.api;
 

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/meta/CacheStore.java

@@ -1,7 +1,5 @@
-/* Copyright (c) 2019 Oracle 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. 
-*/
+// Copyright 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.
 
 package com.oracle.weblogic.imagetool.api.meta;
 
@@ -52,15 +50,15 @@ public interface CacheStore {
     boolean addToCache(String key, String value);
 
     /**
-     * Delete an entry from the cache
+     * Delete an entry from the cache.
      *
      * @param key key corresponding to an entry in the cache
      * @return value or null
      */
     String deleteFromCache(String key);
 
     /**
-     * Returns a map of current items in the cache
+     * Returns a map of current items in the cache.
      *
      * @return map of current items
      */

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/AbstractFile.java

@@ -1,27 +1,37 @@
-/* Copyright (c) 2019 Oracle 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. 
-*/
-package com.oracle.weblogic.imagetool.api.model;
+// Copyright 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.
 
-import com.oracle.weblogic.imagetool.api.FileResolver;
-import com.oracle.weblogic.imagetool.api.meta.CacheStore;
+package com.oracle.weblogic.imagetool.api.model;
 
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.util.logging.Logger;
 
+import com.oracle.weblogic.imagetool.api.FileResolver;
+import com.oracle.weblogic.imagetool.api.meta.CacheStore;
+
 /**
- * Base class to represent either an installer or a patch file
+ * Base class to represent either an installer or a patch file.
  */
 public abstract class AbstractFile implements FileResolver {
 
+    private static final Logger logger = Logger.getLogger(AbstractFile.class.getName());
+
     private String key;
     protected CachePolicy cachePolicy;
     protected String userId;
     protected String password;
-    private final static Logger logger = Logger.getLogger(AbstractFile.class.getName());
 
+
+    /**
+     * Construct a new abstract file.
+     *
+     * @param id          cache ID
+     * @param version     applicable product version.
+     * @param cachePolicy applicable cache policy.
+     * @param userId      userid to use for ARU.
+     * @param password    password to use for ARU.
+     */
     public AbstractFile(String id, String version, CachePolicy cachePolicy, String userId, String password) {
         this.key = generateKey(id, version);
         this.cachePolicy = cachePolicy;
@@ -38,11 +48,11 @@ public String generateKey(String id, String version) {
         //
         String mykey = id;
         if (id == null) {  // should never happens
-            mykey =  id + CacheStore.CACHE_KEY_SEPARATOR + version;
+            mykey = id + CacheStore.CACHE_KEY_SEPARATOR + version;
         } else if (id.indexOf('_') < 0) {
-                if (version != null) {
-                    mykey = mykey + CacheStore.CACHE_KEY_SEPARATOR + version;
-                }
+            if (version != null) {
+                mykey = mykey + CacheStore.CACHE_KEY_SEPARATOR + version;
+            }
         }
 
         logger.finest("AbstractFile generating key returns " + mykey);

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachePolicy.java

@@ -1,21 +1,20 @@
-/* Copyright (c) 2019 Oracle 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. 
-*/
+// Copyright 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.
 
 package com.oracle.weblogic.imagetool.api.model;
 
 /**
- * @Deprecated
- *   This is subject to removal and there is no need to use it
- *   The logic is changed to use the presence of userId and password to
- *   determine whether to access online if the item is not in the cache.
- *   It allows the cache is just a store and nothing more
- *
- * first - Use cache entries and download artifacts if required
+ * Cache policy types.
+ * <p/>
  * always - Use only cache entries and never download artifacts
- * never - Ignore cache entries and always download artifacts
+ *
+ * @deprecated
+ *   This is subject to removal and there is no need to use it
+ *     The logic is changed to use the presence of userId and password to
+ *     determine whether to access online if the item is not in the cache.
+ *     It allows the cache is just a store and nothing more
  */
+@Deprecated
 public enum CachePolicy {
     ALWAYS("always");
 

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CommandResponse.java

@@ -1,7 +1,5 @@
-/* Copyright (c) 2019 Oracle 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. 
-*/
+// Copyright 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.
 
 package com.oracle.weblogic.imagetool.api.model;
 
@@ -10,46 +8,62 @@ public class CommandResponse {
     private int status;
     private String message;
     private Object result;
-    private boolean success = true;
 
+    /**
+     * For use with PicoCLI to return the response to the command line.
+     * @param status CLI status, 0 if normal.
+     * @param message message to the user.
+     */
     public CommandResponse(int status, String message) {
         this.status = status;
         this.message = message;
-
-        if (status != 0) {
-            this.success = false;
-        }
     }
 
+    /**
+     * For use with PicoCLI to return the response to the command line.
+     * @param status CLI status, 0 if normal.
+     * @param message message to the user.
+     * @param result more details that help the user understand the message.
+     */
     public CommandResponse(int status, String message, Object result) {
         this.status = status;
         this.message = message;
         this.result = result;
-
-        if (status != 0) {
-            this.success = false;
-        }
     }
 
+    /**
+     * Get the status code in this response.
+     * @return the status
+     */
     public int getStatus() {
         return status;
     }
 
+    /**
+     * Get the message in this response.
+     * @return message to the user
+     */
     public String getMessage() {
         return message;
     }
 
+
+    /**
+     * Get the result in this response.
+      * @param <T> result type.
+     * @return the result object.
+     */
     @SuppressWarnings("unchecked")
     public <T> T getResult() {
         return (T) result;
     }
 
+    /**
+     * True if the status was 0.
+     * @return true if the status was 0.
+     */
     public boolean isSuccess() {
-        return success;
-    }
-
-    public void setSuccess(boolean success) {
-        this.success = success;
+        return status == 0;
     }
 
 }

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/DomainType.java

@@ -1,7 +1,5 @@
-/* Copyright (c) 2019 Oracle 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. 
-*/
+// Copyright 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.
 
 package com.oracle.weblogic.imagetool.api.model;
 
@@ -19,6 +17,11 @@ public enum DomainType {
         this.value = value;
     }
 
+    /**
+     * Create the Domain type Enum from the String value.
+     * @param value the domain type string, ignoring case.
+     * @return the enum domain type.
+     */
     public static DomainType fromValue(String value) {
         for (DomainType eachType : DomainType.values()) {
             if (eachType.value.equalsIgnoreCase(value)) {

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/InstallerType.java

@@ -1,17 +1,15 @@
-/* Copyright (c) 2019 Oracle 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. 
-*/
+// Copyright 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.
 
 package com.oracle.weblogic.imagetool.api.model;
 
-import com.oracle.weblogic.imagetool.util.Constants;
-
 import java.util.ArrayList;
 import java.util.List;
 
+import com.oracle.weblogic.imagetool.util.Constants;
+
 /**
- * An enum to represent type of installer
+ * An enum to represent installer type.
  */
 public enum InstallerType {
 
@@ -31,6 +29,11 @@ public String toString() {
         return value;
     }
 
+    /**
+     * Get the Dockerfile build argument for this installer type.
+     * @param location the location of the installer.
+     * @return --build-arg and this installer type argument and location.
+     */
     public List<String> getBuildArg(String location) {
         List<String> retVal = new ArrayList<>(2);
         retVal.add(Constants.BUILD_ARG);
@@ -44,6 +47,11 @@ public List<String> getBuildArg(String location) {
         return retVal;
     }
 
+    /**
+     * Create the installer type Enum from the String value.
+     * @param value the installer type string, ignoring case.
+     * @return the enum installer type.
+     */
     public static InstallerType fromValue(String value) {
         for (InstallerType eachType : InstallerType.values()) {
             if (eachType.value.equalsIgnoreCase(value)) {

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/WLSInstallerType.java

@@ -1,7 +1,5 @@
-/* Copyright (c) 2019 Oracle 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. 
-*/
+// Copyright 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.
 
 package com.oracle.weblogic.imagetool.api.model;
 
@@ -23,6 +21,11 @@ public String toString() {
         return value;
     }
 
+    /**
+     * Create the WLS installer type Enum from the String value.
+     * @param value the installer type string, ignoring case.
+     * @return the enum installer type.
+     */
     public static WLSInstallerType fromValue(String value) {
         for (WLSInstallerType eachType : WLSInstallerType.values()) {
             if (eachType.value.equalsIgnoreCase(value)) {