net.morimekta.providence.reflect.contained

Class CExceptionDescriptor

java.lang.Object

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

net.morimekta.providence.descriptor.PStructDescriptor<T,F>

net.morimekta.providence.descriptor.PExceptionDescriptor<CException,CField>

net.morimekta.providence.reflect.contained.CExceptionDescriptor

All Implemented Interfaces:

PDescriptor, CAnnotatedDescriptor

public class CExceptionDescriptor
extends PExceptionDescriptor<CException,CField>
implements CAnnotatedDescriptor

Since:

07.09.15

Author:

Stein Eldar Johnsen

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Set<String>	getAnnotations() Get set of available annotations.
String	getAnnotationValue(String name) Get the given annotation value.
String	getComment() The type comment is the last block of comment written before the type declaration.
CField	getField(int key)
CField	getField(String name)
CField[]	getFields()
PMessageVariant	getVariant()
boolean	hasAnnotation(String name) Get the given annotation value.
boolean	isSimple()

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

builder, equals, getFactoryInternal, getType, hashCode, isCompactible

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

getName, getPackageName, getQualifiedName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CExceptionDescriptor

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

Method Detail

getComment

public final String getComment()

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:

getComment in interface CAnnotatedDescriptor

Returns:

The comment string containing all formatting (not including the comment delimiter and the leading space.

getFields

public CField[] getFields()

Specified by:

getFields in class PStructDescriptor<CException,CField>

getField

public CField getField(String name)

Specified by:

getField in class PStructDescriptor<CException,CField>

getField

public CField getField(int key)

Specified by:

getField in class PStructDescriptor<CException,CField>

getAnnotations

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

isSimple

public boolean isSimple()

Overrides:

isSimple in class PStructDescriptor<CException,CField>

getVariant

public PMessageVariant getVariant()

Overrides:

getVariant in class PExceptionDescriptor<CException,CField>