org.microbean.settings

Class Setting.Literal

java.lang.Object

javax.enterprise.util.AnnotationLiteral<Setting>

org.microbean.settings.Setting.Literal

All Implemented Interfaces:

Serializable, Annotation, Setting

Enclosing class:

Setting

public static final class Setting.Literal
extends AnnotationLiteral<Setting>
implements Setting

An AnnotationLiteral that implements the Setting interface/annotation.

Author:

Laird Nelson

See Also:

Setting, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.microbean.settings.Setting

Setting.Literal

Field Summary

Fields inherited from interface org.microbean.settings.Setting

UNSET

Constructor Summary

Constructors

Constructor and Description
Literal(String name, String defaultValue, boolean required) Creates a new Setting.Literal.

Method Summary

Modifier and Type	Method and Description
String	defaultValue() The default value for the setting.
String	name() The setting name.
boolean	required() Whether a value for the setting must be present; it is illegal to set this to true and set the defaultValue element to a value other than Setting.UNSET

Methods inherited from class javax.enterprise.util.AnnotationLiteral

annotationType, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.annotation.Annotation

annotationType, equals, hashCode, toString

Constructor Detail

Literal

public Literal(String name,
               String defaultValue,
               boolean required)

Creates a new Setting.Literal.

Parameters:

name - the value for the name element; may be null in which case Setting.UNSET will be used instead

defaultValue - the value for the defaultValue element; may be null in which case Setting.UNSET will be used instead

required - the value for the required element

Method Detail

name

public final String name()

The setting name.

Returns:

the setting name; never null but possibly Setting.UNSET

defaultValue

public final String defaultValue()

The default value for the setting.

Returns:

the default value; never null but possibly Setting.UNSET

required

public final boolean required()

Whether a value for the setting must be present; it is illegal to set this to true and set the defaultValue element to a value other than Setting.UNSET

Returns:

whether a value for the setting must be present