net.morimekta.providence.reflect.contained

Class CStructDescriptor

java.lang.Object

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

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

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

net.morimekta.providence.reflect.contained.CStructDescriptor

All Implemented Interfaces:

Type, net.morimekta.providence.descriptor.PDescriptor, CAnnotatedDescriptor, CMessageDescriptor, net.morimekta.providence.serializer.json.JsonCompactibleDescriptor

public class CStructDescriptor
extends net.morimekta.providence.descriptor.PStructDescriptor<CStruct>
implements CMessageDescriptor, net.morimekta.providence.serializer.json.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 programName, String name, List<CField<CStruct>> fields, Map<String,String> annotations, net.morimekta.providence.descriptor.PDescriptorProvider implementing)

Method Summary

Modifier and Type	Method and Description
CField<CStruct>	findFieldById(int id)
CField<CStruct>	findFieldByName(String name)
CField<CStruct>	findFieldByPojoName(String pojoName)
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<CStruct>[]	getFields()
CInterfaceDescriptor	getImplementing()
boolean	hasAnnotation(String name) Get the given annotation value.
boolean	isAutoType()
boolean	isInnerType()
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, fieldForId, fieldForName, fieldForPojoName, getBuilderSupplier, getType, hashCode

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

getDefaultValue, getName, getProgramName, getQualifiedName, getTypeName, 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

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 programName,
                         String name,
                         List<CField<CStruct>> fields,
                         Map<String,String> annotations,
                         net.morimekta.providence.descriptor.PDescriptorProvider implementing)

Method Detail

isInnerType

public boolean isInnerType()

Specified by:

isInnerType in class net.morimekta.providence.descriptor.PDeclaredDescriptor<CStruct>

isAutoType

public boolean isAutoType()

Specified by:

isAutoType in class net.morimekta.providence.descriptor.PDeclaredDescriptor<CStruct>

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<CStruct>[] getFields()

Specified by:

getFields in interface CMessageDescriptor

Specified by:

getFields in class net.morimekta.providence.descriptor.PMessageDescriptor<CStruct>

findFieldByName

public CField<CStruct> findFieldByName(String name)

Specified by:

findFieldByName in interface CMessageDescriptor

Specified by:

findFieldByName in class net.morimekta.providence.descriptor.PMessageDescriptor<CStruct>

findFieldByPojoName

public CField<CStruct> findFieldByPojoName(String pojoName)

Specified by:

findFieldByPojoName in class net.morimekta.providence.descriptor.PMessageDescriptor<CStruct>

findFieldById

public CField<CStruct> findFieldById(int id)

Specified by:

findFieldById in interface CMessageDescriptor

Specified by:

findFieldById in class net.morimekta.providence.descriptor.PMessageDescriptor<CStruct>

getImplementing

@Nullable
public CInterfaceDescriptor getImplementing()

Specified by:

getImplementing in interface CMessageDescriptor

Overrides:

getImplementing in class net.morimekta.providence.descriptor.PMessageDescriptor<CStruct>

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()

Specified by:

isSimple in interface CMessageDescriptor

Overrides:

isSimple in class net.morimekta.providence.descriptor.PMessageDescriptor<CStruct>

Returns:

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

isJsonCompactible

public boolean isJsonCompactible()

Specified by:

isJsonCompactible in interface net.morimekta.providence.serializer.json.JsonCompactibleDescriptor