Module org.tquadrat.foundation.javacomposer
Package org.tquadrat.foundation.javacomposer

Interface MethodSpec.Builder

All Known Implementing Classes:
MethodSpecImpl.BuilderImpl
Enclosing interface:
MethodSpec
@ClassVersion(sourceVersion="$Id: MethodSpec.java 1085 2024-01-05 16:23:28Z tquadrat $") @API(status=STABLE, since="0.0.5") public static sealed interface MethodSpec.Builder permits MethodSpecImpl.BuilderImpl
The builder for an instance of MethodSpec
Author:
Square,Inc.
Modified by:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: MethodSpec.java 1085 2024-01-05 16:23:28Z tquadrat $
Since:
0.0.5
UML Diagram
UML Diagram for "org.tquadrat.foundation.javacomposer.MethodSpec.Builder"⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.MethodSpec.Builder"

UML Diagram for "org.tquadrat.foundation.javacomposer.MethodSpec.Builder"⁠

  • Method Details

    • addAnnotation

      MethodSpec.Builder addAnnotation(AnnotationSpec annotationSpec)
      Adds an annotation for the method.
      Note:
      • No debug information can be added when adding an annotation.
      Parameters:
      annotationSpec - The annotation.
      Returns:
      This Builder instance.

    • addAnnotation

      MethodSpec.Builder addAnnotation(Class<?> annotation)
      Adds an annotation for the method.
      Note:
      • No debug information can be added when adding an annotation.
      Parameters:
      annotation - The annotation.
      Returns:
      This Builder instance.

    • addAnnotation

      MethodSpec.Builder addAnnotation(ClassName annotationClass)
      Adds an annotation for the method.
      Note:
      • No debug information can be added when adding an annotation.
      Parameters:
      annotationClass - The annotation.
      Returns:
      This Builder instance.

    • addAnnotations

      MethodSpec.Builder addAnnotations(Iterable<? extends AnnotationSpec> annotationSpecs)
      Adds annotations for the method.
      Note:
      • No debug information can be added when adding an annotation.
      Parameters:
      annotationSpecs - The annotations.
      Returns:
      This Builder instance.

    • addCode

      MethodSpec.Builder addCode(CodeBlock codeBlock)
      Adds code for the method.
      Parameters:
      codeBlock - The code.
      Returns:
      This Builder instance.

    • addCode

      MethodSpec.Builder addCode(String format, Object... args)
      Adds code for the method.
      Parameters:
      format - The format.
      args - The arguments.
      Returns:
      This Builder instance.

    • addComment

      MethodSpec.Builder addComment(String format, Object... args)
      Adds a comment for the method.
      Note:
      • No debug info is added when a comment is added.
      Parameters:
      format - The format.
      args - The arguments.
      Returns:
      This Builder instance.

    • addException

      MethodSpec.Builder addException(Type exception)
      Adds the declaration for an exception for the method.
      Note:
      • No debug info is added when an exception is added.
      Parameters:
      exception - The exception.
      Returns:
      This Builder instance.

    • addException

      MethodSpec.Builder addException(TypeName exception)
      Adds the declaration for an exception for the method.
      Note:
      • No debug info is added when an exception is added.
      Parameters:
      exception - The exception.
      Returns:
      This Builder instance.

    • addExceptions

      MethodSpec.Builder addExceptions(Iterable<? extends TypeName> exceptions)
      Adds the declarations for exceptions for the method.
      Note:
      • No debug info is added when an exception is added.
      Parameters:
      exceptions - The exceptions.
      Returns:
      This Builder instance.

    • addJavadoc

      MethodSpec.Builder addJavadoc(CodeBlock block)
      Adds a Javadoc comment for the method.
      Note:
      • No debug info is added when a comment is added.
      Parameters:
      block - The Javadoc comment.
      Returns:
      This Builder instance.

    • addJavadoc

      MethodSpec.Builder addJavadoc(String format, Object... args)
      Adds a Javadoc comment for the method.
      Note:
      • No debug info is added when a comment is added.
      Parameters:
      format - The format.
      args - The arguments.
      Returns:
      This Builder instance.

    • addModifiers

      MethodSpec.Builder addModifiers(Iterable<Modifier> modifiers)
      Adds modifiers for the method.
      Parameters:
      modifiers - The modifiers.
      Returns:
      This Builder instance.

    • addModifiers

      MethodSpec.Builder addModifiers(Modifier... modifiers)
      Adds modifiers for the method.
      Parameters:
      modifiers - The modifiers.
      Returns:
      This Builder instance.

    • addNamedCode

      MethodSpec.Builder addNamedCode(String format, Map<String,?> args)

      Adds code using named arguments for the method.

      Named arguments specify their name after the '$' followed by a colon ":" and the corresponding type character. Argument names consist of characters in a-z, A-Z, 0-9, and _ and must start with a lowercase character.

      For example, to refer to the type Integer with the argument name clazz use a format string containing $clazz:T and include the key clazz with value java.lang.Integer.class in the argument map.

      Parameters:
      format - The format.
      args - The arguments.
      Returns:
      This Builder instance.

    • addParameter

      MethodSpec.Builder addParameter(ParameterSpec parameterSpec)
      Adds a parameter for the method.
      Note:
      • No debug info is added when a parameter is added.
      Parameters:
      parameterSpec - The parameter.
      Returns:
      This Builder instance.

    • addParameter

      MethodSpec.Builder addParameter(Type type, String name, Modifier... modifiers)
      Adds a parameter for the method.
      Note:
      • No debug info is added when a parameter is added.
      Parameters:
      type - The type of the parameter.
      name - The name of the parameter.
      modifiers - The modifiers for the parameter.
      Returns:
      This Builder instance.

    • addParameter

      MethodSpec.Builder addParameter(TypeName type, String name, Modifier... modifiers)
      Adds a parameter for the method.
      Note:
      • No debug info is added when a parameter is added.
      Parameters:
      type - The type of the parameter.
      name - The name of the parameter.
      modifiers - The modifiers for the parameter.
      Returns:
      This Builder instance.

    • addParameters

      MethodSpec.Builder addParameters(Iterable<? extends ParameterSpec> parameterSpecs)
      Adds parameters for the method.
      Note:
      • No debug info is added when a parameter is added.
      Parameters:
      parameterSpecs - The parameters.
      Returns:
      This Builder instance.

    • addStatement

      MethodSpec.Builder addStatement(String format, Object... args)
      Adds a statement to the code for the method.
      Parameters:
      format - The format.
      args - The arguments.
      Returns:
      This Builder instance.

    • addStaticImport

      @API(status=STABLE, since="0.2.0") MethodSpec.Builder addStaticImport(Class<?> clazz, String... names)
      Adds a static import.
      Parameters:
      clazz - The class.
      names - The names of the elements from the given class that are to be imported.
      Returns:
      This Builder instance.
      Since:
      0.2.0

    • addStaticImport

      @API(status=STABLE, since="0.2.0") MethodSpec.Builder addStaticImport(ClassName className, String... names)
      Adds a static import.
      Parameters:
      className - The class.
      names - The names of the elements from the given class that are to be imported.
      Returns:
      This Builder instance.
      Since:
      0.2.0

    • addStaticImport

      @API(status=STABLE, since="0.2.0") MethodSpec.Builder addStaticImport(Enum<?> constant)
      Adds a static import for the given enum value.
      Parameters:
      constant - The enum value.
      Returns:
      This Builder instance.
      Since:
      0.2.0

    • addTypeVariable

      MethodSpec.Builder addTypeVariable(TypeVariableName typeVariable)
      Adds a type variable for the method.
      Note:
      • No debug info is added when a type variable is added.
      Parameters:
      typeVariable - The type variable.
      Returns:
      This Builder instance.

    • addTypeVariables

      MethodSpec.Builder addTypeVariables(Iterable<TypeVariableName> typeVariables)
      Adds type variables for the method.
      Note:
      • No debug info is added when a parameter is added.
      Parameters:
      typeVariables - The type variables.
      Returns:
      This Builder instance.

    • beginControlFlow

      MethodSpec.Builder beginControlFlow(String controlFlow, Object... args)
      Adds the beginning of a control flow for the method.
      Parameters:
      controlFlow - The control flow construct and its code, such as "if (foo == 5)"; it should not contain braces or newline characters.
      args - The arguments.
      Returns:
      This Builder instance.
      See Also:

    • build

      MethodSpec build()
      Creates a new MethodSpec instance from the components that have been added to this builder.
      Returns:
      The MethodSpec instance.

    • defaultValue

      MethodSpec.Builder defaultValue(CodeBlock defaultValue)
      Sets the default value for this method.
      Parameters:
      defaultValue - The default value.
      Returns:
      This Builder instance.

    • defaultValue

      MethodSpec.Builder defaultValue(String format, Object... args)
      Sets the default value for this method.
      Parameters:
      format - The format.
      args - The arguments.
      Returns:
      This Builder instance.

    • endControlFlow

      MethodSpec.Builder endControlFlow()
      Ends the current control flow for the method.
      Returns:
      This Builder instance.
      See Also:

    • endControlFlow

      MethodSpec.Builder endControlFlow(String controlFlow, Object... args)
      Ends the current control flow for the method; this version is only used for do-while constructs.
      Parameters:
      controlFlow - The optional control flow construct and its code, such as "while(foo == 20)"; it should not contain braces or newline characters.
      args - The arguments.
      Returns:
      This Builder instance.
      See Also:

    • nextControlFlow

      MethodSpec.Builder nextControlFlow(String controlFlow, Object... args)
      Begins another control flow for the method.
      Parameters:
      controlFlow - The control flow construct and its code, such as "else if (foo == 10)"; it should not contain braces or newline characters.
      args - The arguments.
      Returns:
      This Builder instance.
      See Also:

    • returns

      MethodSpec.Builder returns(Type returnType)
      Sets the return type for the method.
      Parameters:
      returnType - The return type.
      Returns:
      This Builder instance.

    • returns

      MethodSpec.Builder returns(Type returnType, String format, Object... args)
      Sets the return type for the method and adds the respective Javadoc comment.
      Parameters:
      returnType - The return type.
      format - The format for the return comment.
      args - The arguments for the return comment.
      Returns:
      This Builder instance.

    • returns

      MethodSpec.Builder returns(TypeName returnType)
      Sets the return type for the method.
      Parameters:
      returnType - The return type.
      Returns:
      This Builder instance.

    • returns

      MethodSpec.Builder returns(TypeName returnType, String format, Object... args)
      Sets the return type for the method and adds the respective Javadoc comment.
      Parameters:
      returnType - The return type.
      format - The format for the return comment.
      args - The arguments for the return comment.
      Returns:
      This Builder instance.

    • varargs

      default MethodSpec.Builder varargs()
      Sets the flag that indicates whether a parameter (the last one) is a varargs parameter to true.
      Returns:
      This Builder instance.

    • varargs

      MethodSpec.Builder varargs(boolean varargs)
      Sets the flag that indicates whether a parameter (the last one) is a varargs parameter.
      Parameters:
      varargs - true if the last parameter is a varargs parameter, false if not.
      Returns:
      This Builder instance.