Top Description Inners Fields Constructors Methods
org.springframework.javapoet

public final Class ParameterSpec

extends Object
Class Inheritance
Imports
java.io.IOException, java.lang.reflect.Type, java.util.ArrayList, .Collections, .List, .Set, javax.lang.model.SourceVersion, javax.lang.model.element.ElementKind, .ExecutableElement, .Modifier, .VariableElement

A generated parameter declaration.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public final List<AnnotationSpec>
public final CodeBlock
public final Set<Modifier>
public final String
public final TypeName

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ParameterSpec.Builder
builder(TypeName type, String name, Modifier... modifiers)

public static ParameterSpec.Builder
builder(Type type, String name, Modifier... modifiers)

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

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 ParameterSpec
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
private static boolean
pack-priv static List<ParameterSpec>
public ParameterSpec.Builder
pack-priv ParameterSpec.Builder
public String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

annotationsback to summary
public final List<AnnotationSpec> annotations
javadocback to summary
public final CodeBlock javadoc
modifiersback to summary
public final Set<Modifier> modifiers
nameback to summary
public final String name
typeback to summary
public final TypeName type

Constructor Detail

ParameterSpecback to summary
private ParameterSpec(ParameterSpec.Builder builder)

Method Detail

builderback to summary
public static ParameterSpec.Builder builder(TypeName type, String name, Modifier... modifiers)
builderback to summary
public static ParameterSpec.Builder builder(Type type, String name, Modifier... modifiers)
emitback to summary
pack-priv void emit(CodeWriter codeWriter, boolean varargs) 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 ParameterSpec get(VariableElement element)
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
hasModifierback to summary
public boolean hasModifier(Modifier modifier)
isValidParameterNameback to summary
private static boolean isValidParameterName(String name)
parametersOfback to summary
pack-priv static List<ParameterSpec> parametersOf(ExecutableElement method)
toBuilderback to summary
public ParameterSpec.Builder toBuilder()
toBuilderback to summary
pack-priv ParameterSpec.Builder toBuilder(TypeName type, String name)
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
org.springframework.javapoet back to summary

public final Class ParameterSpec.Builder

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
public final List<AnnotationSpec>
private final CodeBlock.Builder
public final List<Modifier>
private final String
private final TypeName

Constructor Summary

AccessConstructor and Description
private
Builder(TypeName type, String name)

Method Summary

Modifier and TypeMethod and Description
public ParameterSpec.Builder
addAnnotation(AnnotationSpec annotationSpec)

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

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

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

public ParameterSpec.Builder
public ParameterSpec
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

annotationsback to summary
public final List<AnnotationSpec> annotations
javadocback to summary
private final CodeBlock.Builder javadoc
modifiersback to summary
public final List<Modifier> modifiers
nameback to summary
private final String name
typeback to summary
private final TypeName type

Constructor Detail

Builderback to summary
private Builder(TypeName type, String name)

Method Detail

addAnnotationback to summary
public ParameterSpec.Builder addAnnotation(AnnotationSpec annotationSpec)
addAnnotationback to summary
public ParameterSpec.Builder addAnnotation(ClassName annotation)
addAnnotationback to summary
public ParameterSpec.Builder addAnnotation(Class<?> annotation)
addAnnotationsback to summary
public ParameterSpec.Builder addAnnotations(Iterable<AnnotationSpec> annotationSpecs)
addJavadocback to summary
public ParameterSpec.Builder addJavadoc(String format, Object... args)
addJavadocback to summary
public ParameterSpec.Builder addJavadoc(CodeBlock block)
addModifiersback to summary
public ParameterSpec.Builder addModifiers(Modifier... modifiers)
addModifiersback to summary
public ParameterSpec.Builder addModifiers(Iterable<Modifier> modifiers)
buildback to summary
public ParameterSpec build()