org.yarnandtail.andhow.property

Class PropertyBuilderBase<B extends PropertyBuilderBase,P extends Property<T>,T>

java.lang.Object

org.yarnandtail.andhow.property.PropertyBuilderBase<B,P,T>

Direct Known Subclasses:

BigDecProp.BigDecBuilder, BolProp.BolBuilder, DblProp.DblBuilder, FlagProp.FlagBuilder, IntProp.IntBuilder, LngProp.LngBuilder, LocalDateTimeProp.LocalDateTimeBuilder, StrProp.StrBuilder

public abstract class PropertyBuilderBase<B extends PropertyBuilderBase,P extends Property<T>,T>
extends Object

A generic PropertyBuilder class which needs to be fully implemented as an inner class in each Property implementation. The builder code is intended to be concise and readable in use. Thus, 'set' or 'add' is dropped from method name prefixes where possible. For single valued properties, like description, calling description("") sets the value. For list of values, like validation, calling validation(new Validator(...)) would add a validitor to the list.

Author:

eeverman

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Name>	_aliases
protected T	_defaultValue
protected String	_desc
protected String	_helpText
protected boolean	_nonNull
protected Trimmer	_trimmer
protected List<Validator<T>>	_validators
protected ValueType<T>	_valueType
protected B	instance

Constructor Summary

Constructors

Constructor and Description
PropertyBuilderBase()

Method Summary

Modifier and Type	Method and Description
protected void	addAlias(Name newAlias, List<Name> addToList) Used by public alias methods to actually add the Alias.
B	aliasIn(String name) Adds an alternate name for this property that will be recognized when a Loader reads a property in from a source, such as JNDI or a properties file.
B	aliasInAndOut(String name) Adds an alternate name for this property that will both be recognized when reading in properties and can be used when exporting properties.
B	aliasOut(String name) Adds an alternate name for this property that can be used if this property is exported, such as exporting to System.properties.
abstract P	build() Build the Property instance.
B	defaultValue(T defaultValue) Assigns a default value for the property.
B	desc(String shortDesc) Same as description
B	description(String desc)
B	helpText(String helpText)
B	notNull() If set, the effective value must be non-null to be considered valid.
protected void	setInstance(B instance)
B	trimmer(Trimmer trimmer) Assigns the whitespace trimmer that is used on the raw value.
B	validation(Validator<T> validator) Adds a validation to the list of validators,
B	validations(List<Validator<T>> validators) Adds a list of Validators to the list of validators being built.
B	valueType(ValueType<T> valueType) This method should be called by subclasses.

Methods inherited from class java.lang.Object

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

Field Detail

instance

protected B extends PropertyBuilderBase instance

_valueType

protected ValueType<T> _valueType

_trimmer

protected Trimmer _trimmer

_defaultValue

protected T _defaultValue

_nonNull

protected boolean _nonNull

_desc

protected String _desc

_validators

protected List<Validator<T>> _validators

_aliases

protected List<Name> _aliases

_helpText

protected String _helpText

Constructor Detail

PropertyBuilderBase

public PropertyBuilderBase()

Method Detail

setInstance

protected void setInstance(B instance)

valueType

public B valueType(ValueType<T> valueType)

This method should be called by subclasses. If unset, build() will throw an exception.

Parameters:

valueType -

Returns:

trimmer

public B trimmer(Trimmer trimmer)

Assigns the whitespace trimmer that is used on the raw value. The default trimmer for each Property subclass should generally be acceptable - See individual Property instances for details on the defaults.

Parameters:

trimmer -

Returns:

defaultValue

public B defaultValue(T defaultValue)

Assigns a default value for the property. The default value must pass all assigned validation rules, including being notNull, if set.

Parameters:

defaultValue -

Returns:

notNull

public B notNull()

If set, 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.

Returns:

desc

public B desc(String shortDesc)

Same as description

Parameters:

shortDesc -

Returns:

description

public B description(String desc)

validation

public B validation(Validator<T> validator)

Adds a validation to the list of validators,

Parameters:

validator -

Returns:

validations

public B validations(List<Validator<T>> validators)

Adds a list of Validators to the list of validators being built.

Parameters:

validators -

Returns:

aliasIn

public B aliasIn(String name)

Adds an alternate name for this property that will be recognized when a Loader reads a property in from a source, such as JNDI or a properties file. If the alias name already exists, it will add 'in-ness' to it. Alias names cannot be null, contain whitespace, or these characters: ;/?:@=&"<>>#%{}|\^~[]`

Parameters:

name -

Returns:

A builder for chaining build calls

aliasOut

public B aliasOut(String name)

Adds an alternate name for this property that can be used if this property is exported, such as exporting to System.properties. If the alias name already exists, it will add 'out-ness' to it. Alias names cannot be null, contain whitespace, or these characters: ;/?:@=&"<>#%{}|\^~[]`

Parameters:

name -

Returns:

A builder for chaining build calls

aliasInAndOut

public B aliasInAndOut(String name)

Adds an alternate name for this property that will both be recognized when reading in properties and can be used when exporting properties. If the alias name already exists, it will add 'in' and 'out' to it. Alias names cannot be null, contain whitespace, or these characters: ;/?:@=&"<>#%{}|\^~[]`

Parameters:

name -

Returns:

A builder for chaining build calls

addAlias

protected void addAlias(Name newAlias,
                        List<Name> addToList)

Used by public alias methods to actually add the Alias. This method checks to see if the alias already exists and consolidates aliases of the same name, ORing their in/out settings. The result is that if two aliases are added with the same name, one in and one out, there will be a single alias that is both in and out.

Parameters:

newAlias - New alias to add

addToList - The list to add to

helpText

public B helpText(String helpText)

build

public abstract P build()

Build the Property instance.

Returns: