Package 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:

java.lang.reflect.Type, PDescriptor, CAnnotatedDescriptor, CMessageDescriptor, JsonCompactibleDescriptor

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

Since:

07.09.15

Author:

Stein Eldar Johnsen

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_COMPACT_FIELDS

Constructor Summary

Constructors

Constructor	Description
CStructDescriptor(java.lang.String comment, java.lang.String programName, java.lang.String name, java.util.List<CField<CStruct>> fields, java.util.Map<java.lang.String,java.lang.String> annotations, PDescriptorProvider implementing)

Method Summary

Modifier and Type	Method	Description
CField<CStruct>	findFieldById(int id)
CField<CStruct>	findFieldByName(java.lang.String name)
CField<CStruct>	findFieldByPojoName(java.lang.String pojoName)
java.util.Set<java.lang.String>	getAnnotations()	Get set of available annotations.
java.lang.String	getAnnotationValue(java.lang.String name)	Get the given annotation value.
java.lang.String	getDocumentation()	The type comment is the last block of comment written before the type declaration.
CField<CStruct>[]	getFields()
CInterfaceDescriptor	getImplementing()	Get interface descriptor this message implements.
boolean	hasAnnotation(java.lang.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.CAnnotatedDescriptor

getAnnotationValue, hasAnnotation

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

fieldForId, fieldForName, getVariant

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(java.lang.String comment,
                         java.lang.String programName,
                         java.lang.String name,
                         java.util.List<CField<CStruct>> fields,
                         java.util.Map<java.lang.String,java.lang.String> annotations,
                         PDescriptorProvider implementing)

Method Detail

isInnerType

public boolean isInnerType()

Specified by:

isInnerType in class PDeclaredDescriptor<CStruct>

Returns:

Returns true if the type is an inner type. Meaning it is contained within another type or service.

isAutoType

public boolean isAutoType()

Specified by:

isAutoType in class PDeclaredDescriptor<CStruct>

Returns:

Returns true if the type is generated automatically by means of something else, e.g. request and response types for services. Or is a built in type as part of providence itself.

getDocumentation

public final java.lang.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 PMessageDescriptor<CStruct>

Returns:

An unmodifiable list of fields that the struct holds.

findFieldByName

public CField<CStruct> findFieldByName(java.lang.String name)

Specified by:

findFieldByName in interface CMessageDescriptor

Specified by:

findFieldByName in class PMessageDescriptor<CStruct>

Parameters:

name - Name of field to get.

Returns:

The field if present.

findFieldByPojoName

public CField<CStruct> findFieldByPojoName(java.lang.String pojoName)

Specified by:

findFieldByPojoName in class PMessageDescriptor<CStruct>

Parameters:

pojoName - POJO name of field.

Returns:

The field if present.

findFieldById

public CField<CStruct> findFieldById(int id)

Specified by:

findFieldById in interface CMessageDescriptor

Specified by:

findFieldById in class PMessageDescriptor<CStruct>

Parameters:

id - The ID of the field to get.

Returns:

The field if present.

getImplementing

@Nullable
public CInterfaceDescriptor getImplementing()

Description copied from class: PMessageDescriptor

Get interface descriptor this message implements.

Specified by:

getImplementing in interface CMessageDescriptor

Overrides:

getImplementing in class PMessageDescriptor<CStruct>

Returns:

The interface descriptor or null if not implementing declared interface.

getAnnotations

@Nonnull
public java.util.Set<java.lang.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
                             java.lang.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 java.lang.String getAnnotationValue(@Nonnull
                                           java.lang.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 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 JsonCompactibleDescriptor

Returns:

If the message may be compactible.