org.apache.directory.server.config

Annotation Type ConfigurationElement

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

An annotation used to specify that the qualified field is configuration element.

Author:

Apache Directory Project

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	attributeType Returns the attribute type.
String	container Returns the string value of the Dn of the container.
String	defaultValue Returns the string value of the default value.
String[]	defaultValues Returns the list of string values that are the default values when the element is multi-valued.
boolean	isOptional Returns true if the qualified field is optional.
boolean	isRdn Returns true if of the qualified field (attribute type and value) is the Rdn of the entry.
String	objectClass Returns the object class.

Element Detail

attributeType

public abstract String attributeType

Returns the attribute type.

Returns:

the attribute type

Default:

""

objectClass

public abstract String objectClass

Returns the object class.

Returns:

the object class

Default:

""

isRdn

public abstract boolean isRdn

Returns true if of the qualified field (attribute type and value) is the Rdn of the entry.

Returns:

true if of the qualified field (attribute type and value) is the Rdn of the entry, false if not.

Default:

false

container

public abstract String container

Returns the string value of the Dn of the container.

Returns:

the string value of the Dn of the container.

Default:

""

isOptional

public abstract boolean isOptional

Returns true if the qualified field is optional.

Returns:

true if the qualified field is optional, false if not.

Default:

false

defaultValue

public abstract String defaultValue

Returns the string value of the default value.

Returns:

the string value of the default value

Default:

""

defaultValues

public abstract String[] defaultValues

Returns the list of string values that are the default values when the element is multi-valued.

Returns:

The default values

Default:

{}