Package com.aspectran.core.util.apon

Interface Parameter

  • All Known Implementing Classes:
    ParameterValue
    public interface Parameter

    • Method Detail

      • getContainer

        Parameters getContainer()
        Returns the Parameters that contains the Parameter.
        Returns:
        the Parameters

      • getName

        java.lang.String getName()
        Returns the parameter name.
        Returns:
        the parameter name

      • getQualifiedName

        java.lang.String getQualifiedName()
        Returns the fully qualified parameter name.
        Returns:
        the qualified name

      • getValueType

        ValueType getValueType()
        Returns the parameter value type.
        Returns:
        the parameter value type

      • setValueType

        void setValueType​(ValueType valueType)
        Sets the parameter value type.
        Parameters:
        valueType - the parameter value type

      • isValueTypeFixed

        boolean isValueTypeFixed()
        Returns whether this is a predefined parameter.
        Returns:
        true if this is a predefined parameter, otherwise false

      • isValueTypeHinted

        boolean isValueTypeHinted()
        Returns whether the value type is hinted.
        Returns:
        true if the value type is hinted; false otherwise

      • setValueTypeHinted

        void setValueTypeHinted​(boolean valueTypeHinted)
        Sets whether the value type is hinted.
        Parameters:
        valueTypeHinted - true if the value type is hinted; false otherwise

      • isArray

        boolean isArray()
        Returns whether the parameter value is an array.
        Returns:
        true if the parameter value is an array, otherwise false

      • isBracketed

        boolean isBracketed()
        Returns whether the value of the array is represented using square brackets.
        Returns:
        true if the value of the array is represented using square brackets, otherwise false

      • isAssigned

        boolean isAssigned()
        Returns whether a parameter has been assigned a value. Even if a null is assigned, it is valid.
        Returns:
        true if a parameter has been assigned a value, otherwise false

      • hasValue

        boolean hasValue()
        Returns whether a non-null value has been assigned.
        Returns:
        true if a non-null value is assigned, otherwise false

      • getArraySize

        int getArraySize()
        Returns the size of the array if the value is an array.
        Returns:
        the size of the array

      • getValue

        java.lang.Object getValue()
        Returns a value as an Object.
        Returns:
        an Object

      • arraylize

        void arraylize()
        Change parameter type to array type.

      • putValue

        void putValue​(java.lang.Object value)
        Puts the parameter value.
        Parameters:
        value - the parameter value

      • clearValue

        void clearValue()
        Clears the parameter value.

      • getValues

        java.lang.Object[] getValues()
        Returns a value as an Object array.
        Returns:
        an array of Object

      • getValueList

        java.util.List<?> getValueList()
        Returns a value as a List.
        Returns:
        a List

      • getValueAsString

        java.lang.String getValueAsString()
        Returns a value as a String.
        Returns:
        a String

      • getValueAsStringArray

        java.lang.String[] getValueAsStringArray()
        Returns a value as a String array.
        Returns:
        a String array

      • getValueAsStringList

        java.util.List<java.lang.String> getValueAsStringList()
        Returns a value as a List<String>.
        Returns:
        a List<String>

      • getValueAsInt

        java.lang.Integer getValueAsInt()
        Returns a value as an Integer.
        Returns:
        an Integer

      • getValueAsIntArray

        java.lang.Integer[] getValueAsIntArray()
        Returns a value as an Integer array.
        Returns:
        an Integer array

      • getValueAsIntList

        java.util.List<java.lang.Integer> getValueAsIntList()
        Returns a value as a List<Integer>.
        Returns:
        a List<Integer>

      • getValueAsLong

        java.lang.Long getValueAsLong()
        Returns a value as a Long.
        Returns:
        a Long

      • getValueAsLongArray

        java.lang.Long[] getValueAsLongArray()
        Returns a value as a Long array.
        Returns:
        a Long array

      • getValueAsLongList

        java.util.List<java.lang.Long> getValueAsLongList()
        Returns a value as a List<Long>.
        Returns:
        a List<Long>

      • getValueAsFloat

        java.lang.Float getValueAsFloat()
        Returns a value as a Float.
        Returns:
        a Float

      • getValueAsFloatArray

        java.lang.Float[] getValueAsFloatArray()
        Returns a value as a Float array.
        Returns:
        a Float array

      • getValueAsFloatList

        java.util.List<java.lang.Float> getValueAsFloatList()
        Returns a value as a List<Float>.
        Returns:
        a List<Float>

      • getValueAsDouble

        java.lang.Double getValueAsDouble()
        Returns a value as a Double.
        Returns:
        a Double

      • getValueAsDoubleArray

        java.lang.Double[] getValueAsDoubleArray()
        Returns a value as a Double array.
        Returns:
        a Double array

      • getValueAsDoubleList

        java.util.List<java.lang.Double> getValueAsDoubleList()
        Returns a value as a List<Double>.
        Returns:
        a List<Double>

      • getValueAsBoolean

        java.lang.Boolean getValueAsBoolean()
        Returns a value as a Boolean.
        Returns:
        a Boolean

      • getValueAsBooleanArray

        java.lang.Boolean[] getValueAsBooleanArray()
        Returns a value as a Boolean array.
        Returns:
        a Boolean array

      • getValueAsBooleanList

        java.util.List<java.lang.Boolean> getValueAsBooleanList()
        Returns a value as a List<Boolean>.
        Returns:
        a List<Boolean>

      • getValueAsParameters

        Parameters getValueAsParameters()
        Returns a value as a Parameters.
        Returns:
        a Parameters

      • getValueAsParametersArray

        Parameters[] getValueAsParametersArray()
        Returns a value as a Parameters array.
        Returns:
        a Parameters array

      • getValueAsParametersList

        java.util.List<Parameters> getValueAsParametersList()
        Returns a value as a List<Parameters>.
        Returns:
        a List<Parameters>

      • newParameters

        <T extends Parameters> T newParameters​(Parameter identifier)
        Creates a new instance of Parameters with the specified identifier Parameter.
        Type Parameters:
        T - the type of the new Parameters object
        Parameters:
        identifier - the specified identifier Parameter
        Returns:
        a Parameters