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

Interface JavaFile.Builder

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

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

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

  • Method Details

    • addFileComment

      JavaFile.Builder addFileComment(String format, Object... args)
      Adds text to the file comment.
      Parameters:
      format - The format.
      args - The arguments.
      Returns:
      This Builder instance.

    • addStaticImport

      JavaFile.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.

    • addStaticImport

      JavaFile.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.

    • addStaticImport

      JavaFile.Builder addStaticImport(Enum<?> constant)
      Adds a static import for the given enum value.
      Parameters:
      constant - The enum value.
      Returns:
      This Builder instance.

    • build

      JavaFile build()
      Builds an instance of JavaFile from this builder.
      Returns:
      The JavaFile instance.

    • skipJavaLangImports

      JavaFile.Builder skipJavaLangImports(boolean flag)

      Call this to omit imports for classes from the package java.lang, such as String or Math.

      By default, JavaComposer explicitly imports types in java.lang to defend against naming conflicts. Suppose an (ill-advised) class is named com.example.String. When java.lang imports are skipped, generated code in com.example that references java.lang.String will get com.example.String instead.

      Parameters:
      flag - true means that the imports for classes from the package java.lang are skipped, false means that the imports are added explicitly.
      Returns:
      This Builder instance.