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

Enum Class CodeBuilder.StandardMethod

java.lang.Object

java.lang.Enum<CodeBuilder.StandardMethod>

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

All Implemented Interfaces:

Serializable, Comparable<CodeBuilder.StandardMethod>, 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.StandardMethod
extends Enum<CodeBuilder.StandardMethod>

The standard methods.

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.StandardMethod"

⁠

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_METHOD_AddListener	The method to add listeners.
STD_METHOD_GetMessagePrefix	The method that returns the message prefix.
STD_METHOD_GetRessourceBundle	The method that returns the ressource bundle for the messages.
STD_METHOD_InitData	The method that provides initialisation data.
STD_METHOD_RemoveListener	The method to remove listeners.
STD_METHOD_ToString	The Object.toString() method.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	m_MethodName	The method name.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StandardMethod(String methodName)	Creates a new StandardMethod instance.

Method Summary

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

@API(status=MAINTAINED,
     since="0.2.0")
public static final CodeBuilder.StandardMethod STD_METHOD_AddListener

The method to add listeners.

STD_METHOD_GetMessagePrefix

@API(status=MAINTAINED,
     since="0.2.0")
public static final CodeBuilder.StandardMethod STD_METHOD_GetMessagePrefix

The method that returns the message prefix.

STD_METHOD_GetRessourceBundle

@API(status=MAINTAINED,
     since="0.2.0")
public static final CodeBuilder.StandardMethod STD_METHOD_GetRessourceBundle

The method that returns the ressource bundle for the messages.

STD_METHOD_InitData

@API(status=MAINTAINED,
     since="0.2.0")
public static final CodeBuilder.StandardMethod STD_METHOD_InitData

The method that provides initialisation data.

STD_METHOD_RemoveListener

@API(status=MAINTAINED,
     since="0.2.0")
public static final CodeBuilder.StandardMethod STD_METHOD_RemoveListener

The method to remove listeners.

STD_METHOD_ToString

@API(status=MAINTAINED,
     since="0.2.0")
public static final CodeBuilder.StandardMethod STD_METHOD_ToString

The Object.toString() method.

Field Details

m_MethodName

private final String m_MethodName

The method name.

Constructor Details

StandardMethod

private StandardMethod(String methodName)

Creates a new StandardMethod instance.

Parameters:

methodName - The method name.

Method Details

values

public static CodeBuilder.StandardMethod[] 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.StandardMethod 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 method name for this standard method, as it is used in the generated code.

Overrides:

toString in class Enum<CodeBuilder.StandardMethod>

Returns:

The method name.