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

Class ClassSpecImpl.BuilderImpl

java.lang.Object
org.tquadrat.foundation.javacomposer.internal.TypeSpecImpl.BuilderImpl
org.tquadrat.foundation.javacomposer.internal.ClassSpecImpl.BuilderImpl
All Implemented Interfaces:
TypeSpec.Builder
Enclosing class:
ClassSpecImpl
@ClassVersion(sourceVersion="$Id: ClassSpecImpl.java 1105 2024-02-28 12:58:46Z tquadrat $") @API(status=INTERNAL, since="0.2.0") public static final class ClassSpecImpl.BuilderImpl extends TypeSpecImpl.BuilderImpl
The implementation of TypeSpec.Builder for a class.
Author:
Square,Inc.
Modified by:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: ClassSpecImpl.java 1105 2024-02-28 12:58:46Z tquadrat $
Since:
0.2.0
UML Diagram
UML Diagram for "org.tquadrat.foundation.javacomposer.internal.ClassSpecImpl.BuilderImpl"⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.internal.ClassSpecImpl.BuilderImpl"

UML Diagram for "org.tquadrat.foundation.javacomposer.internal.ClassSpecImpl.BuilderImpl"⁠

  • Field Details

  • Constructor Details

    • BuilderImpl

      public BuilderImpl(JavaComposer composer, CharSequence name, CodeBlockImpl anonymousTypeArguments)
      Creates a new BuilderImpl instance.
      Parameters:
      composer - The reference to the factory that created this builder instance.
      name - The name of the type to build.
      anonymousTypeArguments - Anonymous type arguments.

    • BuilderImpl

      public BuilderImpl(JavaComposer composer, CodeBlockImpl anonymousTypeArguments)
      Creates a new BuilderImpl instance for an anonymous type.
      Parameters:
      composer - The reference to the factory that created this builder instance.
      anonymousTypeArguments - Anonymous type arguments.

    • BuilderImpl

      public BuilderImpl(JavaComposer composer, Optional<String> name, CodeBlockImpl anonymousTypeArguments)
      Creates a new BuilderImpl instance.
      Parameters:
      composer - The reference to the factory that created this builder instance.
      name - The name of the type to build.
      anonymousTypeArguments - Anonymous type arguments.

  • Method Details

    • addAttribute

      @API(status=STABLE, since="0.2.0") public final ClassSpecImpl.BuilderImpl addAttribute(FieldSpec fieldSpec, boolean readOnly)

      Adds an attribute to this type.

      An attribute is basically a field with the related accessor and mutator methods.

      If the name for a non-final property will be text, and its type is java.lang.String, the generated code will look basically like this:

        …
  private String m_Text;
  …
  public final String text() { return m_Text; }
  …
  public final void text( final String value ) { m_Text = text; }
  …

      If accessor or mutator needs to be more complex, the respective methods must be created manually.

      Specified by:
      addAttribute in interface TypeSpec.Builder
      Specified by:
      addAttribute in class TypeSpecImpl.BuilderImpl
      Parameters:
      fieldSpec - The field definition.
      readOnly - true if no mutator should be created even for a non-final field, false if a mutator has to be created for a non-final field. Will ignored if the field is final.
      Returns:
      This Builder instance.

    • addMethod

      public final ClassSpecImpl.BuilderImpl addMethod(MethodSpec methodSpec)
      Adds a method for the type.
      Specified by:
      addMethod in interface TypeSpec.Builder
      Specified by:
      addMethod in class TypeSpecImpl.BuilderImpl
      Parameters:
      methodSpec - The method.
      Returns:
      This Builder instance.

    • addProperty

      public final TypeSpec.Builder addProperty(FieldSpec fieldSpec, boolean readOnly)

      Adds a JavaBean property to this type.

      A property is basically a field with the related getter and setter methods.

      If the name for a non-final property will be text, and its type is java.lang.String, the generated code will look basically like this:

        …
  private String m_Text;
  …
  public final String getText() { return m_Text; }
  …
  public final void setText( final String value ) { m_Text = text; }
  …

      If getter or setter needs to be more complex, the respective methods must be created manually.

      Specified by:
      addProperty in interface TypeSpec.Builder
      Specified by:
      addProperty in class TypeSpecImpl.BuilderImpl
      Parameters:
      fieldSpec - The field definition.
      readOnly - true if no setter should be created even for a non-final field, false if a setter has to be created for a non-final field. Will ignored if the field is final.
      Returns:
      This Builder instance.

    • build

      public final ClassSpecImpl build()
      Builds a new TypeSpec instance from the added components.
      Specified by:
      build in interface TypeSpec.Builder
      Specified by:
      build in class TypeSpecImpl.BuilderImpl
      Returns:
      The new TypeSpec instance.

    • getAnonymousTypeArguments

      protected final Optional<CodeBlockImpl> getAnonymousTypeArguments()
      Returns the anonymous type arguments for the new type.
      Overrides:
      getAnonymousTypeArguments in class TypeSpecImpl.BuilderImpl
      Returns:
      An instance of Optional that holds the codeblock with the anonymous type arguments.

    • isAnonymousClass

      public final boolean isAnonymousClass()
      Returns a flag whether this class is an anonymous class or not.
      Overrides:
      isAnonymousClass in class TypeSpecImpl.BuilderImpl
      Returns:
      true if the class is an anonymous class, false if it is named.

    • superclass

      public final ClassSpecImpl.BuilderImpl superclass(TypeName superclass)

      Sets the superclass for the type. This class is extended by the new type.

      Specified by:
      superclass in interface TypeSpec.Builder
      Overrides:
      superclass in class TypeSpecImpl.BuilderImpl
      Parameters:
      superclass - The superclass.
      Returns:
      This Builder instance.