org.inferred.freebuilder.processor.util

Class ImpliedClass

java.lang.Object

org.inferred.freebuilder.processor.util.ImpliedClass

All Implemented Interfaces:

Element, Parameterizable, QualifiedNameable, TypeElement

public class ImpliedClass
extends Object
implements TypeElement

TypeElement representing a class that needs to be generated.

Typically created by a Processor during user code analysis, and subsequently generated using openSourceWriter(javax.annotation.processing.Filer).

This type implements TypeElement, as the API is stable, well-known, and lets processors treat to-be-generated and user-supplied types the same way. However, not all methods are implemented (those that are not are marked @Deprecated); additionally, compilers are free to implement Elements and Types in a manner hostile to third-party classes (e.g. by casting a TypeElement to a private internal class), so they are, unfortunately, not fully interchangeable at present.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImpliedClass.ImpliedNestedClass TypeElement representing a nested class of a class that needs to be generated.

Constructor Summary

Constructors

Constructor and Description
ImpliedClass(PackageElement pkg, CharSequence simpleName, Element originatingElement, Elements elementUtils) Constructor for ImpliedClass.

Method Summary

Methods

Modifier and Type	Method and Description
<R,P> R	accept(ElementVisitor<R,P> v, P p)
TypeMirror	asType() Deprecated.
ImpliedClass.ImpliedNestedClass	createNestedClass(CharSequence simpleName) Creates a nested class inside this one, called simpleName.
boolean	equals(Object obj)
<A extends Annotation> A	getAnnotation(Class<A> annotationType) Deprecated.
List<? extends AnnotationMirror>	getAnnotationMirrors() Deprecated.
<A extends Annotation> A[]	getAnnotationsByType(Class<A> annotationType)
List<? extends Element>	getEnclosedElements() Deprecated.
E	getEnclosingElement()
List<? extends TypeMirror>	getInterfaces() Deprecated.
ElementKind	getKind()
Set<Modifier>	getModifiers() Deprecated.
Set<ImpliedClass.ImpliedNestedClass>	getNestedClasses() Returns all nested classes directly declared in this type.
NestingKind	getNestingKind()
Name	getQualifiedName()
Name	getSimpleName()
TypeMirror	getSuperclass() Deprecated.
List<? extends TypeParameterElement>	getTypeParameters() Deprecated.
int	hashCode()
CompilationUnitWriter	openSourceWriter(Filer filer) Returns a CompilationUnitWriter for creating this class.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.lang.model.element.TypeElement

getEnclosedElements, getEnclosingElement, getInterfaces, getNestingKind, getQualifiedName, getSimpleName, getSuperclass, getTypeParameters

Methods inherited from interface javax.lang.model.element.Element

accept, asType, equals, getAnnotation, getAnnotationMirrors, getKind, getModifiers, hashCode

Constructor Detail

ImpliedClass

public ImpliedClass(PackageElement pkg,
            CharSequence simpleName,
            Element originatingElement,
            Elements elementUtils)

Constructor for ImpliedClass.

Parameters:

pkg - the package the class should be created in

simpleName - the name the class should be given (without package)

originatingElement - the element that triggered the code generation

elementUtils - the compiler-provided Elements implementation

Method Detail

createNestedClass

public ImpliedClass.ImpliedNestedClass createNestedClass(CharSequence simpleName)

Creates a nested class inside this one, called simpleName.

This is used to prevent namespace clashes when writing source code.

getNestedClasses

public Set<ImpliedClass.ImpliedNestedClass> getNestedClasses()

Returns all nested classes directly declared in this type.

openSourceWriter

public CompilationUnitWriter openSourceWriter(Filer filer)
                                       throws FilerException

Returns a CompilationUnitWriter for creating this class. The file preamble (package and imports) will be generated automatically.

Throws:

FilerException - if a Filer guarantee is violated (see the FilerException JavaDoc for more information); propagated because this is often seen in GUIDE projects, so should be downgraded to a warning, whereas runtime exceptions should be flagged as an internal error to the user

accept

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

Specified by:

accept in interface Element

asType

@Deprecated
public TypeMirror asType()

Deprecated.

Specified by:

asType in interface Element

getAnnotation

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

Deprecated.

Specified by:

getAnnotation in interface Element

getAnnotationMirrors

@Deprecated
public List<? extends AnnotationMirror> getAnnotationMirrors()

Deprecated.

Specified by:

getAnnotationMirrors in interface Element

getKind

public ElementKind getKind()

Specified by:

getKind in interface Element

getModifiers

@Deprecated
public Set<Modifier> getModifiers()

Deprecated.

Specified by:

getModifiers in interface Element

getEnclosedElements

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

Deprecated.

Specified by:

getEnclosedElements in interface Element

Specified by:

getEnclosedElements in interface TypeElement

getEnclosingElement

public E getEnclosingElement()

Specified by:

getEnclosingElement in interface Element

Specified by:

getEnclosingElement in interface TypeElement

getInterfaces

@Deprecated
public List<? extends TypeMirror> getInterfaces()

Deprecated.

Specified by:

getInterfaces in interface TypeElement

getNestingKind

public NestingKind getNestingKind()

Specified by:

getNestingKind in interface TypeElement

getQualifiedName

public Name getQualifiedName()

Specified by:

getQualifiedName in interface QualifiedNameable

Specified by:

getQualifiedName in interface TypeElement

getSimpleName

public Name getSimpleName()

Specified by:

getSimpleName in interface Element

Specified by:

getSimpleName in interface TypeElement

getSuperclass

@Deprecated
public TypeMirror getSuperclass()

Deprecated.

Specified by:

getSuperclass in interface TypeElement

getTypeParameters

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

Deprecated.

Specified by:

getTypeParameters in interface Parameterizable

Specified by:

getTypeParameters in interface TypeElement

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

getAnnotationsByType

public <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType)