net.morimekta.providence.reflect.contained

Class CField

java.lang.Object

net.morimekta.providence.reflect.contained.CField

All Implemented Interfaces:

PField, CAnnotatedDescriptor

Direct Known Subclasses:

CConst

public class CField
extends Object
implements PField, CAnnotatedDescriptor

Since:

25.08.15

Author:

Stein Eldar Johnsen

Constructor Summary

Constructors

Constructor and Description
CField(String docs, int key, PRequirement requirement, String name, PDescriptorProvider typeProvider, PValueProvider defaultValue, Map<String,String> annotations)

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.
Object	getDefaultValue()
PDescriptor	getDescriptor()
String	getDocumentation() The type comment is the last block of comment written before the type declaration.
int	getKey()
String	getName()
PRequirement	getRequirement()
PType	getType()
boolean	hasAnnotation(String name) Get the given annotation value.
boolean	hasDefaultValue()
int	hashCode()
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

asString

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

getAnnotationValue, hasAnnotation

Constructor Detail

CField

public CField(@Nullable
              String docs,
              int key,
              @Nonnull
              PRequirement requirement,
              @Nonnull
              String name,
              @Nonnull
              PDescriptorProvider typeProvider,
              @Nullable
              PValueProvider defaultValue,
              @Nullable
              Map<String,String> annotations)

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.

getKey

public int getKey()

Specified by:

getKey in interface PField

getRequirement

@Nonnull
public PRequirement getRequirement()

Specified by:

getRequirement in interface PField

getType

@Nonnull
public PType getType()

Specified by:

getType in interface PField

getDescriptor

@Nonnull
public PDescriptor getDescriptor()

Specified by:

getDescriptor in interface PField

getName

@Nonnull
public String getName()

Specified by:

getName in interface PField

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface PField

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface PField

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.

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