Package org.jppf.utils.configuration

Interface JPPFProperty<T>

Type Parameters:
T - the type of the value of this property.
All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractJPPFProperty, BooleanProperty, CharProperty, DoubleProperty, FileProperty, FloatProperty, IntArrayProperty, IntProperty, LongProperty, NumberProperty, StringArrayProperty, StringProperty
public interface JPPFProperty<T> extends Serializable
Interface for predefined JPPF properties expected to handle a specific value type.
Since:
5.2
Author:
Laurent Cohen

  • Method Details

    • getName

      String getName()
      Get the name of this property.
      Returns:
      the property's name.

    • getDefaultValue

      T getDefaultValue()
      Get the default value of this property.
      Returns:
      the default value;

    • getAliases

      String[] getAliases()
      Get the aliases for this property, that is, other names it may be known as such as legacy names from prior versions.
      Returns:
      an array of the aliases for this property, possibly empty.

    • valueOf

      T valueOf(String value)
      Convert the specified value into the type of values handled by this property.
      Parameters:
      value - the property value to convert.
      Returns:
      the value converted to the type of this property.

    • toString

      String toString(T value)
      Convert the specified value to a string.
      Parameters:
      value - the property value to convert.
      Returns:
      a String representation of the value.

    • valueType

      Class<T> valueType()
      Return the class object for the type of values of this property.
      Returns:
      a Class instance.

    • getShortLabel

      String getShortLabel()
      Get a short label for this property.
      Returns:
      the label as a string.

    • getShortLabel

      String getShortLabel(Locale locale)
      Get a short label for this property.
      Parameters:
      locale - the locale in which the short label of this property should be returned.
      Returns:
      the label as a string.

    • getDocumentation

      String getDocumentation(Locale locale)
      Get a description of this property.
      Parameters:
      locale - the locale in which the documentation of this property should be returned.
      Returns:
      the description as a string.

    • getDocumentation

      String getDocumentation()
      Get a description of this property.
      Returns:
      the description as a string.

    • getTags

      Set<String> getTags()
      Get the set of tags that apply to this property.
      Returns:
      a set of tags as strings.

    • getParameters

      String[] getParameters()
      Get the parmaeters specified in the name of property, if any. Parameters are specified as in this example: my.<param1>.property.<param2>.name = some value.
      Returns:
      an array of the parameter names, empty if there is no parameter.
      Since:
      6.0

    • getParameterDoc

      String getParameterDoc(String param)
      Get the documeentation for the specified parmaeter, if it exists.
      Parameters:
      param - the name of the parameter for which to find a description.
      Returns:
      a string describing the parameter.
      Since:
      6.0

    • getDeprecatedDoc

      String getDeprecatedDoc()
      Get a string explaining why a property was deprecated and/or what to use instead.
      Returns:
      a text documentation about this property's deprecation.

    • getDeprecatedDoc

      String getDeprecatedDoc(Locale locale)
      Get a string explaining why a property was deprecated and/or what to use instead.
      Parameters:
      locale - the locale in which the text should be returned.
      Returns:
      a text documentation about this property's deprecation.

    • resolveName

      String resolveName(String... params)
      Resolve the name of the property by substituting the parameters names with actual values.
      Parameters:
      params - the values of the parameters.
      Returns:
      the new resolve name.
      Since:
      6.0

    • resolveName

      String resolveName(String alias, String... params)
      Resolve the specified alias for the property's name by substituting the parameters names with actual values.
      Parameters:
      alias - the alias to resolve.
      params - the values of the parameters.
      Returns:
      the new resolve name.
      Since:
      6.0

    • isDeprecated

      boolean isDeprecated()
      Determine whether this property is deprecated.
      Returns:
      true if the property is deprecated, false otherwise.

    • setDeprecated

      JPPFProperty<T> setDeprecated(boolean deprecated)
      Specify whether this property is deprecated.
      Parameters:
      deprecated - true if the property is deprecated, false otherwise.
      Returns:
      this property, for method call chaining.