Top Description Inners Fields Constructors Methods
com.squareup.javapoet

public final Class AnnotationSpec

extends Object
Class Inheritance
Imports
java.io.IOException, java.lang.annotation.Annotation, java.lang.reflect.Array, .Method, java.util.ArrayList, .Arrays, .Comparator, .Iterator, .LinkedHashMap, .List, .Map, .Objects, javax.lang.model.SourceVersion, javax.lang.model.element.AnnotationMirror, .AnnotationValue, .ExecutableElement, .TypeElement, .VariableElement, javax.lang.model.type.TypeMirror, javax.lang.model.util.SimpleAnnotationValueVisitor8
A generated annotation on a declaration.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AnnotationSpec.Builder

private static class
AnnotationSpec.Visitor

Annotation value visitor adding members to the given builder instance.

Field Summary

Modifier and TypeField and Description
public final Map<String, List<CodeBlock>>
members

public final TypeName
type

Constructor Summary

AccessConstructor and Description
private
AnnotationSpec(AnnotationSpec.Builder builder)

Method Summary

Modifier and TypeMethod and Description
public static AnnotationSpec.Builder
builder(ClassName type)

public static AnnotationSpec.Builder
builder(Class<?> type)

pack-priv void
emit(CodeWriter codeWriter, boolean inline)

private void
emitAnnotationValues(CodeWriter codeWriter, String whitespace, String memberSeparator, List<CodeBlock> values)

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 static AnnotationSpec
get(Annotation annotation)

public static AnnotationSpec
get(Annotation annotation, boolean includeDefaultValues)

public static AnnotationSpec
get(AnnotationMirror annotation)

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public AnnotationSpec.Builder
toBuilder()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

membersback to summary
public final Map<String, List<CodeBlock>> members
typeback to summary
public final TypeName type

Constructor Detail

AnnotationSpecback to summary
private AnnotationSpec(AnnotationSpec.Builder builder)

Method Detail

builderback to summary
public static AnnotationSpec.Builder builder(ClassName type)
builderback to summary
public static AnnotationSpec.Builder builder(Class<?> type)
emitback to summary
pack-priv void emit(CodeWriter codeWriter, boolean inline) throws IOException
emitAnnotationValuesback to summary
private void emitAnnotationValues(CodeWriter codeWriter, String whitespace, String memberSeparator, List<CodeBlock> values) throws IOException
equalsback 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
getback to summary
public static AnnotationSpec get(Annotation annotation)
getback to summary
public static AnnotationSpec get(Annotation annotation, boolean includeDefaultValues)
getback to summary
public static AnnotationSpec get(AnnotationMirror annotation)
hashCodeback 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
toBuilderback to summary
public AnnotationSpec.Builder toBuilder()
toStringback 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 AnnotationSpec.Builder

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
public final Map<String, List<CodeBlock>>
members

private final TypeName
type

Constructor Summary

AccessConstructor and Description
private
Builder(TypeName type)

Method Summary

Modifier and TypeMethod and Description
public AnnotationSpec.Builder
addMember(String name, String format, Object... args)

public AnnotationSpec.Builder
addMember(String name, CodeBlock codeBlock)

pack-priv AnnotationSpec.Builder
addMemberForValue(String memberName, Object value)

Delegates to addMember(String, String, Object...), with parameter format depending on the given value object.

public AnnotationSpec
build()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

membersback to summary
public final Map<String, List<CodeBlock>> members
typeback to summary
private final TypeName type

Constructor Detail

Builderback to summary
private Builder(TypeName type)

Method Detail

addMemberback to summary
public AnnotationSpec.Builder addMember(String name, String format, Object... args)
addMemberback to summary
public AnnotationSpec.Builder addMember(String name, CodeBlock codeBlock)
addMemberForValueback to summary
pack-priv AnnotationSpec.Builder addMemberForValue(String memberName, Object value)

Delegates to addMember(String, String, Object...), with parameter format depending on the given value object. Falls back to "$L" literal format if the class of the given value object is not supported.

buildback to summary
public AnnotationSpec build()
com.squareup.javapoet back to summary

private Class AnnotationSpec.Visitor

extends SimpleAnnotationValueVisitor8<AnnotationSpec.Builder, String>
Class Inheritance
Annotation value visitor adding members to the given builder instance.

Field Summary

Modifier and TypeField and Description
pack-priv final AnnotationSpec.Builder
builder

Constructor Summary

AccessConstructor and Description
pack-priv
Visitor(AnnotationSpec.Builder builder)

Method Summary

Modifier and TypeMethod and Description
protected AnnotationSpec.Builder
defaultAction(Object
the value of the annotation
o, String
a visitor-specified parameter
name)

Overrides javax.lang.model.util.SimpleAnnotationValueVisitor6.defaultAction.

The default action for visit methods.
public AnnotationSpec.Builder
visitAnnotation(AnnotationMirror
the value being visited
a, String
a visitor-specified parameter
name)

Overrides javax.lang.model.util.SimpleAnnotationValueVisitor6.visitAnnotation.

Implements javax.lang.model.element.AnnotationValueVisitor.visitAnnotation.

Visits an annotation value in an annotation.
public AnnotationSpec.Builder
visitArray(List<? extends AnnotationValue>
the value being visited
values, String
a visitor-specified parameter
name)

Overrides javax.lang.model.util.SimpleAnnotationValueVisitor6.visitArray.

Implements javax.lang.model.element.AnnotationValueVisitor.visitArray.

Visits an array value in an annotation.
public AnnotationSpec.Builder
visitEnumConstant(VariableElement
the value being visited
c, String
a visitor-specified parameter
name)

Overrides javax.lang.model.util.SimpleAnnotationValueVisitor6.visitEnumConstant.

Implements javax.lang.model.element.AnnotationValueVisitor.visitEnumConstant.

Visits an enum value in an annotation.
public AnnotationSpec.Builder
visitType(TypeMirror
the value being visited
t, String
a visitor-specified parameter
name)

Overrides javax.lang.model.util.SimpleAnnotationValueVisitor6.visitType.

Implements javax.lang.model.element.AnnotationValueVisitor.visitType.

Visits a type value in an annotation.

Field Detail

builderback to summary
pack-priv final AnnotationSpec.Builder builder

Constructor Detail

Visitorback to summary
pack-priv Visitor(AnnotationSpec.Builder builder)

Method Detail

defaultActionback to summary
protected AnnotationSpec.Builder defaultAction(Object o, String name)

Overrides javax.lang.model.util.SimpleAnnotationValueVisitor6.defaultAction.

Doc from javax.lang.model.util.SimpleAnnotationValueVisitor6.defaultAction.

The default action for visit methods.

Parameters
o:Object

the value of the annotation

name:String

a visitor-specified parameter

Returns:AnnotationSpec.Builder

DEFAULT_VALUE unless overridden

Annotations
@Override
visitAnnotationback to summary
public AnnotationSpec.Builder visitAnnotation(AnnotationMirror a, String name)

Overrides javax.lang.model.util.SimpleAnnotationValueVisitor6.visitAnnotation.

Implements javax.lang.model.element.AnnotationValueVisitor.visitAnnotation.

Doc from javax.lang.model.util.SimpleAnnotationValueVisitor6.visitAnnotation.

Visits an annotation value in an annotation.

Parameters
a:AnnotationMirror

the value being visited

name:String

a visitor-specified parameter

Returns:AnnotationSpec.Builder

the result of defaultAction

Annotations
@Override
visitArrayback to summary
public AnnotationSpec.Builder visitArray(List<? extends AnnotationValue> values, String name)

Overrides javax.lang.model.util.SimpleAnnotationValueVisitor6.visitArray.

Implements javax.lang.model.element.AnnotationValueVisitor.visitArray.

Doc from javax.lang.model.util.SimpleAnnotationValueVisitor6.visitArray.

Visits an array value in an annotation.

Parameters
values:List<? extends AnnotationValue>

the value being visited

name:String

a visitor-specified parameter

Returns:AnnotationSpec.Builder

the result of defaultAction

Annotations
@Override
visitEnumConstantback to summary
public AnnotationSpec.Builder visitEnumConstant(VariableElement c, String name)

Overrides javax.lang.model.util.SimpleAnnotationValueVisitor6.visitEnumConstant.

Implements javax.lang.model.element.AnnotationValueVisitor.visitEnumConstant.

Doc from javax.lang.model.util.SimpleAnnotationValueVisitor6.visitEnumConstant.

Visits an enum value in an annotation.

Parameters
c:VariableElement

the value being visited

name:String

a visitor-specified parameter

Returns:AnnotationSpec.Builder

the result of defaultAction

Annotations
@Override
visitTypeback to summary
public AnnotationSpec.Builder visitType(TypeMirror t, String name)

Overrides javax.lang.model.util.SimpleAnnotationValueVisitor6.visitType.

Implements javax.lang.model.element.AnnotationValueVisitor.visitType.

Doc from javax.lang.model.util.SimpleAnnotationValueVisitor6.visitType.

Visits a type value in an annotation.

Parameters
t:TypeMirror

the value being visited

name:String

a visitor-specified parameter

Returns:AnnotationSpec.Builder

the result of defaultAction

Annotations
@Override