net.morimekta.providence.reflect.contained

Class CUnionDescriptor

java.lang.Object

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

net.morimekta.providence.descriptor.PMessageDescriptor<T,F>

net.morimekta.providence.descriptor.PUnionDescriptor<CUnion,CField>

net.morimekta.providence.reflect.contained.CUnionDescriptor

All Implemented Interfaces:

PDescriptor, CAnnotatedDescriptor, CMessageDescriptor

public class CUnionDescriptor
extends PUnionDescriptor<CUnion,CField>
implements CMessageDescriptor

Since:

07.09.15

Author:

Stein Eldar Johnsen

Constructor Summary

Constructors

Constructor and Description
CUnionDescriptor(String comment, String packageName, String name, List<CField> fields, Map<String,String> annotations)

Method Summary

Modifier and Type	Method and Description
CUnion.Builder	builder()
CField	findFieldById(int id)
CField	findFieldByName(String name)
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.
CField[]	getFields()
boolean	hasAnnotation(String name) Get the given annotation value.
boolean	isSimple()

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

getVariant

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

equals, fieldForId, fieldForName, getBuilderSupplier, getField, getField, getType, hashCode

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

getDefaultValue, getName, getProgramName, getQualifiedName, toString

Methods inherited from class java.lang.Object

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

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

fieldForId, fieldForName, getVariant

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

getAnnotationValue, hasAnnotation

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

getDefaultValue, getName, getProgramName, getQualifiedName, getQualifiedName, getType

Constructor Detail

CUnionDescriptor

public CUnionDescriptor(String comment,
                        String packageName,
                        String name,
                        List<CField> fields,
                        Map<String,String> annotations)

Method Detail

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.

getFields

@Nonnull
public CField[] getFields()

Specified by:

getFields in interface CMessageDescriptor

Specified by:

getFields in class PMessageDescriptor<CUnion,CField>

findFieldByName

public CField findFieldByName(String name)

Specified by:

findFieldByName in interface CMessageDescriptor

Specified by:

findFieldByName in class PMessageDescriptor<CUnion,CField>

findFieldById

public CField findFieldById(int id)

Specified by:

findFieldById in interface CMessageDescriptor

Specified by:

findFieldById in class PMessageDescriptor<CUnion,CField>

isSimple

public boolean isSimple()

Specified by:

isSimple in interface CMessageDescriptor

Overrides:

isSimple in class PMessageDescriptor<CUnion,CField>

Returns:

True if the message is simple. A simple message contains no containers, and no sub-messages.

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.

builder

@Nonnull
public CUnion.Builder builder()

Overrides:

builder in class PMessageDescriptor<CUnion,CField>