Package com.squareup.javapoet
Class MethodSpec.Builder
- java.lang.Object
-
- com.squareup.javapoet.MethodSpec.Builder
-
- Enclosing class:
- MethodSpec
public static final class MethodSpec.Builder extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description java.util.List<AnnotationSpec>
annotations
private CodeBlock.Builder
code
private CodeBlock
defaultValue
private java.util.Set<TypeName>
exceptions
private CodeBlock.Builder
javadoc
java.util.List<javax.lang.model.element.Modifier>
modifiers
private java.lang.String
name
java.util.List<ParameterSpec>
parameters
private TypeName
returnType
java.util.List<TypeVariableName>
typeVariables
private boolean
varargs
-
Constructor Summary
Constructors Modifier Constructor Description private
Builder(java.lang.String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MethodSpec.Builder
addAnnotation(AnnotationSpec annotationSpec)
MethodSpec.Builder
addAnnotation(ClassName annotation)
MethodSpec.Builder
addAnnotation(java.lang.Class<?> annotation)
MethodSpec.Builder
addAnnotations(java.lang.Iterable<AnnotationSpec> annotationSpecs)
MethodSpec.Builder
addCode(CodeBlock codeBlock)
MethodSpec.Builder
addCode(java.lang.String format, java.lang.Object... args)
MethodSpec.Builder
addComment(java.lang.String format, java.lang.Object... args)
MethodSpec.Builder
addException(TypeName exception)
MethodSpec.Builder
addException(java.lang.reflect.Type exception)
MethodSpec.Builder
addExceptions(java.lang.Iterable<? extends TypeName> exceptions)
MethodSpec.Builder
addJavadoc(CodeBlock block)
MethodSpec.Builder
addJavadoc(java.lang.String format, java.lang.Object... args)
MethodSpec.Builder
addModifiers(java.lang.Iterable<javax.lang.model.element.Modifier> modifiers)
MethodSpec.Builder
addModifiers(javax.lang.model.element.Modifier... modifiers)
MethodSpec.Builder
addNamedCode(java.lang.String format, java.util.Map<java.lang.String,?> args)
MethodSpec.Builder
addParameter(ParameterSpec parameterSpec)
MethodSpec.Builder
addParameter(TypeName type, java.lang.String name, javax.lang.model.element.Modifier... modifiers)
MethodSpec.Builder
addParameter(java.lang.reflect.Type type, java.lang.String name, javax.lang.model.element.Modifier... modifiers)
MethodSpec.Builder
addParameters(java.lang.Iterable<ParameterSpec> parameterSpecs)
MethodSpec.Builder
addStatement(CodeBlock codeBlock)
MethodSpec.Builder
addStatement(java.lang.String format, java.lang.Object... args)
MethodSpec.Builder
addTypeVariable(TypeVariableName typeVariable)
MethodSpec.Builder
addTypeVariables(java.lang.Iterable<TypeVariableName> typeVariables)
MethodSpec.Builder
beginControlFlow(CodeBlock codeBlock)
MethodSpec.Builder
beginControlFlow(java.lang.String controlFlow, java.lang.Object... args)
MethodSpec
build()
MethodSpec.Builder
defaultValue(CodeBlock codeBlock)
MethodSpec.Builder
defaultValue(java.lang.String format, java.lang.Object... args)
MethodSpec.Builder
endControlFlow()
MethodSpec.Builder
endControlFlow(CodeBlock codeBlock)
MethodSpec.Builder
endControlFlow(java.lang.String controlFlow, java.lang.Object... args)
MethodSpec.Builder
nextControlFlow(CodeBlock codeBlock)
MethodSpec.Builder
nextControlFlow(java.lang.String controlFlow, java.lang.Object... args)
MethodSpec.Builder
returns(TypeName returnType)
MethodSpec.Builder
returns(java.lang.reflect.Type returnType)
MethodSpec.Builder
setName(java.lang.String name)
MethodSpec.Builder
varargs()
MethodSpec.Builder
varargs(boolean varargs)
-
-
-
Field Detail
-
name
private java.lang.String name
-
javadoc
private final CodeBlock.Builder javadoc
-
returnType
private TypeName returnType
-
exceptions
private final java.util.Set<TypeName> exceptions
-
code
private final CodeBlock.Builder code
-
varargs
private boolean varargs
-
defaultValue
private CodeBlock defaultValue
-
typeVariables
public final java.util.List<TypeVariableName> typeVariables
-
annotations
public final java.util.List<AnnotationSpec> annotations
-
modifiers
public final java.util.List<javax.lang.model.element.Modifier> modifiers
-
parameters
public final java.util.List<ParameterSpec> parameters
-
-
Method Detail
-
setName
public MethodSpec.Builder setName(java.lang.String name)
-
addJavadoc
public MethodSpec.Builder addJavadoc(java.lang.String format, java.lang.Object... args)
-
addJavadoc
public MethodSpec.Builder addJavadoc(CodeBlock block)
-
addAnnotations
public MethodSpec.Builder addAnnotations(java.lang.Iterable<AnnotationSpec> annotationSpecs)
-
addAnnotation
public MethodSpec.Builder addAnnotation(AnnotationSpec annotationSpec)
-
addAnnotation
public MethodSpec.Builder addAnnotation(ClassName annotation)
-
addAnnotation
public MethodSpec.Builder addAnnotation(java.lang.Class<?> annotation)
-
addModifiers
public MethodSpec.Builder addModifiers(javax.lang.model.element.Modifier... modifiers)
-
addModifiers
public MethodSpec.Builder addModifiers(java.lang.Iterable<javax.lang.model.element.Modifier> modifiers)
-
addTypeVariables
public MethodSpec.Builder addTypeVariables(java.lang.Iterable<TypeVariableName> typeVariables)
-
addTypeVariable
public MethodSpec.Builder addTypeVariable(TypeVariableName typeVariable)
-
returns
public MethodSpec.Builder returns(TypeName returnType)
-
returns
public MethodSpec.Builder returns(java.lang.reflect.Type returnType)
-
addParameters
public MethodSpec.Builder addParameters(java.lang.Iterable<ParameterSpec> parameterSpecs)
-
addParameter
public MethodSpec.Builder addParameter(ParameterSpec parameterSpec)
-
addParameter
public MethodSpec.Builder addParameter(TypeName type, java.lang.String name, javax.lang.model.element.Modifier... modifiers)
-
addParameter
public MethodSpec.Builder addParameter(java.lang.reflect.Type type, java.lang.String name, javax.lang.model.element.Modifier... modifiers)
-
varargs
public MethodSpec.Builder varargs()
-
varargs
public MethodSpec.Builder varargs(boolean varargs)
-
addExceptions
public MethodSpec.Builder addExceptions(java.lang.Iterable<? extends TypeName> exceptions)
-
addException
public MethodSpec.Builder addException(TypeName exception)
-
addException
public MethodSpec.Builder addException(java.lang.reflect.Type exception)
-
addCode
public MethodSpec.Builder addCode(java.lang.String format, java.lang.Object... args)
-
addNamedCode
public MethodSpec.Builder addNamedCode(java.lang.String format, java.util.Map<java.lang.String,?> args)
-
addCode
public MethodSpec.Builder addCode(CodeBlock codeBlock)
-
addComment
public MethodSpec.Builder addComment(java.lang.String format, java.lang.Object... args)
-
defaultValue
public MethodSpec.Builder defaultValue(java.lang.String format, java.lang.Object... args)
-
defaultValue
public MethodSpec.Builder defaultValue(CodeBlock codeBlock)
-
beginControlFlow
public MethodSpec.Builder beginControlFlow(java.lang.String controlFlow, java.lang.Object... args)
- Parameters:
controlFlow
- the control flow construct and its code, such as "if (foo == 5)". Shouldn't contain braces or newline characters.
-
beginControlFlow
public MethodSpec.Builder beginControlFlow(CodeBlock codeBlock)
- Parameters:
codeBlock
- the control flow construct and its code, such as "if (foo == 5)". Shouldn't contain braces or newline characters.
-
nextControlFlow
public MethodSpec.Builder nextControlFlow(java.lang.String controlFlow, java.lang.Object... args)
- Parameters:
controlFlow
- the control flow construct and its code, such as "else if (foo == 10)". Shouldn't contain braces or newline characters.
-
nextControlFlow
public MethodSpec.Builder nextControlFlow(CodeBlock codeBlock)
- Parameters:
codeBlock
- 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(java.lang.String controlFlow, java.lang.Object... args)
- Parameters:
controlFlow
- the optional control flow construct and its code, such as "while(foo == 20)". Only used for "do/while" control flows.
-
endControlFlow
public MethodSpec.Builder endControlFlow(CodeBlock codeBlock)
- Parameters:
codeBlock
- 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(java.lang.String format, java.lang.Object... args)
-
addStatement
public MethodSpec.Builder addStatement(CodeBlock codeBlock)
-
build
public MethodSpec build()
-
-