Class ParameterValue

  • All Implemented Interfaces:
    Parameter

    public class ParameterValue
    extends java.lang.Object
    implements Parameter
    • Constructor Detail

      • ParameterValue

        public ParameterValue​(java.lang.String name,
                              ValueType valueType)
      • ParameterValue

        public ParameterValue​(java.lang.String name,
                              ValueType valueType,
                              boolean array)
      • ParameterValue

        public ParameterValue​(java.lang.String name,
                              ValueType valueType,
                              boolean array,
                              boolean noBracket)
      • ParameterValue

        protected ParameterValue​(java.lang.String name,
                                 ValueType valueType,
                                 boolean array,
                                 boolean noBracket,
                                 boolean valueTypeFixed)
      • ParameterValue

        public ParameterValue​(java.lang.String name,
                              java.lang.Class<? extends AbstractParameters> parametersClass)
      • ParameterValue

        public ParameterValue​(java.lang.String name,
                              java.lang.Class<? extends AbstractParameters> parametersClass,
                              boolean array)
      • ParameterValue

        public ParameterValue​(java.lang.String name,
                              java.lang.Class<? extends AbstractParameters> parametersClass,
                              boolean array,
                              boolean noBracket)
      • ParameterValue

        protected ParameterValue​(java.lang.String name,
                                 java.lang.Class<? extends AbstractParameters> parametersClass,
                                 boolean array,
                                 boolean noBracket,
                                 boolean valueTypeFixed)
    • Method Detail

      • getContainer

        public Parameters getContainer()
        Description copied from interface: Parameter
        Returns the Parameters that contains the Parameter.
        Specified by:
        getContainer in interface Parameter
        Returns:
        the Parameters
      • setContainer

        public void setContainer​(Parameters container)
      • getName

        public java.lang.String getName()
        Description copied from interface: Parameter
        Returns the parameter name.
        Specified by:
        getName in interface Parameter
        Returns:
        the parameter name
      • getQualifiedName

        public java.lang.String getQualifiedName()
        Description copied from interface: Parameter
        Returns the fully qualified parameter name.
        Specified by:
        getQualifiedName in interface Parameter
        Returns:
        the qualified name
      • getValueType

        public ValueType getValueType()
        Description copied from interface: Parameter
        Returns the parameter value type.
        Specified by:
        getValueType in interface Parameter
        Returns:
        the parameter value type
      • setValueType

        public void setValueType​(ValueType valueType)
        Description copied from interface: Parameter
        Sets the parameter value type.
        Specified by:
        setValueType in interface Parameter
        Parameters:
        valueType - the parameter value type
      • isValueTypeFixed

        public boolean isValueTypeFixed()
        Description copied from interface: Parameter
        Returns whether this is a predefined parameter.
        Specified by:
        isValueTypeFixed in interface Parameter
        Returns:
        true if this is a predefined parameter, otherwise false
      • isValueTypeHinted

        public boolean isValueTypeHinted()
        Description copied from interface: Parameter
        Returns whether the value type is hinted.
        Specified by:
        isValueTypeHinted in interface Parameter
        Returns:
        true if the value type is hinted; false otherwise
      • setValueTypeHinted

        public void setValueTypeHinted​(boolean valueTypeHinted)
        Description copied from interface: Parameter
        Sets whether the value type is hinted.
        Specified by:
        setValueTypeHinted in interface Parameter
        Parameters:
        valueTypeHinted - true if the value type is hinted; false otherwise
      • isArray

        public boolean isArray()
        Description copied from interface: Parameter
        Returns whether the parameter value is an array.
        Specified by:
        isArray in interface Parameter
        Returns:
        true if the parameter value is an array, otherwise false
      • isBracketed

        public boolean isBracketed()
        Description copied from interface: Parameter
        Returns whether the value of the array is represented using square brackets.
        Specified by:
        isBracketed in interface Parameter
        Returns:
        true if the value of the array is represented using square brackets, otherwise false
      • setBracketed

        public void setBracketed​(boolean bracketed)
      • isAssigned

        public boolean isAssigned()
        Description copied from interface: Parameter
        Returns whether a parameter has been assigned a value. Even if a null is assigned, it is valid.
        Specified by:
        isAssigned in interface Parameter
        Returns:
        true if a parameter has been assigned a value, otherwise false
      • hasValue

        public boolean hasValue()
        Description copied from interface: Parameter
        Returns whether a non-null value has been assigned.
        Specified by:
        hasValue in interface Parameter
        Returns:
        true if a non-null value is assigned, otherwise false
      • getArraySize

        public int getArraySize()
        Description copied from interface: Parameter
        Returns the size of the array if the value is an array.
        Specified by:
        getArraySize in interface Parameter
        Returns:
        the size of the array
      • arraylize

        public void arraylize()
        Description copied from interface: Parameter
        Change parameter type to array type.
        Specified by:
        arraylize in interface Parameter
      • putValue

        public void putValue​(java.lang.Object value)
        Description copied from interface: Parameter
        Puts the parameter value.
        Specified by:
        putValue in interface Parameter
        Parameters:
        value - the parameter value
      • clearValue

        public void clearValue()
        Description copied from interface: Parameter
        Clears the parameter value.
        Specified by:
        clearValue in interface Parameter
      • getValue

        public java.lang.Object getValue()
        Description copied from interface: Parameter
        Returns a value as an Object.
        Specified by:
        getValue in interface Parameter
        Returns:
        an Object
      • getValueList

        public java.util.List<?> getValueList()
        Description copied from interface: Parameter
        Returns a value as a List.
        Specified by:
        getValueList in interface Parameter
        Returns:
        a List
      • getValues

        public java.lang.Object[] getValues()
        Description copied from interface: Parameter
        Returns a value as an Object array.
        Specified by:
        getValues in interface Parameter
        Returns:
        an array of Object
      • getValueAsString

        public java.lang.String getValueAsString()
        Description copied from interface: Parameter
        Returns a value as a String.
        Specified by:
        getValueAsString in interface Parameter
        Returns:
        a String
      • getValueAsStringArray

        public java.lang.String[] getValueAsStringArray()
        Description copied from interface: Parameter
        Returns a value as a String array.
        Specified by:
        getValueAsStringArray in interface Parameter
        Returns:
        a String array
      • getValueAsStringList

        public java.util.List<java.lang.String> getValueAsStringList()
        Description copied from interface: Parameter
        Returns a value as a List<String>.
        Specified by:
        getValueAsStringList in interface Parameter
        Returns:
        a List<String>
      • getValueAsInt

        public java.lang.Integer getValueAsInt()
        Description copied from interface: Parameter
        Returns a value as an Integer.
        Specified by:
        getValueAsInt in interface Parameter
        Returns:
        an Integer
      • getValueAsIntArray

        public java.lang.Integer[] getValueAsIntArray()
        Description copied from interface: Parameter
        Returns a value as an Integer array.
        Specified by:
        getValueAsIntArray in interface Parameter
        Returns:
        an Integer array
      • getValueAsIntList

        public java.util.List<java.lang.Integer> getValueAsIntList()
        Description copied from interface: Parameter
        Returns a value as a List<Integer>.
        Specified by:
        getValueAsIntList in interface Parameter
        Returns:
        a List<Integer>
      • getValueAsLong

        public java.lang.Long getValueAsLong()
        Description copied from interface: Parameter
        Returns a value as a Long.
        Specified by:
        getValueAsLong in interface Parameter
        Returns:
        a Long
      • getValueAsLongArray

        public java.lang.Long[] getValueAsLongArray()
        Description copied from interface: Parameter
        Returns a value as a Long array.
        Specified by:
        getValueAsLongArray in interface Parameter
        Returns:
        a Long array
      • getValueAsLongList

        public java.util.List<java.lang.Long> getValueAsLongList()
        Description copied from interface: Parameter
        Returns a value as a List<Long>.
        Specified by:
        getValueAsLongList in interface Parameter
        Returns:
        a List<Long>
      • getValueAsFloat

        public java.lang.Float getValueAsFloat()
        Description copied from interface: Parameter
        Returns a value as a Float.
        Specified by:
        getValueAsFloat in interface Parameter
        Returns:
        a Float
      • getValueAsFloatArray

        public java.lang.Float[] getValueAsFloatArray()
        Description copied from interface: Parameter
        Returns a value as a Float array.
        Specified by:
        getValueAsFloatArray in interface Parameter
        Returns:
        a Float array
      • getValueAsFloatList

        public java.util.List<java.lang.Float> getValueAsFloatList()
        Description copied from interface: Parameter
        Returns a value as a List<Float>.
        Specified by:
        getValueAsFloatList in interface Parameter
        Returns:
        a List<Float>
      • getValueAsDouble

        public java.lang.Double getValueAsDouble()
        Description copied from interface: Parameter
        Returns a value as a Double.
        Specified by:
        getValueAsDouble in interface Parameter
        Returns:
        a Double
      • getValueAsDoubleArray

        public java.lang.Double[] getValueAsDoubleArray()
        Description copied from interface: Parameter
        Returns a value as a Double array.
        Specified by:
        getValueAsDoubleArray in interface Parameter
        Returns:
        a Double array
      • getValueAsDoubleList

        public java.util.List<java.lang.Double> getValueAsDoubleList()
        Description copied from interface: Parameter
        Returns a value as a List<Double>.
        Specified by:
        getValueAsDoubleList in interface Parameter
        Returns:
        a List<Double>
      • getValueAsBoolean

        public java.lang.Boolean getValueAsBoolean()
        Description copied from interface: Parameter
        Returns a value as a Boolean.
        Specified by:
        getValueAsBoolean in interface Parameter
        Returns:
        a Boolean
      • getValueAsBooleanArray

        public java.lang.Boolean[] getValueAsBooleanArray()
        Description copied from interface: Parameter
        Returns a value as a Boolean array.
        Specified by:
        getValueAsBooleanArray in interface Parameter
        Returns:
        a Boolean array
      • getValueAsBooleanList

        public java.util.List<java.lang.Boolean> getValueAsBooleanList()
        Description copied from interface: Parameter
        Returns a value as a List<Boolean>.
        Specified by:
        getValueAsBooleanList in interface Parameter
        Returns:
        a List<Boolean>
      • getValueAsParametersList

        public java.util.List<Parameters> getValueAsParametersList()
        Description copied from interface: Parameter
        Returns a value as a List<Parameters>.
        Specified by:
        getValueAsParametersList in interface Parameter
        Returns:
        a List<Parameters>
      • newParameters

        public <T extends Parameters> T newParameters​(Parameter identifier)
        Description copied from interface: Parameter
        Creates a new instance of Parameters with the specified identifier Parameter.
        Specified by:
        newParameters in interface Parameter
        Type Parameters:
        T - the type of the new Parameters object
        Parameters:
        identifier - the specified identifier Parameter
        Returns:
        a Parameters
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object