net.morimekta.providence.reflect.contained

Class CStructDescriptor

java.lang.Object

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

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

net.morimekta.providence.descriptor.PStructDescriptor<CStruct,CField>

net.morimekta.providence.reflect.contained.CStructDescriptor

All Implemented Interfaces:

PDescriptor, CAnnotatedDescriptor, CMessageDescriptor, JsonCompactibleDescriptor

public class CStructDescriptor
extends PStructDescriptor<CStruct,CField>
implements CMessageDescriptor, JsonCompactibleDescriptor

Since:

07.09.15

Author:

Stein Eldar Johnsen

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_COMPACT_FIELDS

Constructor Summary

Constructors

Constructor and Description
CStructDescriptor(String comment, String packageName, String name, List<CField> fields, 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.
CField	getField(int key)
CField	getField(String name)
CField[]	getFields()
boolean	hasAnnotation(String name) Get the given annotation value.
boolean	isJsonCompactible()
boolean	isSimple()

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

getVariant

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

builder, equals, getFactoryInternal, getType, hashCode

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

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.CAnnotatedDescriptor

getAnnotationValue, hasAnnotation

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

getName, getProgramName, getQualifiedName, getQualifiedName, getType

Field Detail

MAX_COMPACT_FIELDS

public static final int MAX_COMPACT_FIELDS

See Also:

Constant Field Values

Constructor Detail

CStructDescriptor

public CStructDescriptor(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<CStruct,CField>

getField

public CField getField(String name)

Specified by:

getField in interface CMessageDescriptor

Specified by:

getField in class PMessageDescriptor<CStruct,CField>

getField

public CField getField(int key)

Specified by:

getField in interface CMessageDescriptor

Specified by:

getField in class PMessageDescriptor<CStruct,CField>

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.

isSimple

public boolean isSimple()

Overrides:

isSimple in class PMessageDescriptor<CStruct,CField>

isJsonCompactible

public boolean isJsonCompactible()

Specified by:

isJsonCompactible in interface JsonCompactibleDescriptor