net.morimekta.providence.reflect.contained

Class CEnumDescriptor

java.lang.Object

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

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

net.morimekta.providence.reflect.contained.CEnumDescriptor

All Implemented Interfaces:

PDescriptor, CAnnotatedDescriptor

public class CEnumDescriptor
extends PEnumDescriptor<CEnumValue>
implements CAnnotatedDescriptor

Contained enum descriptor type.

Also see CEnumValue.

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	getDocumentation() The type comment is the last block of comment written before the type declaration.
CEnumValue	getValueById(int id)
CEnumValue	getValueByName(String name)
CEnumValue[]	getValues()
boolean	hasAnnotation(String name) Get the given annotation value.
void	setValues(List<CEnumValue> values)

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

builder, equals, getFactoryInternal, getType, hashCode, toString

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

getDefaultValue, getName, getProgramName, getQualifiedName

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.morimekta.providence.reflect.contained.CAnnotatedDescriptor

getAnnotationValue, hasAnnotation

Methods inherited from interface net.morimekta.providence.descriptor.PDescriptor

getQualifiedName

Constructor Detail

CEnumDescriptor

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

Method Detail

setValues

public void setValues(@Nonnull
                      List<CEnumValue> values)

getDocumentation

public final String getDocumentation()

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:

getDocumentation in interface CAnnotatedDescriptor

Returns:

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

getValues

@Nonnull
public CEnumValue[] getValues()

Specified by:

getValues in class PEnumDescriptor<CEnumValue>

getValueById

public CEnumValue getValueById(int id)

Specified by:

getValueById in class PEnumDescriptor<CEnumValue>

getValueByName

public CEnumValue getValueByName(String name)

Specified by:

getValueByName in class PEnumDescriptor<CEnumValue>

getAnnotations

@Nonnull
public Set<String> getAnnotations()

Description copied from interface: CAnnotatedDescriptor

Get set of available annotations.

Specified by:

getAnnotations in interface CAnnotatedDescriptor

Returns:

The annotation set.

hasAnnotation

public boolean hasAnnotation(@Nonnull
                             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(@Nonnull
                                 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 or null.