Package org.jppf.utils.configuration

Class StringProperty

java.lang.Object

org.jppf.utils.configuration.AbstractJPPFProperty<String>

org.jppf.utils.configuration.StringProperty

All Implemented Interfaces:

Serializable, JPPFProperty<String>

public class StringProperty
extends AbstractJPPFProperty<String>

Implementation of JPPFProperty for String properties.

Since:

5.2

Author:

Laurent Cohen

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StringProperty(String name, String defaultValue, String... aliases)	Initialize this property with the specified name and default value.

Method Summary

Modifier and Type	Method	Description
String	toString(String value)	Convert the specified value to a string.
String	valueOf(String value)	Convert the specified value into the type of values handled by this property.
Class<String>	valueType()	Return the class object for the type of values of this property.

Methods inherited from class org.jppf.utils.configuration.AbstractJPPFProperty

getAliases, getDefaultValue, getDeprecatedDoc, getDeprecatedDoc, getDocumentation, getDocumentation, getI18nBase, getName, getParameterDoc, getParameters, getPossibleValues, getShortLabel, getShortLabel, getTags, isDeprecated, resolveName, resolveName, setDeprecated, setI18nBase, setPossibleValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

StringProperty

public StringProperty(String name,
 String defaultValue,
 String... aliases)

Initialize this property with the specified name and default value.

Parameters:

name - the name of this property.

defaultValue - the default value of this property, used when the property is not defined.

aliases - other names that may be given to this property (e.g. older names from previous versions).

Method Details

valueOf

public String valueOf(String value)

Description copied from interface: JPPFProperty

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

public String toString(String value)

Description copied from interface: JPPFProperty

Convert the specified value to a string.

Specified by:

toString in interface JPPFProperty<String>

Overrides:

toString in class AbstractJPPFProperty<String>

Parameters:

value - the property value to convert.

Returns:

a String representation of the value.

valueType

public Class<String> valueType()

Description copied from interface: JPPFProperty

Return the class object for the type of values of this property.

Returns:

a Class instance.