org.jboss.logging.processor.apt

Class ThrowableTypeFactory.AptThrowableType

java.lang.Object

org.jboss.logging.processor.apt.AbstractMessageObjectType

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ThrowableTypeFactory.AptReturnThrowableType

Enclosing class:

ThrowableTypeFactory

private static class ThrowableTypeFactory.AptThrowableType
extends AbstractMessageObjectType
implements ThrowableType

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	defaultConstructor
private boolean	isChecked
private boolean	stringAndThrowableConstructor
private boolean	stringConstructor
protected javax.lang.model.type.TypeMirror	stringType
private boolean	throwableAndStringConstructor
private boolean	throwableConstructor
protected javax.lang.model.type.TypeMirror	throwableType
private javax.lang.model.type.TypeMirror	type

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

elements, typeMirror, types

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	compareTo(ThrowableType o)
java.util.Set<Parameter>	constructionParameters() The parameters needed to construct the throwable, if not using the default constructor.
boolean	equals(java.lang.Object obj)
boolean	hasDefaultConstructor() Checks to see the throwable has a default constructor.
int	hashCode()
boolean	hasStringAndThrowableConstructor() Checks to see if the throwable has a string and throwable (Throwable(String, Throwable)) constructor.
boolean	hasStringConstructor() Checks to see if the throwable has a string (Throwable(String)) constructor.
boolean	hasThrowableAndStringConstructor() Checks to see if the throwable has a throwable and string (Throwable(Throwable, String)) constructor.
boolean	hasThrowableConstructor() Checks to see if the throwable has a string and throwable (Throwable(String, Throwable)) constructor.
protected void	init() Initializes the object.
protected void	init(java.util.List<? extends javax.lang.model.element.VariableElement> params) Allows for additional processing of parameters.
boolean	isChecked() Checks if the throwable is a checked exception.
java.lang.String	name() Returns the qualified class name of the return type.
javax.lang.model.type.TypeMirror	reference() The object used to extract information for the message logger or message bundle, if applicable.
java.lang.String	toString()
boolean	useConstructionParameters() Checks to see if the throwable has and can use a custom constructor.

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

type

private final javax.lang.model.type.TypeMirror type

isChecked

private final boolean isChecked

defaultConstructor

private boolean defaultConstructor

stringConstructor

private boolean stringConstructor

throwableConstructor

private boolean throwableConstructor

stringAndThrowableConstructor

private boolean stringAndThrowableConstructor

throwableAndStringConstructor

private boolean throwableAndStringConstructor

stringType

protected final javax.lang.model.type.TypeMirror stringType

throwableType

protected final javax.lang.model.type.TypeMirror throwableType

Constructor Detail

AptThrowableType

private AptThrowableType(javax.lang.model.util.Elements elements,
                         javax.lang.model.util.Types types,
                         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.

type - the class name of the return type.

Method Detail

init

protected final void init()

Initializes the object.

init

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

Allows for additional processing of parameters.

Parameters:

params - the parameters to be processed.

hasDefaultConstructor

public boolean hasDefaultConstructor()

Description copied from interface: ThrowableType

Checks to see the throwable has a default constructor.

Specified by:

hasDefaultConstructor in interface ThrowableType

Returns:

true if the throwable has a default constructor, otherwise false.

hasStringAndThrowableConstructor

public boolean hasStringAndThrowableConstructor()

Description copied from interface: ThrowableType

Checks to see if the throwable has a string and throwable (Throwable(String, Throwable)) constructor.

Specified by:

hasStringAndThrowableConstructor in interface ThrowableType

Returns:

true if the throwable has both a string and throwable constructor, otherwise false.

hasStringConstructor

public boolean hasStringConstructor()

Description copied from interface: ThrowableType

Checks to see if the throwable has a string (Throwable(String)) constructor.

If true, Throwable.initCause(Throwable) can be used to set the throwable.

Specified by:

hasStringConstructor in interface ThrowableType

Returns:

true if the throwable has a string constructor, otherwise false.

hasThrowableAndStringConstructor

public boolean hasThrowableAndStringConstructor()

Description copied from interface: ThrowableType

Checks to see if the throwable has a throwable and string (Throwable(Throwable, String)) constructor.

Specified by:

hasThrowableAndStringConstructor in interface ThrowableType

Returns:

true if the throwable has both a throwable and string constructor, otherwise false.

hasThrowableConstructor

public boolean hasThrowableConstructor()

Description copied from interface: ThrowableType

Checks to see if the throwable has a string and throwable (Throwable(String, Throwable)) constructor.

Specified by:

hasThrowableConstructor in interface ThrowableType

Returns:

true if the throwable has a throwable constructor, otherwise false.

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

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

Returns:

a set of construction parameters or an empty set.

isChecked

public boolean isChecked()

Description copied from interface: ThrowableType

Checks if the throwable is a checked exception. If the throwable is a checked exception, true is returned, otherwise false.

Specified by:

isChecked in interface ThrowableType

Returns:

true if the throwable is a checked exception, otherwise false.

name

public java.lang.String name()

Description copied from interface: ThrowableType

Returns the qualified class name of the return type.

Specified by:

name in interface MessageObject

Specified by:

name in interface ThrowableType

Returns:

the qualified class name fo the return type.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

reference

public javax.lang.model.type.TypeMirror reference()

Description copied from interface: MessageObject

The object used to extract information for the message logger or message bundle, if applicable. The reference is not used for the implementation and is provided for convenience.

For example, in an annotation processor implementation a ExecutableElement might be returned.

Specified by:

reference in interface MessageObject

Returns:

the reference object used to extract information.

compareTo

public int compareTo(ThrowableType o)

Specified by:

compareTo in interface java.lang.Comparable<ThrowableType>