Package com.squareup.javapoet
Class MethodSpec
- java.lang.Object
-
- com.squareup.javapoet.MethodSpec
-
public final class MethodSpec extends Object
A generated constructor or method declaration.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MethodSpec.Builder
-
Field Summary
Fields Modifier and Type Field Description List<AnnotationSpec>
annotations
CodeBlock
code
CodeBlock
defaultValue
List<TypeName>
exceptions
CodeBlock
javadoc
Set<Modifier>
modifiers
String
name
List<ParameterSpec>
parameters
TypeName
returnType
List<TypeVariableName>
typeVariables
boolean
varargs
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MethodSpec.Builder
constructorBuilder()
boolean
equals(Object o)
int
hashCode()
boolean
hasModifier(Modifier modifier)
boolean
isConstructor()
static MethodSpec.Builder
methodBuilder(String name)
static MethodSpec.Builder
overriding(ExecutableElement method)
Returns a new method spec builder that overridesmethod
.static MethodSpec.Builder
overriding(ExecutableElement method, DeclaredType enclosing, Types types)
Returns a new method spec builder that overridesmethod
as a member ofenclosing
.MethodSpec.Builder
toBuilder()
String
toString()
-
-
-
Field Detail
-
name
public final String name
-
javadoc
public final CodeBlock javadoc
-
annotations
public final List<AnnotationSpec> annotations
-
typeVariables
public final List<TypeVariableName> typeVariables
-
returnType
public final TypeName returnType
-
parameters
public final List<ParameterSpec> parameters
-
varargs
public final boolean varargs
-
code
public final CodeBlock code
-
defaultValue
public final CodeBlock defaultValue
-
-
Method Detail
-
hasModifier
public boolean hasModifier(Modifier modifier)
-
isConstructor
public boolean isConstructor()
-
methodBuilder
public static MethodSpec.Builder methodBuilder(String name)
-
constructorBuilder
public static MethodSpec.Builder constructorBuilder()
-
overriding
public static MethodSpec.Builder overriding(ExecutableElement method)
Returns a new method spec builder that overridesmethod
.This will copy its visibility modifiers, type parameters, return type, name, parameters, and throws declarations. An
Override
annotation will be added.
-
overriding
public static MethodSpec.Builder overriding(ExecutableElement method, DeclaredType enclosing, Types types)
Returns a new method spec builder that overridesmethod
as a member ofenclosing
. This will resolve type parameters: for example overridingComparable.compareTo(T)
in a type that implementsComparable<Movie>
, theT
parameter will be resolved toMovie
.This will copy its visibility modifiers, type parameters, return type, name, parameters, and throws declarations. An
Override
annotation will be added.
-
toBuilder
public MethodSpec.Builder toBuilder()
-
-