org.yarnandtail.andhow.property

Class PropertyBase<T>

java.lang.Object

org.yarnandtail.andhow.property.PropertyBase<T>

All Implemented Interfaces:

Property<T>

Direct Known Subclasses:

FlagProp, IntProp, LngProp, LocalDateTimeProp, StrProp

public abstract class PropertyBase<T>
extends Object
implements Property<T>

Author:

eeverman

Constructor Summary

Constructors

Constructor and Description
PropertyBase(T defaultValue, boolean required, String shortDesc, List<Validator<T>> validators, List<Name> aliases, PropertyType paramType, ValueType<T> valueType, Trimmer trimmer, String helpText)

Method Summary

Modifier and Type	Method and Description
T	getDefaultValue()
T	getExplicitValue()
T	getExplicitValue(ValueMap values)
String	getHelpText() Added details that might be shown if the user requests help.
PropertyType	getPropertyType() The basic type of the property: Flag, name/value, multi=value.
List<Name>	getRequestedAliases() The list of Aliases requested by this property in its declaration.
String	getShortDescription() A short sentence description.
Trimmer	getTrimmer() The Trimmer responsible for trimming String values before they are converted to the appropriate property type.
List<Validator<T>>	getValidators() List of validators to validate the converted value.
T	getValue()
T	getValue(ValueMap values)
ValueType<T>	getValueType() The type of the value (String, Number, Integer, etc).
boolean	isRequired()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyBase

public PropertyBase(T defaultValue,
                    boolean required,
                    String shortDesc,
                    List<Validator<T>> validators,
                    List<Name> aliases,
                    PropertyType paramType,
                    ValueType<T> valueType,
                    Trimmer trimmer,
                    String helpText)

Method Detail

getPropertyType

public PropertyType getPropertyType()

Description copied from interface: Property

The basic type of the property: Flag, name/value, multi=value.

Specified by:

getPropertyType in interface Property<T>

Returns:

getValueType

public ValueType<T> getValueType()

Description copied from interface: Property

The type of the value (String, Number, Integer, etc). For Properties that allow multiple values (not yet implemented), an array of values of the specified type can be fetched.

Specified by:

getValueType in interface Property<T>

Returns:

getTrimmer

public Trimmer getTrimmer()

Description copied from interface: Property

The Trimmer responsible for trimming String values before they are converted to the appropriate property type.

Specified by:

getTrimmer in interface Property<T>

Returns:

getShortDescription

public String getShortDescription()

Description copied from interface: Property

A short sentence description.

Specified by:

getShortDescription in interface Property<T>

Returns:

getValidators

public List<Validator<T>> getValidators()

Description copied from interface: Property

List of validators to validate the converted value.

Specified by:

getValidators in interface Property<T>

Returns:

getRequestedAliases

public List<Name> getRequestedAliases()

Description copied from interface: Property

The list of Aliases requested by this property in its declaration. CAUTION: This is NOT necessarily the list of Alias actually available for this property - use AndHow.getAlias() for that. Since Properties from unrelated libraries can be used in the same application, the main AndHow application level configuration must be able to disable aliases that conflict (i.e., two properties are aliased as 'my-prop'. Note that the returned aliases may be coalesced. For instance, if a property is build as: IntProp MyProp = IntProp.builder().inAlias("Bob").outAlias("Bob").build(); getConfiguredAliases() may return a single Alias object w/ the name "Bob", marked as being both both in and out.

Specified by:

getRequestedAliases in interface Property<T>

Returns:

A list of Alias assigned to this Property in the property declaration or an empty list if there are none.

getHelpText

public String getHelpText()

Description copied from interface: Property

Added details that might be shown if the user requests help. Assume that the short description is already shown.

Specified by:

getHelpText in interface Property<T>

Returns:

isRequired

public boolean isRequired()

Specified by:

isRequired in interface Property<T>

getValue

public T getValue(ValueMap values)

Specified by:

getValue in interface Property<T>

getValue

public final T getValue()

Specified by:

getValue in interface Property<T>

getExplicitValue

public T getExplicitValue(ValueMap values)

Specified by:

getExplicitValue in interface Property<T>

getExplicitValue

public final T getExplicitValue()

Specified by:

getExplicitValue in interface Property<T>

getDefaultValue

public T getDefaultValue()

Specified by:

getDefaultValue in interface Property<T>