org.dcm4che3.conf.api.generic

Annotation Type ConfigField

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

Marks a field of a configuration class as a configuration field, meaning that it will be persisted. If a field of a config class is not annotated, it will be skipped and NOT persisted.

Author:

Roman K

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Name in configuration

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	def Default value
String	defaultKey Deprecated.
String	delimeter Deprecated.
String	mapElementObjectClass What to use for LDAP collection elements as object class if the value class is not a composite ConfigClass'ed type
String	mapKey What is used as a map key, e.g.
String	mapName Maps support non-ConfigClass'ed value types as well.

Element Detail

name

public abstract String name

Name in configuration

Returns:

def

public abstract String def

Default value

Returns:

Default:

"N/A"

mapKey

public abstract String mapKey

What is used as a map key, e.g. which names ldap nodes have like if a key is 'name', then nodes are name=registry, name=repository

Returns:

Default:

"cn"

mapElementObjectClass

public abstract String mapElementObjectClass

What to use for LDAP collection elements as object class if the value class is not a composite ConfigClass'ed type

Returns:

Default:

""

mapName

public abstract String mapName

Maps support non-ConfigClass'ed value types as well. As an attribute name in child nodes, name() will be used. If you need a different name for the collection node itself in this case, use this parameter.

Default:

"N/A"

delimeter

@Deprecated
public abstract String delimeter

Deprecated.

For Maps. Which delimeter is used to separate key from value.

Returns:

Default:

"|"

defaultKey

@Deprecated
public abstract String defaultKey

Deprecated.

For Maps. Which key to use if only value is provided.

Returns:

Default:

"*"