org.apache.pulsar.common.configuration

Annotation Type FieldContext

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

Stores field context to validate based on requirement or value constraints.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	category Category to group settings.
boolean	deprecated Whether the setting is deprecated or not.
String	doc Documentation of the settings.
boolean	dynamic allow field to be updated dynamically.
int	maxCharLength binds character length of text.
long	maxValue binds numeric value's upper bound.
long	minValue binds numeric value's lower bound.
boolean	required checks field value is required.

Element Detail

required

public abstract boolean required

checks field value is required. By default field is mandatory false.

Returns:

true if attribute is required else returns false

Default:

false

minValue

public abstract long minValue

binds numeric value's lower bound.

Returns:

minimum value of the field

Default:

-9223372036854775808L

maxValue

public abstract long maxValue

binds numeric value's upper bound.

Returns:

maximum value of the field

Default:

9223372036854775807L

maxCharLength

public abstract int maxCharLength

binds character length of text.

Returns:

character length of field

Default:

2147483647

dynamic

public abstract boolean dynamic

allow field to be updated dynamically.

Returns:

Default:

false

category

public abstract String category

Category to group settings.

Returns:

category name

Default:

""

doc

public abstract String doc

Documentation of the settings.

Returns:

the documentation of the settings.

Default:

""

deprecated

public abstract boolean deprecated

Whether the setting is deprecated or not.

Returns:

true if the setting is deprecated, otherwise false.

Default:

false