net.morimekta.providence.reflect.contained

Class CInterfaceDescriptor

java.lang.Object

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

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

net.morimekta.providence.descriptor.PInterfaceDescriptor<CInterface>

net.morimekta.providence.reflect.contained.CInterfaceDescriptor

All Implemented Interfaces:

Type, net.morimekta.providence.descriptor.PDescriptor, CAnnotatedDescriptor, CMessageDescriptor

public class CInterfaceDescriptor
extends net.morimekta.providence.descriptor.PInterfaceDescriptor<CInterface>
implements CMessageDescriptor

Descriptor for an interface. Note that this does not have an equivalent in providence-core, as these interfaces are there for the code generation. They do not alter serialization.

Constructor Summary

Constructors

Constructor and Description
CInterfaceDescriptor(String comment, String packageName, String name, List<CField<CInterface>> fields, Map<String,String> annotations)

Method Summary

Modifier and Type	Method and Description
void	addPossibleType(net.morimekta.providence.descriptor.PMessageDescriptor<?> descriptor)
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.
CInterfaceDescriptor	getImplementing()
List<net.morimekta.providence.descriptor.PMessageDescriptor<?>>	getPossibleTypes()
boolean	hasAnnotation(String name) Get the given annotation value.

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

builder, findFieldById, findFieldByName, findFieldByPojoName, getFields, getVariant, isAutoType, isInnerType

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

equals, fieldForId, fieldForName, fieldForPojoName, getBuilderSupplier, getType, hashCode, isSimple

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, findFieldById, findFieldByName, getFields, getVariant, isSimple

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

Constructor Detail

CInterfaceDescriptor

public CInterfaceDescriptor(String comment,
                            String packageName,
                            String name,
                            List<CField<CInterface>> fields,
                            Map<String,String> annotations)

Method Detail

addPossibleType

public void addPossibleType(net.morimekta.providence.descriptor.PMessageDescriptor<?> descriptor)

getPossibleTypes

public List<net.morimekta.providence.descriptor.PMessageDescriptor<?>> getPossibleTypes()

Overrides:

getPossibleTypes in class net.morimekta.providence.descriptor.PInterfaceDescriptor<CInterface>

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.

getImplementing

@Nullable
public CInterfaceDescriptor getImplementing()

Specified by:

getImplementing in interface CMessageDescriptor

Overrides:

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

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.