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 final class	MethodSpec.Builder

Field Summary

Fields

Modifier and Type	Field	Description
final List<AnnotationSpec>	annotations
final CodeBlock	code
(package private) static final String	CONSTRUCTOR
final CodeBlock	defaultValue
final List<TypeName>	exceptions
final CodeBlock	javadoc
final Set<Modifier>	modifiers
final String	name
(package private) static final ClassName	OVERRIDE
final List<ParameterSpec>	parameters
final TypeName	returnType
final List<TypeVariableName>	typeVariables
final boolean	varargs

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MethodSpec(MethodSpec.Builder builder)

Method Summary

Modifier and Type	Method	Description
static MethodSpec.Builder	constructorBuilder()
(package private) void	emit(CodeWriter codeWriter, String enclosingName, Set<Modifier> implicitModifiers)
boolean	equals(Object o)
int	hashCode()
boolean	hasModifier(Modifier modifier)
boolean	isConstructor()
private boolean	lastParameterIsArray(List<ParameterSpec> parameters)
static MethodSpec.Builder	methodBuilder(String name)
static MethodSpec.Builder	overriding(ExecutableElement method)	Returns a new method spec builder that overrides method.
static MethodSpec.Builder	overriding(ExecutableElement method, DeclaredType enclosing, Types types)	Returns a new method spec builder that overrides method as a member of enclosing.
MethodSpec.Builder	toBuilder()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CONSTRUCTOR

static final String CONSTRUCTOR

See Also:

• Constant Field Values

OVERRIDE

static final ClassName OVERRIDE

name

public final String name

javadoc

public final CodeBlock javadoc

annotations

public final List<AnnotationSpec> annotations

modifiers

public final Set<Modifier> modifiers

typeVariables

public final List<TypeVariableName> typeVariables

returnType

public final TypeName returnType

parameters

public final List<ParameterSpec> parameters

varargs

public final boolean varargs

exceptions

public final List<TypeName> exceptions

code

public final CodeBlock code

defaultValue

public final CodeBlock defaultValue

Constructor Details

MethodSpec

private MethodSpec(MethodSpec.Builder builder)

Method Details

lastParameterIsArray

private boolean lastParameterIsArray(List<ParameterSpec> parameters)

emit

void emit(CodeWriter codeWriter,
 String enclosingName,
 Set<Modifier> implicitModifiers)
   throws IOException

Throws:

IOException

hasModifier

public boolean hasModifier(Modifier modifier)

isConstructor

public boolean isConstructor()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

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 overrides method.

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 overrides method as a member of enclosing. This will resolve type parameters: for example overriding Comparable.compareTo(T) in a type that implements Comparable<Movie>, the T parameter will be resolved to Movie.

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()