Package com.aspectran.utils.apon

Interface Parameters

All Known Implementing Classes:
AbstractParameters, ActionParameters, AdviceActionParameters, AdviceParameters, AppendParameters, ArrayParameters, AspectParameters, AspectranConfig, AspectranParameters, BeanParameters, ChooseWhenParameters, CommandParameters, ContentParameters, ContentsParameters, ContextAutoReloadConfig, ContextConfig, ContextProfilesConfig, DaemonConfig, DaemonExecutorConfig, DaemonPollingConfig, DescriptionParameters, DispatchParameters, EmbedConfig, EntryParameters, EnvironmentParameters, ExceptionParameters, ExceptionThrownParameters, ExposalsConfig, FilterParameters, ForwardParameters, ItemHolderParameters, ItemParameters, JoinpointParameters, PointcutParameters, PointcutQualifierParameters, RedirectParameters, RequestParameters, ResourcePathPatterns, ResponseParameters, RootParameters, ScheduledJobParameters, ScheduleParameters, SchedulerConfig, SchedulerParameters, SessionFileStoreConfig, SessionManagerConfig, SettingParameters, SettingsParameters, ShellConfig, ShellStyleConfig, SystemConfig, TemplateParameters, TransformParameters, TransletParameters, TriggerExpressionParameters, TriggerParameters, TypeAliasesParameters, TypeAliasParameters, VariableParameters, WebConfig
public interface Parameters
The Interface Parameters.

  • Method Details

    • isStructureFixed

      boolean isStructureFixed()
      Returns whether the parameter can be added after the parameters instance is created.
      Returns:
      true if the parameter can be added after the parameters instance is created, otherwise false

    • getProprietor

      Parameter getProprietor()
      Returns the owner of this Parameters.
      Returns:
      the owner of this Parameters

    • setProprietor

      void setProprietor(Parameter proprietor)
      Specifies the owner of this Parameters.
      Parameters:
      proprietor - the owner of this Parameters

    • getParent

      Parameter getParent()
      Returns the parent of the proprietor of this Parameters. 
       proprietor --> container --> proprietor == parent
      Returns:
      a Parameter

    • getActualName

      String getActualName()
      Returns its real name. If no name is given, it returns the name given by the owner.
      Returns:
      the actual name of this Parameters

    • setActualName

      void setActualName(String actualName)
      Specifies the actual name of this Parameters.
      Parameters:
      actualName - the actual name of this Parameters

    • getQualifiedName

      String getQualifiedName()
      Returns the qualified name.
      Returns:
      the qualified name

    • getParameterValue

      ParameterValue getParameterValue(String name)

    • getParameterValueMap

      Map<String,ParameterValue> getParameterValueMap()
      Returns a map of the ParameterValues.
      Returns:
      a map of the ParameterValues

    • getParameterNames

      String[] getParameterNames()
      Returns all the parameter names associated with this Parameters.
      Returns:
      an array of all parameter names associated with this Parameters

    • getParameterNameSet

      Set<String> getParameterNameSet()
      Returns all the parameter names associated with this Parameters.
      Returns:
      the Set with all parameter names associated with this Parameters

    • hasParameter

      boolean hasParameter(String name)
      Returns whether this parameter exists.
      Parameters:
      name - the name of the parameter to check
      Returns:
      true if the specified parameter exists; false otherwise

    • hasParameter

      boolean hasParameter(ParameterKey key)
      Returns whether the specified parameter exists.
      Parameters:
      key - the parameter definition
      Returns:
      true if the specified parameter exists; false otherwise

    • isAssigned

      boolean isAssigned(String name)
      Returns whether a value is assigned to the specified parameter. Even if a null is assigned, it is valid.
      Parameters:
      name - the name of the parameter to check
      Returns:
      true if a parameter is assigned a value; false otherwise

    • isAssigned

      boolean isAssigned(ParameterKey key)
      Returns whether a value is assigned to the specified parameter. Even if a null is assigned, it is valid.
      Parameters:
      key - the parameter definition
      Returns:
      true if a parameter is assigned a value; false otherwise

    • hasValue

      boolean hasValue(String name)
      Returns whether a non-null value is assigned to the specified parameter.
      Parameters:
      name - the name of the parameter to check
      Returns:
      true if a non-null value is assigned a value; false otherwise

    • hasValue

      boolean hasValue(ParameterKey key)
      Returns whether a non-null value is assigned to the specified parameter.
      Parameters:
      key - the parameter definition
      Returns:
      true if a non-null value is assigned a value; false otherwise

    • getParameter

      Parameter getParameter(String name)
      Returns the Parameter with the specified name.
      Parameters:
      name - the parameter name
      Returns:
      the Parameter with the specified name, or null if it does not exist

    • getParameter

      Parameter getParameter(ParameterKey key)
      Returns the Parameter corresponding to the specified parameter definition.
      Parameters:
      key - the parameter definition
      Returns:
      the Parameter corresponding to the specified parameter definition, or null if it does not exist

    • getValue

      Object getValue(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getValue

      Object getValue(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • setValue

      void setValue(String name, Object value)
      Put a value into the Parameter with the specified name. If there is an existing value, remove it and put it.
      Parameters:
      name - the parameter name
      value - the value of parameter

    • setValue

      void setValue(ParameterKey key, Object value)
      Put a value into the Parameter with the specified parameter definition. If there is an existing value, remove it and put it.
      Parameters:
      key - the parameter definition
      value - the value of parameter

    • putAll

      void putAll(Parameters parameters)

    • putValue

      void putValue(String name, Object value)
      Put a value into the Parameter with the specified name.
      Parameters:
      name - the parameter name
      value - the value of parameter

    • putValue

      void putValue(ParameterKey key, Object value)
      Put a value into the Parameter with the specified parameter definition.
      Parameters:
      key - the parameter definition
      value - the value of parameter

    • putValueNonNull

      void putValueNonNull(String name, Object value)
      Put a value of the parameter corresponding to the given name. If the value is null, ignore it.
      Parameters:
      name - the parameter name
      value - the value of parameter

    • putValueNonNull

      void putValueNonNull(ParameterKey key, Object value)
      Put a value of the parameter corresponding to the given parameter definition. If the value is null, ignore it.
      Parameters:
      key - the parameter definition
      value - the value of parameter

    • removeValue

      void removeValue(String name)
      Remove the value of this parameter.
      Parameters:
      name - the parameter name

    • removeValue

      void removeValue(ParameterKey key)
      Remove the value of this parameter.
      Parameters:
      key - the parameter key

    • getString

      String getString(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getString

      String getString(String name, String defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      name - the parameter name
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getStringArray

      String[] getStringArray(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getString

      String getString(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getString

      String getString(ParameterKey key, String defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      key - the parameter definition
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getStringArray

      String[] getStringArray(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getStringList

      List<String> getStringList(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getStringList

      List<String> getStringList(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getInt

      Integer getInt(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getInt

      int getInt(String name, int defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      name - the parameter name
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getIntArray

      Integer[] getIntArray(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getInt

      Integer getInt(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getInt

      int getInt(ParameterKey key, int defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      key - the parameter definition
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getIntArray

      Integer[] getIntArray(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getIntList

      List<Integer> getIntList(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getIntList

      List<Integer> getIntList(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getLong

      Long getLong(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getLong

      long getLong(String name, long defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      name - the parameter name
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getLongArray

      Long[] getLongArray(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getLong

      Long getLong(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getLong

      long getLong(ParameterKey key, long defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      key - the parameter definition
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getLongArray

      Long[] getLongArray(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getLongList

      List<Long> getLongList(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getLongList

      List<Long> getLongList(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getFloat

      Float getFloat(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getFloat

      float getFloat(String name, float defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      name - the parameter name
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getFloatArray

      Float[] getFloatArray(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getFloat

      Float getFloat(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getFloat

      float getFloat(ParameterKey key, float defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      key - the parameter definition
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getFloatArray

      Float[] getFloatArray(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getFloatList

      List<Float> getFloatList(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getFloatList

      List<Float> getFloatList(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getDouble

      Double getDouble(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getDouble

      double getDouble(String name, double defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      name - the parameter name
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getDoubleArray

      Double[] getDoubleArray(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getDouble

      Double getDouble(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getDouble

      double getDouble(ParameterKey key, double defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      key - the parameter definition
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getDoubleArray

      Double[] getDoubleArray(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getDoubleList

      List<Double> getDoubleList(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getDoubleList

      List<Double> getDoubleList(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getBoolean

      Boolean getBoolean(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getBoolean

      boolean getBoolean(String name, boolean defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      name - the parameter name
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getBooleanArray

      Boolean[] getBooleanArray(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getBoolean

      Boolean getBoolean(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getBoolean

      boolean getBoolean(ParameterKey key, boolean defaultValue)
      Return the value for the specified parameter, or defaultValue if the parameter does not exist.
      Parameters:
      key - the parameter definition
      defaultValue - the default value to return if no value is found
      Returns:
      the value for the specified parameter, or defaultValue

    • getBooleanArray

      Boolean[] getBooleanArray(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getBooleanList

      List<Boolean> getBooleanList(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getBooleanList

      List<Boolean> getBooleanList(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getParameters

      <T extends Parameters> T getParameters(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Type Parameters:
      T - the type parameter
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getParametersArray

      <T extends Parameters> T[] getParametersArray(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Type Parameters:
      T - the type parameter
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getParameters

      <T extends Parameters> T getParameters(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Type Parameters:
      T - the type parameter
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getParametersArray

      <T extends Parameters> T[] getParametersArray(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Type Parameters:
      T - the type parameter
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • getParametersList

      <T extends Parameters> List<T> getParametersList(String name)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Type Parameters:
      T - the type parameter
      Parameters:
      name - the parameter name
      Returns:
      the value for the specified parameter, or null

    • getParametersList

      <T extends Parameters> List<T> getParametersList(ParameterKey key)
      Return the value for the specified parameter, or null if the parameter does not exist.
      Type Parameters:
      T - the type parameter
      Parameters:
      key - the parameter definition
      Returns:
      the value for the specified parameter, or null

    • newParameterValue

      ParameterValue newParameterValue(String name, ValueType valueType)

    • newParameterValue

      ParameterValue newParameterValue(String name, ValueType valueType, boolean array)

    • newParameters

      <T extends Parameters> T newParameters(String name)

    • newParameters

      <T extends Parameters> T newParameters(ParameterKey key)

    • touchParameters

      <T extends Parameters> T touchParameters(String name)

    • touchParameters

      <T extends Parameters> T touchParameters(ParameterKey key)

    • updateContainer

      void updateContainer(Parameters container)
      Updates the holder of the subparameters belonging to this parameter.

    • readFrom

      void readFrom(String apon) throws AponParseException
      Throws:
      AponParseException

    • readFrom

      void readFrom(VariableParameters parameters) throws AponParseException
      Throws:
      AponParseException

    • readFrom

      void readFrom(File file) throws AponParseException
      Throws:
      AponParseException

    • readFrom

      void readFrom(File file, String encoding) throws AponParseException
      Throws:
      AponParseException

    • readFrom

      void readFrom(Reader reader) throws AponParseException
      Throws:
      AponParseException

    • describe

      String describe()

    • describe

      String describe(boolean details)