org.inferred.freebuilder.processor.util

Class MethodElement

java.lang.Object

org.inferred.freebuilder.processor.util.MethodElement

All Implemented Interfaces:

Element, ExecutableElement, Parameterizable

public class MethodElement
extends Object
implements ExecutableElement

A mutable JavaBean implementation of ExecutableElement for methods, encapsulating the logic of writing a readable method signature.

Note: does not currently support generic parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MethodElement.MethodType An ExecutableType for a MethodElement.
static class	MethodElement.ParameterElement A mutable JavaBean implementation of VariableElement for parameters of MethodElement instances.

Constructor Summary

Constructors

Constructor and Description
MethodElement(TypeMirror returnType, Name simpleName) Returns a new MethodElement, named simpleName and returning returnType, with no annotations, modifiers, parameters or thrown types.

Method Summary

Methods

Modifier and Type	Method and Description
<R,P> R	accept(ElementVisitor<R,P> v, P p)
MethodElement	addAnnotationMirror(AnnotationMirror annotationMirror)
MethodElement	addModifier(Modifier modifier)
MethodElement	addParameter(MethodElement.ParameterElement parameter)
MethodElement	addThrownType(TypeMirror thrownType)
MethodElement.MethodType	asType()
boolean	equals(Object obj)
<A extends Annotation> A	getAnnotation(Class<A> annotationType) Deprecated. Unsupported.
ArrayList<AnnotationMirror>	getAnnotationMirrors()
AnnotationValue	getDefaultValue() Deprecated. Always returns null.
List<? extends Element>	getEnclosedElements() Deprecated. Always returns an empty list.
Element	getEnclosingElement() Deprecated. Unsupported.
ElementKind	getKind()
EnumSet<Modifier>	getModifiers()
ArrayList<MethodElement.ParameterElement>	getParameters()
TypeMirror	getReturnType()
Name	getSimpleName()
ArrayList<TypeMirror>	getThrownTypes()
List<? extends TypeParameterElement>	getTypeParameters() Deprecated. Always returns an empty list..
int	hashCode()
boolean	isVarArgs()
MethodElement	removeModifier(Modifier modifier)
MethodElement	setModifiers(Iterable<? extends Modifier> modifiers)
MethodElement	setVarArgs(boolean varArgs)
SourceWriter	startWritingTo(SourceWriter writer) Writes the signature of this MethodElement out to writer, and returns another SourceWriter to append the method implementation to.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodElement

public MethodElement(TypeMirror returnType,
             Name simpleName)

Returns a new MethodElement, named simpleName and returning returnType, with no annotations, modifiers, parameters or thrown types.

Method Detail

asType

public MethodElement.MethodType asType()

Specified by:

asType in interface Element

getKind

public ElementKind getKind()

Specified by:

getKind in interface Element

getAnnotationMirrors

public ArrayList<AnnotationMirror> getAnnotationMirrors()

Specified by:

getAnnotationMirrors in interface Element

addAnnotationMirror

public MethodElement addAnnotationMirror(AnnotationMirror annotationMirror)

getAnnotation

@Deprecated
public <A extends Annotation> A getAnnotation(Class<A> annotationType)

Deprecated. Unsupported.

Specified by:

getAnnotation in interface Element

getModifiers

public EnumSet<Modifier> getModifiers()

Specified by:

getModifiers in interface Element

addModifier

public MethodElement addModifier(Modifier modifier)

removeModifier

public MethodElement removeModifier(Modifier modifier)

setModifiers

public MethodElement setModifiers(Iterable<? extends Modifier> modifiers)

getEnclosingElement

@Deprecated
public Element getEnclosingElement()

Deprecated. Unsupported.

Specified by:

getEnclosingElement in interface Element

getEnclosedElements

@Deprecated
public List<? extends Element> getEnclosedElements()

Deprecated. Always returns an empty list.

Specified by:

getEnclosedElements in interface Element

accept

public <R,P> R accept(ElementVisitor<R,P> v,
             P p)

Specified by:

accept in interface Element

getTypeParameters

@Deprecated
public List<? extends TypeParameterElement> getTypeParameters()

Deprecated. Always returns an empty list..

Specified by:

getTypeParameters in interface ExecutableElement

Specified by:

getTypeParameters in interface Parameterizable

getReturnType

public TypeMirror getReturnType()

Specified by:

getReturnType in interface ExecutableElement

getParameters

public ArrayList<MethodElement.ParameterElement> getParameters()

Specified by:

getParameters in interface ExecutableElement

addParameter

public MethodElement addParameter(MethodElement.ParameterElement parameter)

isVarArgs

public boolean isVarArgs()

Specified by:

isVarArgs in interface ExecutableElement

setVarArgs

public MethodElement setVarArgs(boolean varArgs)

getThrownTypes

public ArrayList<TypeMirror> getThrownTypes()

Specified by:

getThrownTypes in interface ExecutableElement

addThrownType

public MethodElement addThrownType(TypeMirror thrownType)

getDefaultValue

@Deprecated
public AnnotationValue getDefaultValue()

Deprecated. Always returns null.

Specified by:

getDefaultValue in interface ExecutableElement

getSimpleName

public Name getSimpleName()

Specified by:

getSimpleName in interface Element

Specified by:

getSimpleName in interface ExecutableElement

startWritingTo

public SourceWriter startWritingTo(SourceWriter writer)

Writes the signature of this MethodElement out to writer, and returns another SourceWriter to append the method implementation to. The implementation code will be indented, and the terminal brace will be written when the returned SourceWriter is closed.

If the method is abstract, the returned SourceWriter will throw an exception if it is written to.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Element

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Element

Overrides:

equals in class Object