Merge pull request #895 from oracle/sonar

Address CheckStyle and Sonar issues

Author: rjeberhard

docs/domains/Domain.json

@@ -177,7 +177,7 @@
           ]
         },
         "image": {
-          "description": "The Weblogic Docker image; required when domainHomeInImage is true; otherwise, defaults to store/oracle/weblogic:12.2.1.3.",
+          "description": "The WebLogic Docker image; required when domainHomeInImage is true; otherwise, defaults to store/oracle/weblogic:12.2.1.3.",
           "type": "string"
         },
         "imagePullPolicy": {
@@ -239,7 +239,7 @@
           "$ref": "#/definitions/KubernetesResource"
         },
         "domainHome": {
-          "description": "The folder for the Weblogic Domain. Not required. Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false Defaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true",
+          "description": "The folder for the WebLogic Domain. Not required. Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false Defaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true",
           "type": "string"
         },
         "logHomeEnabled": {

docs/domains/Domain.md

@@ -20,10 +20,10 @@ DomainSpec is a description of a domain.
 | clusters | array of [Cluster](#cluster) | Configuration for the clusters. |
 | configOverrides | string | The name of the config map for optional WebLogic configuration overrides. |
 | configOverrideSecrets | array of string | A list of names of the secrets for optional WebLogic configuration overrides. |
-| domainHome | string | The folder for the Weblogic Domain. Not required. Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false Defaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true |
+| domainHome | string | The folder for the WebLogic Domain. Not required. Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false Defaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true |
 | domainHomeInImage | boolean | True if this domain's home is defined in the docker image for the domain. Defaults to true. |
 | domainUID | string | Domain unique identifier. Must be unique across the Kubernetes cluster. Not required. Defaults to the value of metadata.name |
-| image | string | The Weblogic Docker image; required when domainHomeInImage is true; otherwise, defaults to store/oracle/weblogic:12.2.1.3. |
+| image | string | The WebLogic Docker image; required when domainHomeInImage is true; otherwise, defaults to store/oracle/weblogic:12.2.1.3. |
 | imagePullPolicy | string | The image pull policy for the WebLogic Docker image. Legal values are Always, Never and IfNotPresent. Defaults to Always if image ends in :latest, IfNotPresent otherwise. |
 | imagePullSecrets | array of [Local Object Reference](k8s1.9.0.md#local-object-reference) | A list of image pull secrets for the WebLogic Docker image. |
 | includeServerOutInPodLog | boolean | If true (the default), the server .out file will be included in the pod's stdout. |

docs/domains/index.html

@@ -1097,7 +1097,7 @@
           ]
         },
         "image": {
-          "description": "The Weblogic Docker image; required when domainHomeInImage is true; otherwise, defaults to store/oracle/weblogic:12.2.1.3.",
+          "description": "The WebLogic Docker image; required when domainHomeInImage is true; otherwise, defaults to store/oracle/weblogic:12.2.1.3.",
           "type": "string"
         },
         "imagePullPolicy": {
@@ -1159,7 +1159,7 @@
           "$ref": "#/definitions/KubernetesResource"
         },
         "domainHome": {
-          "description": "The folder for the Weblogic Domain. Not required. Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false Defaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true",
+          "description": "The folder for the WebLogic Domain. Not required. Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false Defaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true",
           "type": "string"
         },
         "logHomeEnabled": {

json-schema-maven-plugin/src/main/java/oracle/kubernetes/json/mojo/Main.java

@@ -20,7 +20,7 @@ public interface Main {
   void setKubernetesVersion(String kubernetesVersion) throws IOException;
 
   /**
-   * Defines an external schema URL to be used for object definitions
+   * Defines an external schema URL to be used for object definitions.
    *
    * @param schemaURL the schema URL
    * @param cacheUrl a file url specifying a local cache of the schema
@@ -38,7 +38,7 @@ public interface Main {
 
   /**
    * Specifies that the "additionalProperties" property will be added to the schema for each object
-   * and set to false, to forbid any unspecified properties
+   * and set to false, to forbid any unspecified properties.
    *
    * @param includeAdditionalProperties true if unspecified properties should cause validation to
    *     fail
@@ -55,7 +55,7 @@ public interface Main {
   void setSupportObjectReferences(boolean supportObjectReferences);
 
   /**
-   * Specify the classpath for the class whose schema is to be built
+   * Specify the classpath for the class whose schema is to be built.
    *
    * @param classpathElements a list of elements of a classpath
    */
@@ -82,9 +82,9 @@ Map<String, Object> generateSchema(String className, File outputFile)
   /**
    * Generates markdown for the newly-generated schema to the specified output file.
    *
-   * @param rootName
+   * @param rootName Root name
    * @param outputFile the file to generate
-   * @param schema
+   * @param schema Schema
    * @throws MojoExecutionException if an exception occurred during the markdown generation
    */
   void generateMarkdown(String rootName, File outputFile, Map<String, Object> schema)

json-schema/src/main/java/oracle/kubernetes/json/Description.java

@@ -15,5 +15,11 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target({TYPE, FIELD})
 public @interface Description {
+
+  /**
+   * Description value.
+   *
+   * @return description value
+   */
   String value();
 }

json-schema/src/main/java/oracle/kubernetes/json/EnumClass.java

@@ -14,7 +14,18 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target(FIELD)
 public @interface EnumClass {
+
+  /**
+   * Enum class.
+   *
+   * @return enum class
+   */
   Class<? extends java.lang.Enum> value();
 
+  /**
+   * Enum qualifier.
+   *
+   * @return enum qualifier
+   */
   String qualifier() default "";
 }

json-schema/src/main/java/oracle/kubernetes/json/Pattern.java

@@ -14,5 +14,11 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target(FIELD)
 public @interface Pattern {
+
+  /**
+   * Pattern value.
+   *
+   * @return pattern value
+   */
   String value();
 }

json-schema/src/main/java/oracle/kubernetes/json/Range.java

@@ -14,7 +14,18 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target(FIELD)
 public @interface Range {
+
+  /**
+   * Minimum value.
+   *
+   * @return minimum value
+   */
   int minimum() default Integer.MIN_VALUE;
 
+  /**
+   * Maximum value.
+   *
+   * @return maximum value
+   */
   int maximum() default Integer.MAX_VALUE;
 }

json-schema/src/main/java/oracle/kubernetes/json/SchemaGenerator.java

@@ -60,7 +60,7 @@ public class SchemaGenerator {
   private boolean includeSchemaReference = true;
 
   /**
-   * Returns a pretty-printed string corresponding to a generated schema
+   * Returns a pretty-printed string corresponding to a generated schema.
    *
    * @param schema a schema generated by a call to #generate
    * @return a string version of the schema
@@ -83,6 +83,13 @@ public void useKubernetesVersion(String version) throws IOException {
     addExternalSchema(reference.getKubernetesSchemaUrl(), cacheUrl);
   }
 
+  /**
+   * Adds external schema.
+   *
+   * @param schemaUrl Schema URL
+   * @param cacheUrl Cached URL
+   * @throws IOException IO exception
+   */
   public void addExternalSchema(URL schemaUrl, URL cacheUrl) throws IOException {
     Map<String, Map<String, Object>> objectObjectMap = loadCachedSchema(cacheUrl);
     Map<String, Object> definitions = objectObjectMap.get("definitions");
@@ -118,7 +125,7 @@ private boolean isDeprecated(Object description) {
   }
 
   /**
-   * Specifies whether deprecated fields should be included in the schema
+   * Specifies whether deprecated fields should be included in the schema.
    *
    * @param includeDeprecated true to include deprecated fields. Defaults to false.
    */
@@ -128,7 +135,7 @@ public void setIncludeDeprecated(boolean includeDeprecated) {
 
   /**
    * Specifies whether the "additionalProperties" property will be specified to forbid properties
-   * not in the schema
+   * not in the schema.
    *
    * @param includeAdditionalProperties true to forbid unknown properties
    */
@@ -147,7 +154,7 @@ public void setSupportObjectReferences(boolean supportObjectReferences) {
   }
 
   /**
-   * Specifies whether top-level schema reference is included
+   * Specifies whether top-level schema reference is included.
    *
    * @param includeSchemaReference true to include schema reference
    */
@@ -158,16 +165,16 @@ public void setIncludeSchemaReference(boolean includeSchemaReference) {
   /**
    * Generates an object representing a JSON schema for the specified class.
    *
-   * @param aClass the class for which the schema should be generated
+   * @param someClass the class for which the schema should be generated
    * @return a map of maps, representing the computed JSON
    */
-  public Map<String, Object> generate(Class aClass) {
+  public Map<String, Object> generate(Class someClass) {
     Map<String, Object> result = new HashMap<>();
 
     if (includeSchemaReference) {
       result.put("$schema", JSON_SCHEMA_REFERENCE);
     }
-    generateObjectTypeIn(result, aClass);
+    generateObjectTypeIn(result, someClass);
     if (!definedObjects.isEmpty()) {
       Map<String, Object> definitions = new TreeMap<>();
       result.put("definitions", definitions);
@@ -239,6 +246,11 @@ private String getDescription(Field field) {
     return description != null ? description.value() : null;
   }
 
+  private String getDescription(Class<?> someClass) {
+    Description description = someClass.getAnnotation(Description.class);
+    return description != null ? description.value() : null;
+  }
+
   private void addStringRestrictions(Map<String, Object> result, Field field) {
     Class<? extends Enum> enumClass = getEnumClass(field);
     if (enumClass != null) addEnumValues(result, enumClass, getEnumQualifier(field));
@@ -426,11 +438,6 @@ private void generateObjectTypeIn(Map<String, Object> result, Class<?> type) {
     }
   }
 
-  private String getDescription(Class<?> aClass) {
-    Description description = aClass.getAnnotation(Description.class);
-    return description != null ? description.value() : null;
-  }
-
   private Collection<Field> getPropertyFields(Class<?> type) {
     Set<Field> result = new HashSet<>();
     for (Class<?> cl = type; cl != null && !cl.equals(Object.class); cl = cl.getSuperclass())

json-schema/src/main/java/oracle/kubernetes/json/YamlDocGenerator.java

@@ -30,10 +30,23 @@ public YamlDocGenerator(Map<String, Object> schema) {
     this.schema = schema;
   }
 
+  /**
+   * Generate YAML documentation.
+   *
+   * @param schemaName Schema name
+   * @return documentation
+   */
   public String generate(String schemaName) {
     return generate(schemaName, schema);
   }
 
+  /**
+   * Generate YAML documentation.
+   *
+   * @param reference Reference
+   * @param schema Schema
+   * @return documentation
+   */
   public String generate(String reference, Map<String, Object> schema) {
     referencesNeeded.remove(reference);
     StringBuilder sb = new StringBuilder("### ");
@@ -50,6 +63,13 @@ private String getDescription(Map<String, Object> schema) {
     return (String) schema.get("description");
   }
 
+  private String getDescription(String fieldName, Map<String, Object> subSchema) {
+    if (subSchema == null) return "";
+    Map<String, Object> fieldMap = subMap(subSchema, fieldName);
+    String rawDescription = (String) fieldMap.get("description");
+    return rawDescription == null ? "" : rawDescription.replace("\n", "<br/>");
+  }
+
   private void generateForDefinition(StringBuilder sb, String reference) {
     Map<String, Object> definitions = subMap(schema, "definitions");
     Map<String, Object> definition = subMap(definitions, reference);
@@ -99,13 +119,12 @@ private String getType(String fieldName, Map<String, Object> subSchema) {
     return type.getString();
   }
 
-  private String getDescription(String fieldName, Map<String, Object> subSchema) {
-    if (subSchema == null) return "";
-    Map<String, Object> fieldMap = subMap(subSchema, fieldName);
-    String rawDescription = (String) fieldMap.get("description");
-    return rawDescription == null ? "" : rawDescription.replace("\n", "<br/>");
-  }
-
+  /**
+   * Assigns kubernetes version to use.
+   *
+   * @param k8sVersion Kubernetes version
+   * @throws IOException IO exception
+   */
   public void useKubernetesVersion(String k8sVersion) throws IOException {
     kubernetesReference = KubernetesSchemaReference.create(k8sVersion);
     URL cacheUrl = kubernetesReference.getKubernetesSchemaCacheUrl();
@@ -273,7 +292,7 @@ private Map<String, Object> subMap(Map<String, Object> schemaMap, String name) {
     return (Map<String, Object>) Optional.ofNullable(schemaMap.get(name)).orElse(new HashMap<>());
   }
 
-  private String emptyIfNull(String aString) {
-    return aString == null ? "" : aString;
+  private String emptyIfNull(String someString) {
+    return someString == null ? "" : someString;
   }
 }