Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class InterfaceSpecImpl.BuilderImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.TypeSpecImpl.BuilderImpl

org.tquadrat.foundation.javacomposer.internal.InterfaceSpecImpl.BuilderImpl

All Implemented Interfaces:

TypeSpec.Builder

Enclosing class:

InterfaceSpecImpl

@ClassVersion(sourceVersion="$Id: InterfaceSpecImpl.java 1064 2023-09-26 20:16:12Z tquadrat $")
@API(status=INTERNAL,
     since="0.2.0")
public static final class InterfaceSpecImpl.BuilderImpl
extends TypeSpecImpl.BuilderImpl

The implementation of TypeSpec.Builder for an interface.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: InterfaceSpecImpl.java 1064 2023-09-26 20:16:12Z tquadrat $

Since:

0.2.0

UML Diagram

⁠

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

⁠

Constructor Summary

Constructors

Constructor	Description
BuilderImpl(JavaComposer composer, CharSequence name)	Creates a new BuilderImpl instance.
BuilderImpl(JavaComposer composer, Optional<String> name)	Creates a new BuilderImpl instance.

Method Summary

Modifier and Type	Method	Description
final InterfaceSpecImpl.BuilderImpl	addAttribute(FieldSpec fieldSpec, boolean readOnly)	Adds an attribute to this type.
final InterfaceSpecImpl.BuilderImpl	addField(FieldSpec fieldSpec)	Adds a field to this type.
final InterfaceSpecImpl.BuilderImpl	addInitializerBlock(CodeBlock block)	Adds code to the initializer block.
final InterfaceSpecImpl.BuilderImpl	addMethod(MethodSpec methodSpec)	Adds a method for the type.
final TypeSpec.Builder	addProperty(FieldSpec fieldSpec, boolean readOnly)	Adds a JavaBean property to this type.
final InterfaceSpecImpl	build()	Builds a new TypeSpec instance from the added components.
final InterfaceSpecImpl.BuilderImpl	superclass(TypeName superclass)	Sets the superclass for the type.

Methods inherited from class org.tquadrat.foundation.javacomposer.internal.TypeSpecImpl.BuilderImpl

addAnnotation, addAnnotation, addAnnotation, addAnnotations, addEnumConstant, addEnumConstant, addEnumConstant, addEnumConstant, addField, addField, addFields, addJavadoc, addJavadoc, addMethods, addModifiers, addOriginatingElement, addStaticBlock, addStaticImport, addStaticImport, addStaticImport, addSuperinterface, addSuperinterface, addSuperinterface, addSuperinterface, addSuperinterfaces, addSuppressableWarning, addType, addTypes, addTypeVariable, addTypeVariable, addTypeVariables, composer, getAnnotations, getAnonymousTypeArguments, getEnumConstants, getFactory, getFieldSpecs, getInitializerBlock, getJavadoc, getMethodSpecs, getModifiers, getName, getStaticBlock, getStaticImports, getSuperclass, getSuperinterfaces, getTypeSpecs, getTypeVariables, isAnonymousClass, superclass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BuilderImpl

public BuilderImpl(JavaComposer composer,
 CharSequence name)

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.

BuilderImpl

public BuilderImpl(JavaComposer composer,
 Optional<String> name)

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.

Method Details

addAttribute

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

addField

public final InterfaceSpecImpl.BuilderImpl addField(FieldSpec fieldSpec)

Adds a field to this type.

Specified by:

addField in interface TypeSpec.Builder

Overrides:

addField in class TypeSpecImpl.BuilderImpl

Parameters:

fieldSpec - The field definition.

Returns:

This Builder instance.

addInitializerBlock

public final InterfaceSpecImpl.BuilderImpl addInitializerBlock(CodeBlock block)

Adds code to the initializer block.

Specified by:

addInitializerBlock in interface TypeSpec.Builder

Overrides:

addInitializerBlock in class TypeSpecImpl.BuilderImpl

Parameters:

block - The code.

Returns:

This Builder instance.

addMethod

public final InterfaceSpecImpl.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 InterfaceSpecImpl 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.

superclass

public final InterfaceSpecImpl.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.