Package org.tquadrat.foundation.config.ap

Enum Class PropertySpec.PropertyFlag

java.lang.Object

java.lang.Enum<PropertySpec.PropertyFlag>

org.tquadrat.foundation.config.ap.PropertySpec.PropertyFlag

All Implemented Interfaces:

Serializable, Comparable<PropertySpec.PropertyFlag>, Constable

Enclosing interface:

PropertySpec

@ClassVersion(sourceVersion="$Id: PropertySpec.java 1105 2024-02-28 12:58:46Z tquadrat $")
@API(status=MAINTAINED,
     since="0.1.0")
public static enum PropertySpec.PropertyFlag
extends Enum<PropertySpec.PropertyFlag>

The flags for a property.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: PropertySpec.java 1105 2024-02-28 12:58:46Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.ap.PropertySpec.PropertyFlag"

⁠

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOWS_INIFILE	Indicates that this property can be initialised from and persisted to an INIFile.
ALLOWS_PREFERENCES	Indicates that this property can be initialised from and persisted to a preference.
ELEMENTTYPE_IS_ENUM	Indicates that the element type of a collection is an enum type.
ENVIRONMENT_VARIABLE	Indicates that this property is initialised from the value of an environment variable.
EXEMPT_FROM_MAP	Indicates that this property will not be part of the map, in case the configuration bean implements Map.
EXEMPT_FROM_TOSTRING	Indicates that this property will not appear in the return value of Enum.toString().
GETTER_IS_DEFAULT	Indicates that the getter method for this property is default.
GETTER_ON_MAP	Indicates that the implementation of Map will refer to the getter for this property, instead of the field.
GETTER_RETURNS_OPTIONAL	Indicates that the getter method returns an instance of Optional holding the configuration value.
PROPERTY_CLI_MANDATORY	Indicates that a value for this property is required on the command line.
PROPERTY_CLI_MULTIVALUED	Indicates that it is possible to provide multiple values for this property on the command line.
PROPERTY_IS_ARGUMENT	Indicates that the property can be initialised with a command line argument.
PROPERTY_IS_MUTABLE	Indicates that the property value can be modified.
PROPERTY_IS_OPTION	Indicates that the property can be initialised with a command line option.
PROPERTY_IS_SPECIAL	Indicates that the property is a 'special' property.
PROPERTY_REQUIRES_SYNCHRONIZATION	Indicates that the access to the property requires synchronisation.
SETTER_CHECK_EMPTY	Indicates that the setter method for this property should check for an empty argument.
SETTER_CHECK_NULL	Indicates that the setter method for this property should check for a null argument.
SETTER_IS_DEFAULT	Indicates that the setter method for this property is default; this means that the method will not be implemented, and that there is no field for the property.
SYSTEM_PREFERENCE	Indicates that this property is initialised from the value of a system preference.
SYSTEM_PROPERTY	Indicates that this property is initialised from the value of a system property.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PropertyFlag()

Method Summary

Modifier and Type	Method	Description
static PropertySpec.PropertyFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PropertySpec.PropertyFlag[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALLOWS_INIFILE

public static final PropertySpec.PropertyFlag ALLOWS_INIFILE

Indicates that this property can be initialised from and persisted to an INIFile. This also means that the methods PropertySpec.getINIGroup() and PropertySpec.getINIKey() may not return empty.

ALLOWS_PREFERENCES

public static final PropertySpec.PropertyFlag ALLOWS_PREFERENCES

Indicates that this property can be initialised from and persisted to a preference. This also means that the methods PropertySpec.getPrefsAccessorClass() and PropertySpec.getPrefsKey() may not return empty.

ELEMENTTYPE_IS_ENUM

public static final PropertySpec.PropertyFlag ELEMENTTYPE_IS_ENUM

Indicates that the element type of a collection is an enum type. Obviously this is only relevant if the property is a collection.

See Also:

• PropertySpec.getCollectionKind()
• CollectionKind.SET
• CollectionKind.LIST

ENVIRONMENT_VARIABLE

public static final PropertySpec.PropertyFlag ENVIRONMENT_VARIABLE

Indicates that this property is initialised from the value of an environment variable. The method PropertySpec.getEnvironmentVariableName() may not return empty.

See Also:

• System.getenv()

EXEMPT_FROM_MAP

public static final PropertySpec.PropertyFlag EXEMPT_FROM_MAP

Indicates that this property will not be part of the map, in case the configuration bean implements Map.

There is no related annotation for this flag, it is used mainly for special properties.

EXEMPT_FROM_TOSTRING

public static final PropertySpec.PropertyFlag EXEMPT_FROM_TOSTRING

Indicates that this property will not appear in the return value of Enum.toString().

GETTER_IS_DEFAULT

public static final PropertySpec.PropertyFlag GETTER_IS_DEFAULT

Indicates that the getter method for this property is default. This means that the method will not be implemented, and that there is no field for the property.

This flag implies EXEMPT_FROM_MAP.

GETTER_ON_MAP

public static final PropertySpec.PropertyFlag GETTER_ON_MAP

Indicates that the implementation of Map will refer to the getter for this property, instead of the field.

There is no related annotation for this flag, it is used mainly for special properties.

GETTER_RETURNS_OPTIONAL

public static final PropertySpec.PropertyFlag GETTER_RETURNS_OPTIONAL

Indicates that the getter method returns an instance of Optional holding the configuration value.

PROPERTY_CLI_MANDATORY

public static final PropertySpec.PropertyFlag PROPERTY_CLI_MANDATORY

Indicates that a value for this property is required on the command line.

PROPERTY_CLI_MULTIVALUED

public static final PropertySpec.PropertyFlag PROPERTY_CLI_MULTIVALUED

Indicates that it is possible to provide multiple values for this property on the command line.

PROPERTY_IS_ARGUMENT

public static final PropertySpec.PropertyFlag PROPERTY_IS_ARGUMENT

Indicates that the property can be initialised with a command line argument.

See Also:

• PropertySpec.getCLIArgumentIndex()
• PropertySpec.getCLIValueHandlerClass()
• PropertySpec.getCLIFormat()
• PropertySpec.getCLIMetaVar()

PROPERTY_IS_MUTABLE

public static final PropertySpec.PropertyFlag PROPERTY_IS_MUTABLE

Indicates that the property value can be modified. Basically, it means that there is a setter and/or an 'add' method for that property.

PROPERTY_IS_OPTION

public static final PropertySpec.PropertyFlag PROPERTY_IS_OPTION

Indicates that the property can be initialised with a command line option.

See Also:

• PropertySpec.getCLIOptionNames()
• PropertySpec.getCLIValueHandlerClass()
• PropertySpec.getCLIFormat()
• PropertySpec.getCLIMetaVar()

PROPERTY_IS_SPECIAL

public static final PropertySpec.PropertyFlag PROPERTY_IS_SPECIAL

Indicates that the property is a 'special' property. This also means that PropertySpec.getSpecialPropertyType() will not return an empty value.

PROPERTY_REQUIRES_SYNCHRONIZATION

public static final PropertySpec.PropertyFlag PROPERTY_REQUIRES_SYNCHRONIZATION

Indicates that the access to the property requires synchronisation.

SETTER_CHECK_EMPTY

public static final PropertySpec.PropertyFlag SETTER_CHECK_EMPTY

Indicates that the setter method for this property should check for an empty argument.

SETTER_CHECK_NULL

public static final PropertySpec.PropertyFlag SETTER_CHECK_NULL

Indicates that the setter method for this property should check for a null argument.

SETTER_IS_DEFAULT

public static final PropertySpec.PropertyFlag SETTER_IS_DEFAULT

Indicates that the setter method for this property is default; this means that the method will not be implemented, and that there is no field for the property.

SYSTEM_PREFERENCE

public static final PropertySpec.PropertyFlag SYSTEM_PREFERENCE

Indicates that this property is initialised from the value of a system preference. The methods PropertySpec.getSystemPrefsPath(), PropertySpec.getPrefsKey() and PropertySpec.getPrefsAccessorClass() may not return empty.

SYSTEM_PROPERTY

public static final PropertySpec.PropertyFlag SYSTEM_PROPERTY

Indicates that this property is initialised from the value of a system property. The method PropertySpec.getSystemPropertyName() may not return empty.

See Also:

• System.getProperties()

Constructor Details

PropertyFlag

private PropertyFlag()

Method Details

values

public static PropertySpec.PropertyFlag[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PropertySpec.PropertyFlag valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null