at.chrl.nutils.configuration

Annotation Type Property

@Documented
 @Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface Property

This annotation is used to mark field that should be processed by commons.configuration.ConfigurableProcessor

This annotation is Documented, all definitions with it will appear in javadoc

Field Summary

Fields

Modifier and Type	Fields and Description
static String	DEFAULT_DESCRIPTION Default description value
static String	DEFAULT_VALUE This string shows to commons.configuration.ConfigurableProcessor that init value of the object should not be overridden.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	key Property name in configuration

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultValue Represents default value that will be parsed if key not found.
String	description Represents default value for property description.
String[]	examples Represents a array with (hopefully) working example configurations.
Class<? extends PropertyTransformer>	propertyTransformer PropertyTransformer to use.
Class<?>[]	types Represents method types for Function Transformer

Field Detail

DEFAULT_VALUE

public static final String DEFAULT_VALUE

This string shows to commons.configuration.ConfigurableProcessor that init value of the object should not be overridden.

DEFAULT_DESCRIPTION

public static final String DEFAULT_DESCRIPTION

Default description value

Element Detail

key

public abstract String key

Property name in configuration

Returns:

name of the property that will be used

propertyTransformer

public abstract Class<? extends PropertyTransformer> propertyTransformer

PropertyTransformer to use.
List of automatically transformed types:

• Boolean and boolean by BooleanTransformer
• Byte and byte by ByteTransformer
• Character and char by CharTransformer
• Short and short by ShortTransformer
• Integer and int by IntegerTransformer
• Float and float by FloatTransformer
• Long and long by LongTransformer
• Double and double by DoubleTransformer
• String by StringTransformer
• PrintStream by PrintStreamTransformer
• Enum and enum by EnumTransformer
• File by FileTransformer
• InetSocketAddress by InetSocketAddressTransformer
• Pattern by PatternTransformer

If your value is one of this types - just leave this field empty

Returns:

returns class that will be used to transform value

Default:

at.chrl.nutils.configuration.PropertyTransformer.class

defaultValue

public abstract String defaultValue

Represents default value that will be parsed if key not found. If this key equals(default) DEFAULT_VALUE initial value of the object won't be overridden

Returns:

default value of the property

Default:

"DO_NOT_OVERWRITE_INITIALIAZION_VALUE"

description

public abstract String description

Represents default value for property description. Equals DEFAULT_DESCRIPTION

Returns:

description the property

Default:

"No Description available"

examples

public abstract String[] examples

Represents a array with (hopefully) working example configurations.
if your target class is a enumeration, use

Returns:

array wiith valid examples

Default:

{}

types

public abstract Class<?>[] types

Represents method types for Function Transformer

Returns:

type arrays

See Also:

FunctionTransformer}

Default:

{}