net.morimekta.providence.reflect.contained

Class CField<M extends net.morimekta.providence.PMessage<M>>

java.lang.Object

net.morimekta.providence.reflect.contained.CField<M>

Type Parameters:

M - The message type.

All Implemented Interfaces:

net.morimekta.providence.descriptor.PField<M>, CAnnotatedDescriptor

public class CField<M extends net.morimekta.providence.PMessage<M>>
extends Object
implements net.morimekta.providence.descriptor.PField<M>, CAnnotatedDescriptor

Description of a single contained field. Part of the message descriptor.

Field Summary

Fields

Modifier and Type	Field and Description
static CField<?>[]	EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description

CField(String docs, int id, net.morimekta.providence.descriptor.PRequirement requirement, String name, net.morimekta.providence.descriptor.PDescriptorProvider typeProvider, net.morimekta.providence.descriptor.PStructDescriptorProvider<?> argumentsProvider, net.morimekta.providence.descriptor.PValueProvider<?> defaultValue, Map<String,String> annotations, net.morimekta.providence.descriptor.PDescriptorProvider implementing)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Set<String>	getAnnotations() Get set of available annotations.
String	getAnnotationValue(String name) Get the given annotation value.
net.morimekta.providence.descriptor.PStructDescriptor<?>	getArgumentsType()
Object	getDefaultValue()
net.morimekta.providence.descriptor.PDescriptor	getDescriptor()
String	getDocumentation() The type comment is the last block of comment written before the type declaration.
int	getId()
String	getName()
String	getPojoName()
net.morimekta.providence.descriptor.PRequirement	getRequirement()
boolean	hasAnnotation(String name) Get the given annotation value.
boolean	hasDefaultValue()
int	hashCode()
net.morimekta.providence.descriptor.PMessageDescriptor<M>	onMessageType()
String	toString()

Methods inherited from class java.lang.Object

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

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

asIfString, asString, getType

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

getAnnotationValue, hasAnnotation

Field Detail

EMPTY_ARRAY

public static final CField<?>[] EMPTY_ARRAY

Constructor Detail

CField

public CField(@Nullable
              String docs,
              int id,
              @Nonnull
              net.morimekta.providence.descriptor.PRequirement requirement,
              @Nonnull
              String name,
              @Nonnull
              net.morimekta.providence.descriptor.PDescriptorProvider typeProvider,
              @Nullable
              net.morimekta.providence.descriptor.PStructDescriptorProvider<?> argumentsProvider,
              @Nullable
              net.morimekta.providence.descriptor.PValueProvider<?> defaultValue,
              @Nullable
              Map<String,String> annotations,
              @Nullable
              net.morimekta.providence.descriptor.PDescriptorProvider implementing)

Method Detail

getDocumentation

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

getId

public int getId()

Specified by:

getId in interface net.morimekta.providence.descriptor.PField<M extends net.morimekta.providence.PMessage<M>>

getRequirement

@Nonnull
public net.morimekta.providence.descriptor.PRequirement getRequirement()

Specified by:

getRequirement in interface net.morimekta.providence.descriptor.PField<M extends net.morimekta.providence.PMessage<M>>

getDescriptor

@Nonnull
public net.morimekta.providence.descriptor.PDescriptor getDescriptor()

Specified by:

getDescriptor in interface net.morimekta.providence.descriptor.PField<M extends net.morimekta.providence.PMessage<M>>

getArgumentsType

public net.morimekta.providence.descriptor.PStructDescriptor<?> getArgumentsType()

Specified by:

getArgumentsType in interface net.morimekta.providence.descriptor.PField<M extends net.morimekta.providence.PMessage<M>>

getName

@Nonnull
public String getName()

Specified by:

getName in interface net.morimekta.providence.descriptor.PField<M extends net.morimekta.providence.PMessage<M>>

getPojoName

@Nonnull
public String getPojoName()

Specified by:

getPojoName in interface net.morimekta.providence.descriptor.PField<M extends net.morimekta.providence.PMessage<M>>

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface net.morimekta.providence.descriptor.PField<M extends net.morimekta.providence.PMessage<M>>

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface net.morimekta.providence.descriptor.PField<M extends net.morimekta.providence.PMessage<M>>

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.

onMessageType

@Nonnull
public net.morimekta.providence.descriptor.PMessageDescriptor<M> onMessageType()

Specified by:

onMessageType in interface net.morimekta.providence.descriptor.PField<M extends net.morimekta.providence.PMessage<M>>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object