net.morimekta.providence.reflect.contained

Class CEnumDescriptor

java.lang.Object

net.morimekta.providence.descriptor.PDeclaredDescriptor<T>

net.morimekta.providence.descriptor.PEnumDescriptor<CEnum>

net.morimekta.providence.reflect.contained.CEnumDescriptor

All Implemented Interfaces:

PDescriptor, CAnnotatedDescriptor

public class CEnumDescriptor
extends PEnumDescriptor<CEnum>
implements CAnnotatedDescriptor

Contained enum descriptor type.

Also see CEnum.

Field Summary

Fields inherited from class net.morimekta.providence.descriptor.PEnumDescriptor

DEFAULT_FIRST_VALUE

Constructor Summary

Constructors

Constructor and Description
CEnumDescriptor(String comment, String packageName, String name, Map<String,String> annotations)

Method Summary

Modifier and Type	Method and Description
Set<String>	getAnnotations() Get set of available annotations.
String	getAnnotationValue(String name) Get the given annotation value.
String	getComment() The type comment is the last block of comment written before the type declaration.
CEnum	getValueById(int id)
CEnum	getValueByName(String name)
CEnum[]	getValues()
boolean	hasAnnotation(String name) Get the given annotation value.
void	setValues(List<CEnum> values)

Methods inherited from class net.morimekta.providence.descriptor.PEnumDescriptor

builder, equals, getFactoryInternal, getType, toString

Methods inherited from class net.morimekta.providence.descriptor.PDeclaredDescriptor

getName, getPackageName, getQualifiedName

Methods inherited from class java.lang.Object

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

Constructor Detail

CEnumDescriptor

public CEnumDescriptor(String comment,
                       String packageName,
                       String name,
                       Map<String,String> annotations)

Method Detail

setValues

public void setValues(List<CEnum> values)

getComment

public final String getComment()

Description copied from interface: CAnnotatedDescriptor

The type comment is the last block of comment written before the type declaration. Comments on the same line, after the declaration is ignored.

Specified by:

getComment in interface CAnnotatedDescriptor

Returns:

The comment string containing all formatting (not including the comment delimiter and the leading space.

getValues

public CEnum[] getValues()

Specified by:

getValues in class PEnumDescriptor<CEnum>

getValueById

public CEnum getValueById(int id)

Specified by:

getValueById in class PEnumDescriptor<CEnum>

getValueByName

public CEnum getValueByName(String name)

Specified by:

getValueByName in class PEnumDescriptor<CEnum>

getAnnotations

public Set<String> getAnnotations()

Description copied from interface: CAnnotatedDescriptor

Get set of available annotations.

Specified by:

getAnnotations in interface CAnnotatedDescriptor

Returns:

hasAnnotation

public boolean hasAnnotation(String name)

Description copied from interface: CAnnotatedDescriptor

Get the given annotation value.

Specified by:

hasAnnotation in interface CAnnotatedDescriptor

Parameters:

name - Name of annotation.

Returns:

If the annotation is present.

getAnnotationValue

public String getAnnotationValue(String name)

Description copied from interface: CAnnotatedDescriptor

Get the given annotation value.

Specified by:

getAnnotationValue in interface CAnnotatedDescriptor

Parameters:

name - Name of annotation.

Returns:

The annotation value.