net.morimekta.providence.generator.format.java.utils

Class JMessage<T extends net.morimekta.providence.reflect.contained.CMessage<T>>

java.lang.Object

net.morimekta.providence.generator.format.java.utils.JMessage<T>

@Immutable
public class JMessage<T extends net.morimekta.providence.reflect.contained.CMessage<T>>
extends Object

Constructor Summary

Constructors

Constructor and Description
JMessage(net.morimekta.providence.descriptor.PMessageDescriptor<T> descriptor, JHelper helper)

Method Summary

Modifier and Type	Method and Description
List<JField>	declaredOrderFields()
net.morimekta.providence.descriptor.PMessageDescriptor<T>	descriptor()
String	exceptionBaseClass()
Optional<JField>	exceptionMessageField() If the message has a 'string' field named 'message', which can be used as the 'message' for exceptions.
String	extraImplements()
String	getDescriptorClass()
String	getExceptionMessageFieldName()
String	getProviderClass()
boolean	hasAnnotation(net.morimekta.providence.descriptor.PAnnotation annotation) Check if the annotation is present.
boolean	hasAnnotation(String annotation) Check if the annotation is present.
String	instanceType() The short class name of the message.
boolean	isException()
boolean	isUnion()
boolean	jsonCompactible()
List<JField>	numericalOrderFields()
net.morimekta.providence.PMessageVariant	variant()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JMessage

public JMessage(net.morimekta.providence.descriptor.PMessageDescriptor<T> descriptor,
                JHelper helper)

Method Detail

descriptor

public net.morimekta.providence.descriptor.PMessageDescriptor<T> descriptor()

variant

public net.morimekta.providence.PMessageVariant variant()

isException

public boolean isException()

isUnion

public boolean isUnion()

jsonCompactible

public boolean jsonCompactible()

instanceType

public String instanceType()

The short class name of the message.

Returns:

The class short name.

declaredOrderFields

public List<JField> declaredOrderFields()

numericalOrderFields

public List<JField> numericalOrderFields()

getDescriptorClass

public String getDescriptorClass()
                          throws net.morimekta.providence.generator.GeneratorException

Throws:

net.morimekta.providence.generator.GeneratorException

getProviderClass

public String getProviderClass()
                        throws net.morimekta.providence.generator.GeneratorException

Throws:

net.morimekta.providence.generator.GeneratorException

extraImplements

public String extraImplements()

exceptionBaseClass

public String exceptionBaseClass()

exceptionMessageField

public Optional<JField> exceptionMessageField()

If the message has a 'string' field named 'message', which can be used as the 'message' for exceptions.

Returns:

Optional message field.

getExceptionMessageFieldName

@Nonnull
public String getExceptionMessageFieldName()

hasAnnotation

public boolean hasAnnotation(net.morimekta.providence.descriptor.PAnnotation annotation)

Check if the annotation is present.

Parameters:

annotation - The annotation to check.

Returns:

True if the annotaiton is present.

hasAnnotation

public boolean hasAnnotation(String annotation)

Check if the annotation is present.

Parameters:

annotation - The annotation to check.

Returns:

True if the annotaiton is present.