[refactor] reorder and format FunctionSignature

Author: line-o

exist-core/src/main/java/org/exist/xquery/FunctionSignature.java

@@ -24,6 +24,7 @@
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
+
 import org.exist.Namespaces;
 import org.exist.dom.QName;
 import org.exist.xquery.value.FunctionParameterSequenceType;
@@ -33,7 +34,7 @@
 /**
  * Describes the signature of a built-in or user-defined function, i.e.
  * its name, the type and cardinality of its arguments and its return type.
- *  
+ *
  * @author wolf
  * @author lcahlander
  * @version 1.3
@@ -43,25 +44,20 @@ public class FunctionSignature {
     /**
      * Default sequence type for function parameters.
      */
-    public final static SequenceType DEFAULT_TYPE = new SequenceType(Type.ITEM, Cardinality.ZERO_OR_MORE);
+    public static final SequenceType DEFAULT_TYPE = new SequenceType(Type.ITEM, Cardinality.ZERO_OR_MORE);
 
     /**
      * Empty array to specify if a function doesn't take any arguments.
      */
-    public final static SequenceType[] NO_ARGS = new SequenceType[0];
+    public static final SequenceType[] NO_ARGS = new SequenceType[0];
 
     private static final String DEPRECATION_REMOVAL_MESSAGE = "\nThis function could be removed in the next major release version.";
-
-    public static SequenceType[] singleArgument(final SequenceType arg) {
-        return new SequenceType[] { arg };
-    }
-	
-    private Annotation[] annotations;
     private final QName name;
+    private Annotation[] annotations;
     private SequenceType[] arguments;
     private SequenceType returnType;
-    private boolean isOverloaded = false;
-    private String description = null;
+    private boolean isVariadic;
+    private String description;
     private String deprecated = null;
     private Map<String, String> metadata = null;
 
@@ -70,7 +66,7 @@ public FunctionSignature(final FunctionSignature other) {
         this.arguments = other.arguments != null ? Arrays.copyOf(other.arguments, other.arguments.length) : null;
         this.returnType = other.returnType;
         this.annotations = other.annotations != null ? Arrays.copyOf(other.annotations, other.annotations.length) : null;
-        this.isOverloaded = other.isOverloaded;
+        this.isVariadic = other.isVariadic;
         this.deprecated = other.deprecated;
         this.description = other.description;
         this.metadata = other.metadata != null ? new HashMap<>(other.metadata) : null;
@@ -89,17 +85,13 @@ public FunctionSignature(final QName name, final SequenceType[] arguments, final
     }
 
     public FunctionSignature(final QName name, final String description, final SequenceType[] arguments, final SequenceType returnType) {
-        this(name, description, arguments, returnType, false);	
+        this(name, description, arguments, returnType, false);
     }
 
     public FunctionSignature(final QName name, final String description, final SequenceType[] arguments, final SequenceType returnType, final String deprecated) {
         this(name, description, arguments, returnType, false);
         setDeprecated(deprecated);
     }
-        
-//    public FunctionSignature(final QName name, final String description, final SequenceType[] arguments, final SequenceType returnType, final FunctionSignature deprecatedBy) {
-//        this(name, description, arguments, returnType, false, "Moved to the module: " + deprecatedBy.getName().getNamespaceURI() + ", you should now use '" + deprecatedBy.getName().getPrefix() + ":" + deprecatedBy.getName().getLocalPart() + "' instead!");
-//    }
 
     public FunctionSignature(final QName name, final String description, final SequenceType[] arguments, final SequenceType returnType, final boolean overloaded, final String deprecated) {
         this(name, description, arguments, returnType, overloaded);
@@ -108,40 +100,44 @@ public FunctionSignature(final QName name, final String description, final Seque
 
     /**
      * Create a new function signature.
-     * 
-     * @param name the QName of the function.
+     *
+     * @param name        the QName of the function.
      * @param description documentation string describing the function
-     * @param arguments the sequence types of all expected arguments
-     * @param returnType the sequence type returned by the function
-     * @param overloaded set to true if the function may expect additional parameters
-     */		
+     * @param arguments   the sequence types of all expected arguments
+     * @param returnType  the sequence type returned by the function
+     * @param overloaded  set to true if the function may expect additional parameters
+     */
     public FunctionSignature(final QName name, final String description, final SequenceType[] arguments, final SequenceType returnType, final boolean overloaded) {
         this.name = name;
         this.arguments = arguments;
         this.returnType = returnType;
-        this.isOverloaded = overloaded;
+        this.isVariadic = overloaded;
         this.description = description;
     }
 
     public Annotation[] getAnnotations() {
         return annotations;
     }
-        
+
+    public void setAnnotations(final Annotation[] annotations) {
+        this.annotations = annotations;
+    }
+
     public QName getName() {
         return name;
     }
 
     public int getArgumentCount() {
-        if(isOverloaded) {
+        if (isVariadic) {
             return -1;
         }
         return arguments != null ? arguments.length : 0;
     }
-	
+
     public FunctionId getFunctionId() {
         return new FunctionId(name, getArgumentCount());
     }
-	
+
     public SequenceType getReturnType() {
         return returnType;
     }
@@ -157,21 +153,17 @@ public SequenceType[] getArgumentTypes() {
     public void setArgumentTypes(final SequenceType[] types) {
         this.arguments = types;
     }
-        
-    public void setAnnotations(final Annotation[] annotations) {
-        this.annotations = annotations;
-    }
-	
+
     public String getDescription() {
-            return description;
+        return description;
     }
 
     public void setDescription(final String description) {
         this.description = description;
     }
 
     public void addMetadata(final String key, final String value) {
-        if(metadata == null) {
+        if (metadata == null) {
             metadata = new HashMap<>(5);
         }
         final String old = metadata.get(key);
@@ -192,7 +184,7 @@ public Map<String, String> getMetadata() {
     }
 
     public boolean isOverloaded() {
-        return isOverloaded;
+        return isVariadic;
     }
 
     public boolean isDeprecated() {
@@ -206,17 +198,17 @@ public String getDeprecated() {
             return null;
         }
     }
-	
+
     public final void setDeprecated(final String message) {
         deprecated = message;
     }
 
     public boolean isPrivate() {
         final Annotation[] annotations = getAnnotations();
-        if(annotations != null) {
-            for(final Annotation annot : annotations) {
+        if (annotations != null) {
+            for (final Annotation annot : annotations) {
                 final QName qn = annot.getName();
-                if(qn.getNamespaceURI().equals(Namespaces.XPATH_FUNCTIONS_NS) && "private".equals(qn.getLocalPart())) {
+                if (qn.getNamespaceURI().equals(Namespaces.XPATH_FUNCTIONS_NS) && "private".equals(qn.getLocalPart())) {
                     return true;
                 }
             }
@@ -229,29 +221,29 @@ public String toString() {
         final StringBuilder buf = new StringBuilder();
         buf.append(name.getStringValue());
         buf.append('(');
-        if(arguments != null) {
+        if (arguments != null) {
             final char ANON_VAR = 'a';
-            for(int i = 0; i < arguments.length; i++) {
-                if(i > 0) {
+            for (int i = 0; i < arguments.length; i++) {
+                if (i > 0) {
                     buf.append(", ");
                 }
                 buf.append('$');
-                if(arguments[i] instanceof FunctionParameterSequenceType) {
-                    buf.append(((FunctionParameterSequenceType)arguments[i]).getAttributeName());
+                if (arguments[i] instanceof FunctionParameterSequenceType) {
+                    buf.append(((FunctionParameterSequenceType) arguments[i]).getAttributeName());
                 } else {
-                    buf.append((char)(ANON_VAR + i));
+                    buf.append((char) (ANON_VAR + i));
                 }
                 buf.append(" as ");
                 buf.append(arguments[i].toString());
             }
-            
-            if(isOverloaded) {
+
+            if (isVariadic) {
                 buf.append(", ...");
             }
         }
         buf.append(") as ");
         buf.append(returnType.toString());
-        
+
         return buf.toString();
     }
 
@@ -261,14 +253,16 @@ public boolean equals(final Object obj) {
             return false;
         }
         // quick comparison by object identity
-        if (this == obj) { return true; }
+        if (this == obj) {
+            return true;
+        }
 
         // anonymous functions cannot be compared by name and argument count
         final FunctionSignature other = (FunctionSignature) obj;
         if (
                 name == null || other.name == null ||
-                name.getLocalPart().equals("") ||
-                other.name.getLocalPart().equals("")
+                        name.getLocalPart().equals("") ||
+                        other.name.getLocalPart().equals("")
         ) {
             return false;
         }
@@ -288,7 +282,7 @@ public FunctionSignature rename(final QName newName) {
         final SequenceType[] argumentsCopy = arguments != null ? Arrays.copyOf(arguments, arguments.length) : null;
         final FunctionSignature newFunctionSignature = new FunctionSignature(newName, description, argumentsCopy, returnType, deprecated);
         newFunctionSignature.annotations = annotations != null ? Arrays.copyOf(annotations, annotations.length) : null;
-        newFunctionSignature.isOverloaded = isOverloaded;
+        newFunctionSignature.isVariadic = isVariadic;
         newFunctionSignature.metadata = metadata != null ? new HashMap<>(metadata) : null;
         return newFunctionSignature;
     }