com.squareup.javapoet

Class MethodSpec.Builder

java.lang.Object

com.squareup.javapoet.MethodSpec.Builder

Enclosing class:

MethodSpec

public static final class MethodSpec.Builder
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
MethodSpec.Builder	addAnnotation(AnnotationSpec annotationSpec)
MethodSpec.Builder	addAnnotation(Class<?> annotation)
MethodSpec.Builder	addAnnotation(ClassName annotation)
MethodSpec.Builder	addAnnotations(Iterable<AnnotationSpec> annotationSpecs)
MethodSpec.Builder	addCode(CodeBlock codeBlock)
MethodSpec.Builder	addCode(String format, Object... args)
MethodSpec.Builder	addException(Type exception)
MethodSpec.Builder	addException(TypeName exception)
MethodSpec.Builder	addExceptions(Iterable<? extends TypeName> exceptions)
MethodSpec.Builder	addJavadoc(String format, Object... args)
MethodSpec.Builder	addModifiers(Iterable<Modifier> modifiers)
MethodSpec.Builder	addModifiers(Modifier... modifiers)
MethodSpec.Builder	addParameter(ParameterSpec parameterSpec)
MethodSpec.Builder	addParameter(TypeName type, String name, Modifier... modifiers)
MethodSpec.Builder	addParameter(Type type, String name, Modifier... modifiers)
MethodSpec.Builder	addParameters(Iterable<ParameterSpec> parameterSpecs)
MethodSpec.Builder	addStatement(String format, Object... args)
MethodSpec.Builder	addTypeVariable(TypeVariableName typeVariable)
MethodSpec.Builder	addTypeVariables(Iterable<TypeVariableName> typeVariables)
MethodSpec.Builder	beginControlFlow(String controlFlow, Object... args)
MethodSpec	build()
MethodSpec.Builder	defaultValue(CodeBlock codeBlock)
MethodSpec.Builder	defaultValue(String format, Object... args)
MethodSpec.Builder	endControlFlow()
MethodSpec.Builder	endControlFlow(String controlFlow, Object... args)
MethodSpec.Builder	nextControlFlow(String controlFlow, Object... args)
MethodSpec.Builder	returns(Type returnType)
MethodSpec.Builder	returns(TypeName returnType)
MethodSpec.Builder	varargs()
MethodSpec.Builder	varargs(boolean varargs)

Methods inherited from class java.lang.Object

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

Method Detail

addJavadoc

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

addAnnotations

public MethodSpec.Builder addAnnotations(Iterable<AnnotationSpec> annotationSpecs)

addAnnotation

public MethodSpec.Builder addAnnotation(AnnotationSpec annotationSpec)

addAnnotation

public MethodSpec.Builder addAnnotation(ClassName annotation)

addAnnotation

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

addModifiers

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

addModifiers

public MethodSpec.Builder addModifiers(Iterable<Modifier> modifiers)

addTypeVariables

public MethodSpec.Builder addTypeVariables(Iterable<TypeVariableName> typeVariables)

addTypeVariable

public MethodSpec.Builder addTypeVariable(TypeVariableName typeVariable)

returns

public MethodSpec.Builder returns(TypeName returnType)

returns

public MethodSpec.Builder returns(Type returnType)

addParameters

public MethodSpec.Builder addParameters(Iterable<ParameterSpec> parameterSpecs)

addParameter

public MethodSpec.Builder addParameter(ParameterSpec parameterSpec)

addParameter

public MethodSpec.Builder addParameter(TypeName type,
                              String name,
                              Modifier... modifiers)

addParameter

public MethodSpec.Builder addParameter(Type type,
                              String name,
                              Modifier... modifiers)

varargs

public MethodSpec.Builder varargs()

varargs

public MethodSpec.Builder varargs(boolean varargs)

addExceptions

public MethodSpec.Builder addExceptions(Iterable<? extends TypeName> exceptions)

addException

public MethodSpec.Builder addException(TypeName exception)

addException

public MethodSpec.Builder addException(Type exception)

addCode

public MethodSpec.Builder addCode(String format,
                         Object... args)

addCode

public MethodSpec.Builder addCode(CodeBlock codeBlock)

defaultValue

public MethodSpec.Builder defaultValue(String format,
                              Object... args)

defaultValue

public MethodSpec.Builder defaultValue(CodeBlock codeBlock)

beginControlFlow

public MethodSpec.Builder beginControlFlow(String controlFlow,
                                  Object... args)

Parameters:

controlFlow - the control flow construct and its code, such as "if (foo == 5)". Shouldn't contain braces or newline characters.

nextControlFlow

public MethodSpec.Builder nextControlFlow(String controlFlow,
                                 Object... args)

Parameters:

controlFlow - the control flow construct and its code, such as "else if (foo == 10)". Shouldn't contain braces or newline characters.

endControlFlow

public MethodSpec.Builder endControlFlow()

endControlFlow

public MethodSpec.Builder endControlFlow(String controlFlow,
                                Object... args)

Parameters:

controlFlow - the optional control flow construct and its code, such as "while(foo == 20)". Only used for "do/while" control flows.

addStatement

public MethodSpec.Builder addStatement(String format,
                              Object... args)

build

public MethodSpec build()