org.dcm4che3.conf.core.api

Annotation Type ConfigurableProperty

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface ConfigurableProperty

Marks a field of a configuration class to be a persistable configuration property of the bean

Author:

Roman K

Field Summary

Fields

Modifier and Type	Fields and Description
static String	NO_DEFAULT_VALUE Just a random string very unlikely to be equal to any user-specified default string (java does not allow to use null...)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	collectionOfReferences Deprecated.
String	defaultValue Default for primitives (int, string, boolean, enum).
String	description Description to show in configuration UIs.
ConfigurableProperty.EnumRepresentation	enumRepresentation
String	group Name of the group in the GUI this property belongs to
boolean	isExtensionsProperty Deprecated.
boolean	isReference Deprecated.
String	label Label to show in configuration UIs.
String	name Name of the node.
int	order Ordering of properties for GUI.
boolean	required Is the property required to be set, i.e.
ConfigurableProperty.Tag[]	tags Additional info for the GUI
ConfigurableProperty.ConfigurablePropertyType	type Defines special behavior for the property
boolean	weakReference Only affects behavior for references.

Field Detail

NO_DEFAULT_VALUE

public static final String NO_DEFAULT_VALUE

Just a random string very unlikely to be equal to any user-specified default string (java does not allow to use null...)

Element Detail

name

public abstract String name

Name of the node. If not specified, the field/parameter name is used.

Returns:

Default:

""

defaultValue

public abstract String defaultValue

Default for primitives (int, string, boolean, enum). If default is not specified, the property is considered required.

Returns:

Default:

" $#!@@#$@!#$% Default-value-does-not-exist-for-this-property $#!@@#$@!#$%"

required

public abstract boolean required

Is the property required to be set, i.e. must be non-null for objects, non-empty for Strings

Returns:

Default:

false

enumRepresentation

public abstract ConfigurableProperty.EnumRepresentation enumRepresentation

Default:

org.dcm4che3.conf.core.api.ConfigurableProperty.EnumRepresentation.STRING

type

public abstract ConfigurableProperty.ConfigurablePropertyType type

Defines special behavior for the property

Default:

org.dcm4che3.conf.core.api.ConfigurableProperty.ConfigurablePropertyType.Basic

weakReference

public abstract boolean weakReference

Only affects behavior for references. Indicates that the frameworks should not prevent removal of the target of this reference from the configuration. For a reference for which it was detected that the target does not exist anymore, the value gets automatically removed on occasion, i.e. will be set to 'null'

Returns:

Default:

false

label

public abstract String label

Label to show in configuration UIs. If empty empty string (default), the name will be used.

Returns:

Default:

""

description

public abstract String description

Description to show in configuration UIs.

Returns:

Default:

""

order

public abstract int order

Ordering of properties for GUI. The larger the number, the lower in the list the property will be displayed.

Returns:

Default:

0

group

public abstract String group

Name of the group in the GUI this property belongs to

Default:

"Other"

tags

public abstract ConfigurableProperty.Tag[] tags

Additional info for the GUI

Returns:

Default:

{}

isReference

@Deprecated
public abstract boolean isReference

Deprecated.

Default:

false

collectionOfReferences

@Deprecated
public abstract boolean collectionOfReferences

Deprecated.

Default:

false

isExtensionsProperty

@Deprecated
public abstract boolean isExtensionsProperty

Deprecated.

Default:

false