Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	TypeSpec.Builder
public static enum	TypeSpec.Kind

Field Summary

Modifier and Type	Field and Description
public final Set<String>	alwaysQualifiedNames
public final List<AnnotationSpec>	annotations
public final CodeBlock	anonymousTypeArguments
public final Map<String, TypeSpec>	enumConstants
public final List<FieldSpec>	fieldSpecs
public final CodeBlock	initializerBlock
public final CodeBlock	javadoc
public final TypeSpec.Kind	kind
public final List<MethodSpec>	methodSpecs
public final Set<Modifier>	modifiers
public final String	name
pack-priv final Set<String>	nestedTypesSimpleNames
public final List<Element>	originatingElements
public final CodeBlock	staticBlock
public final TypeName	superclass
public final List<TypeName>	superinterfaces
public final List<TypeSpec>	typeSpecs
public final List<TypeVariableName>	typeVariables

Access	Constructor and Description
private	TypeSpec(TypeSpec.Builder builder)
private	TypeSpec(TypeSpec type) Creates a dummy type spec for type-resolution only (in CodeWriter) while emitting the type declaration but before entering the type body.

Method Summary

Modifier and Type	Method and Description
public static TypeSpec.Builder	annotationBuilder(String name)
public static TypeSpec.Builder	annotationBuilder(ClassName className)
public static TypeSpec.Builder	anonymousClassBuilder(String typeArgumentsFormat, Object... args)
public static TypeSpec.Builder	anonymousClassBuilder(CodeBlock typeArguments)
public static TypeSpec.Builder	classBuilder(String name)
public static TypeSpec.Builder	classBuilder(ClassName className)
pack-priv void	emit(CodeWriter codeWriter, String enumName, Set<Modifier> implicitModifiers)
public static TypeSpec.Builder	enumBuilder(String name)
public static TypeSpec.Builder	enumBuilder(ClassName className)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	hasModifier(Modifier modifier)
public static TypeSpec.Builder	interfaceBuilder(String name)
public static TypeSpec.Builder	interfaceBuilder(ClassName className)
public TypeSpec.Builder	toBuilder()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

alwaysQualifiedNames	back to summary
public final Set<String> alwaysQualifiedNames

annotations	back to summary
public final List<AnnotationSpec> annotations

anonymousTypeArguments	back to summary
public final CodeBlock anonymousTypeArguments

enumConstants	back to summary
public final Map<String, TypeSpec> enumConstants

fieldSpecs	back to summary
public final List<FieldSpec> fieldSpecs

initializerBlock	back to summary
public final CodeBlock initializerBlock

javadoc	back to summary
public final CodeBlock javadoc

kind	back to summary
public final TypeSpec.Kind kind

methodSpecs	back to summary
public final List<MethodSpec> methodSpecs

modifiers	back to summary
public final Set<Modifier> modifiers

name	back to summary
public final String name

nestedTypesSimpleNames	back to summary
pack-priv final Set<String> nestedTypesSimpleNames

originatingElements	back to summary
public final List<Element> originatingElements

staticBlock	back to summary
public final CodeBlock staticBlock

superclass	back to summary
public final TypeName superclass

superinterfaces	back to summary
public final List<TypeName> superinterfaces

typeSpecs	back to summary
public final List<TypeSpec> typeSpecs

typeVariables	back to summary
public final List<TypeVariableName> typeVariables

TypeSpec	back to summary
private TypeSpec(TypeSpec.Builder builder)

TypeSpec	back to summary
private TypeSpec(TypeSpec type) Creates a dummy type spec for type-resolution only (in CodeWriter) while emitting the type declaration but before entering the type body.

Method Detail

annotationBuilder	back to summary
public static TypeSpec.Builder annotationBuilder(String name)

annotationBuilder	back to summary
public static TypeSpec.Builder annotationBuilder(ClassName className)

anonymousClassBuilder	back to summary
public static TypeSpec.Builder anonymousClassBuilder(String typeArgumentsFormat, Object... args)

anonymousClassBuilder	back to summary
public static TypeSpec.Builder anonymousClassBuilder(CodeBlock typeArguments)

classBuilder	back to summary
public static TypeSpec.Builder classBuilder(String name)

classBuilder	back to summary
public static TypeSpec.Builder classBuilder(ClassName className)

emit	back to summary
pack-priv void emit(CodeWriter codeWriter, String enumName, Set<Modifier> implicitModifiers) throws IOException

enumBuilder	back to summary
public static TypeSpec.Builder enumBuilder(String name)

enumBuilder	back to summary
public static TypeSpec.Builder enumBuilder(ClassName className)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

hasModifier	back to summary
public boolean hasModifier(Modifier modifier)

interfaceBuilder	back to summary
public static TypeSpec.Builder interfaceBuilder(String name)

interfaceBuilder	back to summary
public static TypeSpec.Builder interfaceBuilder(ClassName className)

toBuilder	back to summary
public TypeSpec.Builder toBuilder()

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

com.squareup.javapoet back to summary

public final Class TypeSpec.Builder

Class Inheritance

extends Object

java.lang.Object
com.squareup.javapoet.TypeSpec.Builder

Field Summary

Modifier and Type	Field and Description
public final Set<String>	alwaysQualifiedNames
public final List<AnnotationSpec>	annotations
private final CodeBlock	anonymousTypeArguments
public final Map<String, TypeSpec>	enumConstants
public final List<FieldSpec>	fieldSpecs
private final CodeBlock.Builder	initializerBlock
private final CodeBlock.Builder	javadoc
private final TypeSpec.Kind	kind
public final List<MethodSpec>	methodSpecs
public final List<Modifier>	modifiers
private final String	name
public final List<Element>	originatingElements
private final CodeBlock.Builder	staticBlock
private TypeName	superclass
public final List<TypeName>	superinterfaces
public final List<TypeSpec>	typeSpecs
public final List<TypeVariableName>	typeVariables

Constructor Summary

Access	Constructor and Description
private	Builder(TypeSpec.Kind kind, String name, CodeBlock anonymousTypeArguments)

Method Summary

Modifier and Type	Method and Description
public TypeSpec.Builder	addAnnotation(AnnotationSpec annotationSpec)
public TypeSpec.Builder	addAnnotation(ClassName annotation)
public TypeSpec.Builder	addAnnotation(Class<?> annotation)
public TypeSpec.Builder	addAnnotations(Iterable<AnnotationSpec> annotationSpecs)
public TypeSpec.Builder	addEnumConstant(String name)
public TypeSpec.Builder	addEnumConstant(String name, TypeSpec typeSpec)
public TypeSpec.Builder	addField(FieldSpec fieldSpec)
public TypeSpec.Builder	addField(TypeName type, String name, Modifier... modifiers)
public TypeSpec.Builder	addField(Type type, String name, Modifier... modifiers)
public TypeSpec.Builder	addFields(Iterable<FieldSpec> fieldSpecs)
public TypeSpec.Builder	addInitializerBlock(CodeBlock block)
public TypeSpec.Builder	addJavadoc(String format, Object... args)
public TypeSpec.Builder	addJavadoc(CodeBlock block)
public TypeSpec.Builder	addMethod(MethodSpec methodSpec)
public TypeSpec.Builder	addMethods(Iterable<MethodSpec> methodSpecs)
public TypeSpec.Builder	addModifiers(Modifier... modifiers)
public TypeSpec.Builder	addOriginatingElement(Element originatingElement)
public TypeSpec.Builder	addStaticBlock(CodeBlock block)
public TypeSpec.Builder	addSuperinterface(TypeName superinterface)
public TypeSpec.Builder	addSuperinterface(Type superinterface)
public TypeSpec.Builder	addSuperinterface(Type superinterface, boolean avoidNestedTypeNameClashes)
public TypeSpec.Builder	addSuperinterface(TypeMirror superinterface)
public TypeSpec.Builder	addSuperinterface(TypeMirror superinterface, boolean avoidNestedTypeNameClashes)
public TypeSpec.Builder	addSuperinterfaces(Iterable<? extends TypeName> superinterfaces)
public TypeSpec.Builder	addType(TypeSpec typeSpec)
public TypeSpec.Builder	addTypes(Iterable<TypeSpec> typeSpecs)
public TypeSpec.Builder	addTypeVariable(TypeVariableName typeVariable)
public TypeSpec.Builder	addTypeVariables(Iterable<TypeVariableName> typeVariables)
public TypeSpec.Builder	alwaysQualify(String... simpleNames)
public TypeSpec.Builder	Returns: this builder instance. avoidClashesWithNestedClasses(TypeElement the `TypeElement` with nested types to avoid clashes with. typeElement) Call this to always fully qualify any types that would conflict with possibly nested types of this `typeElement`.
public TypeSpec.Builder	Returns: this builder instance. avoidClashesWithNestedClasses(Class<?> the `Class` with nested types to avoid clashes with. clazz) Call this to always fully qualify any types that would conflict with possibly nested types of this `typeElement`.
public TypeSpec	build()
private Class<?>	getRawType(Type type)
public TypeSpec.Builder	superclass(TypeName superclass)
public TypeSpec.Builder	superclass(Type superclass)
public TypeSpec.Builder	superclass(Type superclass, boolean avoidNestedTypeNameClashes)
public TypeSpec.Builder	superclass(TypeMirror superclass)
public TypeSpec.Builder	superclass(TypeMirror superclass, boolean avoidNestedTypeNameClashes)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

alwaysQualifiedNames	back to summary
public final Set<String> alwaysQualifiedNames

annotations	back to summary
public final List<AnnotationSpec> annotations

anonymousTypeArguments	back to summary
private final CodeBlock anonymousTypeArguments

enumConstants	back to summary
public final Map<String, TypeSpec> enumConstants

fieldSpecs	back to summary
public final List<FieldSpec> fieldSpecs

initializerBlock	back to summary
private final CodeBlock.Builder initializerBlock

javadoc	back to summary
private final CodeBlock.Builder javadoc

kind	back to summary
private final TypeSpec.Kind kind

methodSpecs	back to summary
public final List<MethodSpec> methodSpecs

modifiers	back to summary
public final List<Modifier> modifiers

name	back to summary
private final String name

originatingElements	back to summary
public final List<Element> originatingElements

staticBlock	back to summary
private final CodeBlock.Builder staticBlock

superclass	back to summary
private TypeName superclass

superinterfaces	back to summary
public final List<TypeName> superinterfaces

typeSpecs	back to summary
public final List<TypeSpec> typeSpecs

typeVariables	back to summary
public final List<TypeVariableName> typeVariables

Constructor Detail

Builder	back to summary
private Builder(TypeSpec.Kind kind, String name, CodeBlock anonymousTypeArguments)

Method Detail

addAnnotation	back to summary
public TypeSpec.Builder addAnnotation(AnnotationSpec annotationSpec)

addAnnotation	back to summary
public TypeSpec.Builder addAnnotation(ClassName annotation)

addAnnotation	back to summary
public TypeSpec.Builder addAnnotation(Class<?> annotation)

addAnnotations	back to summary
public TypeSpec.Builder addAnnotations(Iterable<AnnotationSpec> annotationSpecs)

addEnumConstant	back to summary
public TypeSpec.Builder addEnumConstant(String name)

addEnumConstant	back to summary
public TypeSpec.Builder addEnumConstant(String name, TypeSpec typeSpec)

addField	back to summary
public TypeSpec.Builder addField(FieldSpec fieldSpec)

addField	back to summary
public TypeSpec.Builder addField(TypeName type, String name, Modifier... modifiers)

addField	back to summary
public TypeSpec.Builder addField(Type type, String name, Modifier... modifiers)

addFields	back to summary
public TypeSpec.Builder addFields(Iterable<FieldSpec> fieldSpecs)

addInitializerBlock	back to summary
public TypeSpec.Builder addInitializerBlock(CodeBlock block)

addJavadoc	back to summary
public TypeSpec.Builder addJavadoc(String format, Object... args)

addJavadoc	back to summary
public TypeSpec.Builder addJavadoc(CodeBlock block)

addMethod	back to summary
public TypeSpec.Builder addMethod(MethodSpec methodSpec)

addMethods	back to summary
public TypeSpec.Builder addMethods(Iterable<MethodSpec> methodSpecs)

addModifiers	back to summary
public TypeSpec.Builder addModifiers(Modifier... modifiers)

addOriginatingElement	back to summary
public TypeSpec.Builder addOriginatingElement(Element originatingElement)

addStaticBlock	back to summary
public TypeSpec.Builder addStaticBlock(CodeBlock block)

addSuperinterface	back to summary
public TypeSpec.Builder addSuperinterface(TypeName superinterface)

addSuperinterface	back to summary
public TypeSpec.Builder addSuperinterface(Type superinterface)

addSuperinterface	back to summary
public TypeSpec.Builder addSuperinterface(Type superinterface, boolean avoidNestedTypeNameClashes)

addSuperinterface	back to summary
public TypeSpec.Builder addSuperinterface(TypeMirror superinterface)

addSuperinterface	back to summary
public TypeSpec.Builder addSuperinterface(TypeMirror superinterface, boolean avoidNestedTypeNameClashes)

addSuperinterfaces	back to summary
public TypeSpec.Builder addSuperinterfaces(Iterable<? extends TypeName> superinterfaces)

addType	back to summary
public TypeSpec.Builder addType(TypeSpec typeSpec)

addTypes	back to summary
public TypeSpec.Builder addTypes(Iterable<TypeSpec> typeSpecs)

addTypeVariable	back to summary
public TypeSpec.Builder addTypeVariable(TypeVariableName typeVariable)

addTypeVariables	back to summary
public TypeSpec.Builder addTypeVariables(Iterable<TypeVariableName> typeVariables)

alwaysQualify	back to summary
public TypeSpec.Builder alwaysQualify(String... simpleNames)

avoidClashesWithNestedClasses back to summary

public TypeSpec.Builder avoidClashesWithNestedClasses(TypeElement typeElement)

Call this to always fully qualify any types that would conflict with possibly nested types of this typeElement. For example - if the following type was passed in as the typeElement:


  class Foo {
    class NestedTypeA {

    }
    class NestedTypeB {

    }
  }

Then this would add "NestedTypeA" and "NestedTypeB" as names that should always be qualified via alwaysQualify(String...). This way they would avoid possible import conflicts when this JavaFile is written.

Parameters

typeElement:TypeElement: the TypeElement with nested types to avoid clashes with.

Returns:TypeSpec.Builder

this builder instance.

avoidClashesWithNestedClasses back to summary

public TypeSpec.Builder avoidClashesWithNestedClasses(Class<?> clazz)

Call this to always fully qualify any types that would conflict with possibly nested types of this typeElement. For example - if the following type was passed in as the typeElement:


  class Foo {
    class NestedTypeA {

    }
    class NestedTypeB {

    }
  }

Parameters

clazz:Class<?>: the Class with nested types to avoid clashes with.

Returns:TypeSpec.Builder

this builder instance.

build	back to summary
public TypeSpec build()

getRawType	back to summary
private Class<?> getRawType(Type type)

superclass	back to summary
public TypeSpec.Builder superclass(TypeName superclass)

superclass	back to summary
public TypeSpec.Builder superclass(Type superclass)

superclass	back to summary
public TypeSpec.Builder superclass(Type superclass, boolean avoidNestedTypeNameClashes)

superclass	back to summary
public TypeSpec.Builder superclass(TypeMirror superclass)

superclass	back to summary
public TypeSpec.Builder superclass(TypeMirror superclass, boolean avoidNestedTypeNameClashes)

com.squareup.javapoet back to summary

public final Enum TypeSpec.Kind

Class Inheritance

extends Enum<TypeSpec.Kind>

java.lang.Object
java.lang.Enum
com.squareup.javapoet.TypeSpec.Kind

Field Summary

Modifier and Type	Field and Description
public static final TypeSpec.Kind	ANNOTATION
private final Set<Modifier>	asMemberModifiers
public static final TypeSpec.Kind	CLASS
public static final TypeSpec.Kind	ENUM
private final Set<Modifier>	implicitFieldModifiers
private final Set<Modifier>	implicitMethodModifiers
private final Set<Modifier>	implicitTypeModifiers
public static final TypeSpec.Kind	INTERFACE

Constructor Summary

Access	Constructor and Description
private	Kind(Set<Modifier> implicitFieldModifiers, Set<Modifier> implicitMethodModifiers, Set<Modifier> implicitTypeModifiers, Set<Modifier> asMemberModifiers)

Method Summary

Modifier and Type	Method and Description
public static TypeSpec.Kind	valueOf(String name)
public static TypeSpec.Kind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ANNOTATION	back to summary
public static final TypeSpec.Kind ANNOTATION

asMemberModifiers	back to summary
private final Set<Modifier> asMemberModifiers

CLASS	back to summary
public static final TypeSpec.Kind CLASS

ENUM	back to summary
public static final TypeSpec.Kind ENUM

implicitFieldModifiers	back to summary
private final Set<Modifier> implicitFieldModifiers

implicitMethodModifiers	back to summary
private final Set<Modifier> implicitMethodModifiers

implicitTypeModifiers	back to summary
private final Set<Modifier> implicitTypeModifiers

INTERFACE	back to summary
public static final TypeSpec.Kind INTERFACE

Constructor Detail

Kind	back to summary
private Kind(Set<Modifier> implicitFieldModifiers, Set<Modifier> implicitMethodModifiers, Set<Modifier> implicitTypeModifiers, Set<Modifier> asMemberModifiers)

Method Detail

valueOf	back to summary
public static TypeSpec.Kind valueOf(String name)

values	back to summary
public static TypeSpec.Kind[] values()