org.jboss.logging.processor.apt

Class ThrowableTypeFactory.AptReturnThrowableType

java.lang.Object

org.jboss.logging.processor.apt.AbstractMessageObjectType

org.jboss.logging.processor.apt.ThrowableTypeFactory.AptThrowableType

org.jboss.logging.processor.apt.ThrowableTypeFactory.AptReturnThrowableType

All Implemented Interfaces:

java.lang.Comparable<ThrowableType>, MessageObject, MessageObjectType, ThrowableType

Enclosing class:

ThrowableTypeFactory

private static class ThrowableTypeFactory.AptReturnThrowableType
extends ThrowableTypeFactory.AptThrowableType

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<Parameter>	constructionParameters
private MessageMethod	messageMethod
private boolean	useConstructionParameters

Fields inherited from class org.jboss.logging.processor.apt.ThrowableTypeFactory.AptThrowableType

stringType, throwableType

Fields inherited from class org.jboss.logging.processor.apt.AbstractMessageObjectType

elements, typeMirror, types

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AptReturnThrowableType(javax.lang.model.util.Elements elements, javax.lang.model.util.Types types, MessageMethod messageMethod, javax.lang.model.type.TypeMirror type) Creates a new descriptor that is not primitive.

Method Summary

Modifier and Type	Method and Description
java.util.Set<Parameter>	constructionParameters() The parameters needed to construct the throwable, if not using the default constructor.
protected void	init(java.util.List<? extends javax.lang.model.element.VariableElement> params) Allows for additional processing of parameters.
boolean	useConstructionParameters() Checks to see if the throwable has and can use a custom constructor.

Methods inherited from class org.jboss.logging.processor.apt.ThrowableTypeFactory.AptThrowableType

compareTo, equals, hasDefaultConstructor, hashCode, hasStringAndThrowableConstructor, hasStringConstructor, hasThrowableAndStringConstructor, hasThrowableConstructor, init, isChecked, name, reference, toString

Methods inherited from class org.jboss.logging.processor.apt.AbstractMessageObjectType

isAssignableFrom, isSameAs, isSubtypeOf, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.logging.processor.model.MessageObjectType

isAssignableFrom, isSameAs, isSubtypeOf, type

Field Detail

messageMethod

private final MessageMethod messageMethod

constructionParameters

private final java.util.Set<Parameter> constructionParameters

useConstructionParameters

private boolean useConstructionParameters

Constructor Detail

AptReturnThrowableType

private AptReturnThrowableType(javax.lang.model.util.Elements elements,
                               javax.lang.model.util.Types types,
                               MessageMethod messageMethod,
                               javax.lang.model.type.TypeMirror type)

Creates a new descriptor that is not primitive.

Parameters:

types - the type utilities from the annotation processor.

elements - the element utilities from the annotation processor.

messageMethod - the message method.

type - the class name of the return type.

Method Detail

init

protected void init(java.util.List<? extends javax.lang.model.element.VariableElement> params)

Description copied from class: ThrowableTypeFactory.AptThrowableType

Allows for additional processing of parameters.

Overrides:

init in class ThrowableTypeFactory.AptThrowableType

Parameters:

params - the parameters to be processed.

useConstructionParameters

public boolean useConstructionParameters()

Description copied from interface: ThrowableType

Checks to see if the throwable has and can use a custom constructor.

If true, the constructor parameters can be retrieved from the ThrowableType.constructionParameters() method.

Specified by:

useConstructionParameters in interface ThrowableType

Overrides:

useConstructionParameters in class ThrowableTypeFactory.AptThrowableType

Returns:

true if the throwable has a custom constructor that can be used, otherwise false.

constructionParameters

public java.util.Set<Parameter> constructionParameters()

Description copied from interface: ThrowableType

The parameters needed to construct the throwable, if not using the default constructor. If the default constructor should be used an empty set should be returned.

The order the set is returned is the order in which the parameters must be in for the constructor.

Specified by:

constructionParameters in interface ThrowableType

Overrides:

constructionParameters in class ThrowableTypeFactory.AptThrowableType

Returns:

a set of construction parameters or an empty set.