Class TypeSpec.Builder

java.lang.Object

com.squareup.javapoet.TypeSpec.Builder

Enclosing class:

TypeSpec

public static final class TypeSpec.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final Set<String>	alwaysQualifiedNames
final List<AnnotationSpec>	annotations
final Map<String,TypeSpec>	enumConstants
final List<FieldSpec>	fieldSpecs
final List<MethodSpec>	methodSpecs
final List<Modifier>	modifiers
final List<Element>	originatingElements
final List<TypeName>	superinterfaces
final List<TypeSpec>	typeSpecs
final List<TypeVariableName>	typeVariables

Method Summary

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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

enumConstants

public final Map<String,TypeSpec> enumConstants

annotations

public final List<AnnotationSpec> annotations

modifiers

public final List<Modifier> modifiers

typeVariables

public final List<TypeVariableName> typeVariables

superinterfaces

public final List<TypeName> superinterfaces

fieldSpecs

public final List<FieldSpec> fieldSpecs

methodSpecs

public final List<MethodSpec> methodSpecs

typeSpecs

public final List<TypeSpec> typeSpecs

originatingElements

public final List<Element> originatingElements

alwaysQualifiedNames

public final Set<String> alwaysQualifiedNames

Method Details

addJavadoc

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

addJavadoc

public TypeSpec.Builder addJavadoc(CodeBlock block)

addAnnotations

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

addAnnotation

public TypeSpec.Builder addAnnotation(AnnotationSpec annotationSpec)

addAnnotation

public TypeSpec.Builder addAnnotation(ClassName annotation)

addAnnotation

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

addModifiers

public TypeSpec.Builder addModifiers(Modifier... modifiers)

addTypeVariables

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

addTypeVariable

public TypeSpec.Builder addTypeVariable(TypeVariableName typeVariable)

superclass

public TypeSpec.Builder superclass(TypeName superclass)

superclass

public TypeSpec.Builder superclass(Type superclass)

superclass

public TypeSpec.Builder superclass(Type superclass,
 boolean avoidNestedTypeNameClashes)

superclass

public TypeSpec.Builder superclass(TypeMirror superclass)

superclass

public TypeSpec.Builder superclass(TypeMirror superclass,
 boolean avoidNestedTypeNameClashes)

addSuperinterfaces

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

addSuperinterface

public TypeSpec.Builder addSuperinterface(TypeName superinterface)

addSuperinterface

public TypeSpec.Builder addSuperinterface(Type superinterface)

addSuperinterface

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

addSuperinterface

public TypeSpec.Builder addSuperinterface(TypeMirror superinterface)

addSuperinterface

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

addEnumConstant

public TypeSpec.Builder addEnumConstant(String name)

addEnumConstant

public TypeSpec.Builder addEnumConstant(String name,
 TypeSpec typeSpec)

addFields

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

addField

public TypeSpec.Builder addField(FieldSpec fieldSpec)

addField

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

addField

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

addStaticBlock

public TypeSpec.Builder addStaticBlock(CodeBlock block)

addInitializerBlock

public TypeSpec.Builder addInitializerBlock(CodeBlock block)

addMethods

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

addMethod

public TypeSpec.Builder addMethod(MethodSpec methodSpec)

addTypes

public TypeSpec.Builder addTypes(Iterable<TypeSpec> typeSpecs)

addType

public TypeSpec.Builder addType(TypeSpec typeSpec)

addOriginatingElement

public TypeSpec.Builder addOriginatingElement(Element originatingElement)

alwaysQualify

public TypeSpec.Builder alwaysQualify(String... simpleNames)

avoidClashesWithNestedClasses

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 - the TypeElement with nested types to avoid clashes with.

Returns:

this builder instance.

avoidClashesWithNestedClasses

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 {

    }
  }

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:

clazz - the Class with nested types to avoid clashes with.

Returns:

this builder instance.

build

public TypeSpec build()