com.helger.jcodemodel

Class JEnumConstant

java.lang.Object

com.helger.jcodemodel.AbstractJExpressionImpl

com.helger.jcodemodel.JEnumConstant

All Implemented Interfaces:

IJAnnotatable, IJDeclaration, IJDocCommentable, IJExpression, IJGenerable

public class JEnumConstant
extends AbstractJExpressionImpl
implements IJDeclaration, IJAnnotatable, IJDocCommentable

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

Author:

Bhakti Mehta (Bhakti.Mehta@sun.com)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JEnumConstant(AbstractJClass aType, String sName)

Method Summary

Methods

Modifier and Type	Method and Description
JAnnotationUse	annotate(AbstractJClass clazz) Adds an annotation to this variable.
JAnnotationUse	annotate(Class<? extends Annotation> clazz) Adds an annotation to this variable.
<W extends IJAnnotationWriter<?>> 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() IJAnnotatable.annotations()
JEnumConstant	arg(IJExpression aArg) Add an expression to this constructor's argument list
List<IJExpression>	args()
void	declare(JFormatter f)
boolean	equals(Object o)
void	generate(JFormatter f)
String	getName() Returns the name of this constant including the type name
boolean	hasArgs()
int	hashCode()
JDocComment	javadoc() Creates, if necessary, and returns the enum constant javadoc.
String	name()
AbstractJClass	type()

Methods inherited from class com.helger.jcodemodel.AbstractJExpressionImpl

_instanceof, band, bor, cand, complement, component, component, component0, cor, decr, div, div, div, div, div, eq, eq0, eqNull, gt, gt0, gte, gte0, incr, invoke, invoke, lt, lt0, lte, lte0, minus, minus, minus, minus, minus, minus, mod, mul, mul, mul, mul, mul, ne, ne0, neNull, not, plus, plus, plus, plus, plus, plus, predecr, preincr, ref, ref, shl, shl, shr, shr, shrz, shrz, xor

Methods inherited from class java.lang.Object

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

Constructor Detail

JEnumConstant

protected JEnumConstant(@Nonnull
             AbstractJClass aType,
             @Nonnull
             String sName)

Method Detail

type

@Nonnull
public AbstractJClass type()

name

@Nonnull
public String name()

Returns:

The plain name of the enum constant, without any type prefix

arg

@Nonnull
public JEnumConstant arg(@Nonnull
                        IJExpression aArg)

Add an expression to this constructor's argument list

Parameters:

aArg - Argument to add to argument list

Returns:

this for chaining

args

@Nonnull
public List<IJExpression> args()

hasArgs

public boolean hasArgs()

getName

@Nonnull
public String getName()

Returns the name of this constant including the type name

Returns:

never null.

javadoc

@Nonnull
public JDocComment javadoc()

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

Specified by:

javadoc in interface IJDocCommentable

Returns:

JDocComment containing javadocs for this constant.

annotate

@Nonnull
public JAnnotationUse annotate(@Nonnull
                              AbstractJClass clazz)

Adds an annotation to this variable.

Specified by:

annotate in interface IJAnnotatable

Parameters:

clazz - The annotation class to annotate the field with

Returns:

Newly created JAnnotationUse

annotate

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

Adds an annotation to this variable.

Specified by:

annotate in interface IJAnnotatable

Parameters:

clazz - The annotation class to annotate the field with

Returns:

Newly created JAnnotationUse

annotate2

@Nonnull
public <W extends IJAnnotationWriter<?>> W annotate2(@Nonnull
                                                    Class<W> clazz)

Description copied from interface: IJAnnotatable

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 IJAnnotatable

Type Parameters:

W - Implementation type

Parameters:

clazz - Source class

Returns:

Instance of the source class

annotations

@Nonnull
public Collection<JAnnotationUse> annotations()

IJAnnotatable.annotations()

Specified by:

annotations in interface IJAnnotatable

Returns:

Can be empty but never null.

declare

public void declare(@Nonnull
           JFormatter f)

Specified by:

declare in interface IJDeclaration

generate

public void generate(@Nonnull
            JFormatter f)

Specified by:

generate in interface IJGenerable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object