Class JEnumConstant

java.lang.Object

com.sun.codemodel.JExpressionImpl

com.sun.codemodel.JEnumConstant

All Implemented Interfaces:

JAnnotatable, JDeclaration, JDocCommentable, JExpression, JGenerable

public final class JEnumConstant
extends JExpressionImpl
implements JDeclaration, JAnnotatable, JDocCommentable

Enum Constant. When used as an JExpression, this object represents a reference to the enum constant.

Field Summary

Fields

Modifier and Type	Field	Description
private List<JAnnotationUse>	annotations	Annotations on this variable.
private List<JExpression>	args	List of the constructor argument expressions.
private JDocComment	jdoc	javadoc comments, if any.
private final String	name	The constant.
private final JDefinedClass	type	The enum class.

Constructor Summary

Constructors

Constructor	Description
JEnumConstant(JDefinedClass type, String name)

Method Summary

Modifier and Type	Method	Description
JAnnotationUse	annotate(JClass clazz)	Adds an annotation to this variable.
JAnnotationUse	annotate(Class<? extends Annotation> clazz)	Adds an annotation to this variable.
<W extends JAnnotationWriter> W	annotate2(Class<W> clazz)	Adds an annotation to this program element and returns a type-safe writer to fill in the values of such annotations.
Collection<JAnnotationUse>	annotations()	JAnnotatable.annotations()
JEnumConstant	arg(JExpression arg)	Add an expression to this constructor's argument list
void	declare(JFormatter f)
void	generate(JFormatter f)
String	getName()	Returns the name of this constant.
JDocComment	javadoc()	Creates, if necessary, and returns the enum constant javadoc.

Methods inherited from class JExpressionImpl

_instanceof, band, bor, cand, complement, component, cor, decr, div, eq, gt, gte, incr, invoke, invoke, lt, lte, minus, minus, mod, mul, ne, not, plus, ref, ref, shl, shr, shrz, xor

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

private final String name

The constant.

type

private final JDefinedClass type

The enum class.

jdoc

private JDocComment jdoc

javadoc comments, if any.

annotations

private List<JAnnotationUse> annotations

Annotations on this variable. Lazily created.

args

private List<JExpression> args

List of the constructor argument expressions. Lazily constructed.

Constructor Details

JEnumConstant

JEnumConstant(JDefinedClass type,
 String name)

Method Details

arg

public JEnumConstant arg(JExpression arg)

Add an expression to this constructor's argument list

Parameters:

arg - Argument to add to argument list

getName

public String getName()

Returns the name of this constant.

Returns:

never null.

javadoc

public JDocComment javadoc()

Creates, if necessary, and returns the enum constant javadoc.

Specified by:

javadoc in interface JDocCommentable

Returns:

JDocComment containing javadocs for this constant.

annotate

public JAnnotationUse annotate(JClass clazz)

Adds an annotation to this variable.

Specified by:

annotate in interface JAnnotatable

Parameters:

clazz - The annotation class to annotate the field with

annotate

public JAnnotationUse annotate(Class<? extends Annotation> clazz)

Adds an annotation to this variable.

Specified by:

annotate in interface JAnnotatable

Parameters:

clazz - The annotation class to annotate the field with

annotate2

public <W extends JAnnotationWriter> W annotate2(Class<W> clazz)

Description copied from interface: JAnnotatable

Adds an annotation to this program element and returns a type-safe writer to fill in the values of such annotations.

Specified by:

annotate2 in interface JAnnotatable

annotations

public Collection<JAnnotationUse> annotations()

JAnnotatable.annotations()

Specified by:

annotations in interface JAnnotatable

Returns:

Can be empty but never null.

declare

public void declare(JFormatter f)

Specified by:

declare in interface JDeclaration

generate

public void generate(JFormatter f)

Specified by:

generate in interface JGenerable