Package org.tquadrat.foundation.config.ap.impl

Enum Class CodeBuilder.StandardField

java.lang.Object

java.lang.Enum<CodeBuilder.StandardField>

org.tquadrat.foundation.config.ap.impl.CodeBuilder.StandardField

All Implemented Interfaces:

Serializable, Comparable<CodeBuilder.StandardField>, Constable

Enclosing interface:

CodeBuilder

@ClassVersion(sourceVersion="$Id: CodeBuilder.java 1085 2024-01-05 16:23:28Z tquadrat $")
@API(status=MAINTAINED,
     since="0.2.0")
public static enum CodeBuilder.StandardField
extends Enum<CodeBuilder.StandardField>

The standard fields.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: CodeBuilder.java 1085 2024-01-05 16:23:28Z tquadrat $

Since:

0.2.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.ap.impl.CodeBuilder.StandardField"

⁠

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
STD_FIELD_Accessors	The registry for the preferences accessors.
STD_FIELD_CLIDefinitions	The CLI definitions.
STD_FIELD_CLIError	The CLI error.
STD_FIELD_INIFile	The INIFile instance.
STD_FIELD_INIFileName	The file name for the INIFile.
STD_FIELD_ListenerSupport	The listener support.
STD_FIELD_PreferenceChangeListener	The listener for preference changes.
STD_FIELD_PreferencesRoot	The preferences root.
STD_FIELD_ReadLock	The read lock.
STD_FIELD_Registry	The registry for the properties when the Map interface needs to be implemented.
STD_FIELD_ResourceBundle	The current ResourceBundle.
STD_FIELD_ResourceLocale	The Locale for the current resource bundle.
STD_FIELD_UserPreferences	The user preferences.
STD_FIELD_WriteLock	The "write" lock.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	m_FieldName	The field name.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StandardField(String fieldName)	Creates a new StandardField instance.

Method Summary

Modifier and Type	Method	Description
final String	toString()	Returns the field name for this standard field, as it is used in the generated code.
static CodeBuilder.StandardField	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CodeBuilder.StandardField[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STD_FIELD_Accessors

@API(status=MAINTAINED,
     since="0.0.1")
public static final CodeBuilder.StandardField STD_FIELD_Accessors

The registry for the preferences accessors.

STD_FIELD_CLIDefinitions

@API(status=MAINTAINED,
     since="0.0.1")
public static final CodeBuilder.StandardField STD_FIELD_CLIDefinitions

The CLI definitions.

STD_FIELD_CLIError

@API(status=MAINTAINED,
     since="0.0.1")
public static final CodeBuilder.StandardField STD_FIELD_CLIError

The CLI error.

STD_FIELD_INIFile

@API(status=MAINTAINED,
     since="0.1.0")
public static final CodeBuilder.StandardField STD_FIELD_INIFile

The INIFile instance.

STD_FIELD_INIFileName

@API(status=MAINTAINED,
     since="0.1.0")
public static final CodeBuilder.StandardField STD_FIELD_INIFileName

The file name for the INIFile.

STD_FIELD_ListenerSupport

@API(status=MAINTAINED,
     since="0.0.1")
public static final CodeBuilder.StandardField STD_FIELD_ListenerSupport

The listener support.

STD_FIELD_PreferenceChangeListener

@API(status=MAINTAINED,
     since="0.1.0")
public static final CodeBuilder.StandardField STD_FIELD_PreferenceChangeListener

The listener for preference changes.

STD_FIELD_PreferencesRoot

@API(status=MAINTAINED,
     since="0.0.1")
public static final CodeBuilder.StandardField STD_FIELD_PreferencesRoot

The preferences root.

STD_FIELD_ReadLock

@API(status=MAINTAINED,
     since="0.0.1")
public static final CodeBuilder.StandardField STD_FIELD_ReadLock

The read lock.

STD_FIELD_Registry

@API(status=MAINTAINED,
     since="0.0.1")
public static final CodeBuilder.StandardField STD_FIELD_Registry

The registry for the properties when the Map interface needs to be implemented.

STD_FIELD_ResourceLocale

@API(status=MAINTAINED,
     since="0.0.2")
public static final CodeBuilder.StandardField STD_FIELD_ResourceLocale

The Locale for the current resource bundle.

STD_FIELD_ResourceBundle

@API(status=MAINTAINED,
     since="0.0.2")
public static final CodeBuilder.StandardField STD_FIELD_ResourceBundle

The current ResourceBundle.

STD_FIELD_UserPreferences

@API(status=MAINTAINED,
     since="0.0.1")
public static final CodeBuilder.StandardField STD_FIELD_UserPreferences

The user preferences.

STD_FIELD_WriteLock

@API(status=MAINTAINED,
     since="0.0.1")
public static final CodeBuilder.StandardField STD_FIELD_WriteLock

The "write" lock.

Field Details

m_FieldName

private final String m_FieldName

The field name.

Constructor Details

StandardField

private StandardField(String fieldName)

Creates a new StandardField instance.

Parameters:

fieldName - The field name.

Method Details

values

public static CodeBuilder.StandardField[] 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 CodeBuilder.StandardField 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

toString

public final String toString()

Returns the field name for this standard field, as it is used in the generated code.

Overrides:

toString in class Enum<CodeBuilder.StandardField>

Returns:

The field name.