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 and Description
static class	MethodSpec.Builder

Field Summary

Fields

Modifier and Type	Field and 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

Methods

Modifier and Type	Method and Description
static MethodSpec.Builder	constructorBuilder()
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 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 java.lang.Object

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

Field Detail

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

Method Detail

hasModifier

public boolean hasModifier(Modifier modifier)

isConstructor

public boolean isConstructor()

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