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

Interface CodeBlock.Builder

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

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

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

  • Method Details

    • add

      CodeBlock.Builder add(CodeBlock codeBlock)
      Adds a CodeBlock instance.
      Parameters:
      codeBlock - The code block.
      Returns:
      This Builder instance.

    • add

      CodeBlock.Builder add(String format, Object... args)

      Adds code with positional or relative arguments.

      Relative arguments map 1:1 with the placeholders in the format string.

      Positional arguments use an index after the placeholder to identify which argument index to use. For example, for a literal to reference the 3rd argument, use "$3L" (1 based index).

      Mixing relative and positional arguments in a call to add is illegal and will result in an error.

      Parameters:
      format - The format; may be empty.
      args - The arguments.
      Returns:
      This Builder instance.

    • addNamed

      CodeBlock.Builder addNamed(String format, Map<String,?> args)

      Adds code using named arguments.

      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.

    • addStatement

      CodeBlock.Builder addStatement(String format, Object... args)

      Adds a statement.

      Do not use this method when the resulting code should be used as a field initializer. Use add(String, Object...) instead.

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

    • addStaticImport

      @API(status=STABLE, since="0.2.0") CodeBlock.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") CodeBlock.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") CodeBlock.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

    • beginControlFlow

      CodeBlock.Builder beginControlFlow(String controlFlow, Object... args)
      Starts a control flow construct.
      Parameters:
      controlFlow -

      The control flow construct and its code, such as if (foo == 5).

      Shouldn't contain braces or newline characters.

      args - The arguments.
      Returns:
      This Builder instance.
      See Also:

    • build

      CodeBlock build()
      Creates the CodeBlock from the added components.
      Returns:
      The new CodeBlock instance.

    • endControlFlow

      CodeBlock.Builder endControlFlow()
      Ends a control flow construct that was previously begun with a call to beginControlFlow(String, Object...).
      Returns:
      This Builder instance.

    • endControlFlow

      CodeBlock.Builder endControlFlow(String controlFlow, Object... args)

      Ends a control flow construct that was previously started with a call to beginControlFlow(String,Object...) or beginControlFlow(String,Object...).

      This form is only used for do/while control flows.

      Parameters:
      controlFlow - The optional control flow construct and its code, such as while(foo == 20).
      args - The arguments.
      Returns:
      This Builder instance.

    • indent

      CodeBlock.Builder indent()
      Adds an indentation level to the code block.
      Returns:
      This Builder instance.

    • isEmpty

      boolean isEmpty()
      Checks whether the code block to build would be empty.
      Returns:
      true if the code block would be empty, false otherwise.

    • nextControlFlow

      CodeBlock.Builder nextControlFlow(String controlFlow, Object... args)
      Adds another control flow construct to an already existing one.
      Parameters:
      controlFlow -

      The control flow construct and its code, such as else if (foo == 10).

      Shouldn't contain braces or newline characters.

      args - The arguments.
      Returns:
      This Builder instance.

    • unindent

      CodeBlock.Builder unindent()
      Removes an indentation level from the code block.
      Returns:
      This Builder instance.