PropertyBase (andhow 0.4.0-RC5 API)

java.lang.Object
- org.yarnandtail.andhow.property.PropertyBase<T>

All Implemented Interfaces:

Property<T>

Direct Known Subclasses:

BolProp, DblProp, FlagProp, IntProp, LngProp, LocalDateTimeProp, StrProp
```
public abstract class PropertyBase<T>
extends Object
implements Property<T>
```
Base property implementation that handles most of state information and common methods.

Author:

eeverman

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`getDefaultValue()` The default value, as defined when this Property was constructed.
`String`	`getDescription()` A description of the property, what it is for and what it does in the system.
`T`	`getExplicitValue()` The value found and loaded for this value by a Loader.
`String`	`getHelpText()` Added details that will 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.
`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()` Returns the effective value of this property.
`ValueType<T>`	`getValueType()` The type of the value (String, Number, Integer, etc).
`boolean`	`isNonNullRequired()` If true, the effective value must be non-null to be considered valid.

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 nonNull,
                    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:
    
    Never null
  - 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:
    
    Never null
  - 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:
    
    Never null
  - getDescription
```
public String getDescription()
```
    Description copied from interface: Property
    
    A description of the property, what it is for and what it does in the system. When the description is presented, the canonical name, validation requirements and helpText is presented as well, so it does not need to all be included in the description.
    
    Specified by:
    
    getDescription in interface Property<T>
    
    Returns:
    
    May be null
  - 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:
    
    An unmodifiable list of Validators. Never null.
  - 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 will be shown if the user requests help. Assume that the the canonical name, validation requirements and description are presented as well. Help text can provide added details, such as details on how to specify special values or interrelated properties.
    
    Specified by:
    
    getHelpText in interface Property<T>
    
    Returns:
    
    May be null
  - isNonNullRequired
```
public boolean isNonNullRequired()
```
    Description copied from interface: Property
    
    If true, the effective value must be non-null to be considered valid. The effective value is the explicitly configured value, or if that is null, the default value.
    
    Specified by:
    
    isNonNullRequired in interface Property<T>
    
    Returns:
    
    True if a non-null value is required.
  - getValue
```
public T getValue()
```
    Description copied from interface: Property
    
    Returns the effective value of this property. The effective value is the explicitly configured value, or if that is null, the default value. Explicitly setting a property to null is not possible because it will just be ignored and the default used instead.
    
    Specified by:
    
    getValue in interface Property<T>
    
    Returns:
    
    May be null, unless the property is marked as required.
  - getExplicitValue
```
public final T getExplicitValue()
```
    Description copied from interface: Property
    
    The value found and loaded for this value by a Loader. If no non-null value was found by a loader for this property, null is returned.
    
    Specified by:
    
    getExplicitValue in interface Property<T>
    
    Returns:
    
    May be null
  - getDefaultValue
```
public T getDefaultValue()
```
    Description copied from interface: Property
    
    The default value, as defined when this Property was constructed.
    
    Specified by:
    
    getDefaultValue in interface Property<T>
    
    Returns:
    
    May be null

Class PropertyBase<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PropertyBase

Method Detail

getPropertyType

getValueType

getTrimmer

getDescription

getValidators

getRequestedAliases

getHelpText

isNonNullRequired

getValue

getExplicitValue

getDefaultValue