Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer

Class JavaComposer

java.lang.Object

org.tquadrat.foundation.javacomposer.JavaComposer

@ClassVersion(sourceVersion="$Id: JavaComposer.java 1105 2024-02-28 12:58:46Z tquadrat $")
@API(status=STABLE,
     since="0.2.0")
public final class JavaComposer
extends Object

The factory for the various JavaComposer artefacts.

Instances of this class do not maintain a state, therefore they are thread-safe without any synchronisation.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: JavaComposer.java 1105 2024-02-28 12:58:46Z tquadrat $

Since:

0.2.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.JavaComposer"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JAVADOC_TAG_INHERITDOC	The Javadoc tag for inherited documentation: "{@inheritDoc}".
static final String	JAVADOC_TAG_VALUE	The Javadoc tag for a constant value: "{@value}".
private final boolean	m_AddDebugOutput	If set to true, some debug information will be added to the output.
private final Lazy<AnnotationSpec>	m_Annotation_ClassVersion	The @ClassVersion annotation.
private final Lazy<AnnotationSpec>	m_Annotation_UtilityClass	The @UtilityClass annotation.
private final CodeProcessorPREVIEW	m_CodeProcessor	The code processor associated with this composer instance.
private final Lazy<CodeBlock>	m_JavaDoc_InheritDoc	The Javadoc comment for an overriding method.
private final Layout	m_Layout	The layout that is used to format the output.
private int	m_MaxFields	The maximum number of fields for a class; if this number is exceeded, an annotation @SuppressWarnings with SuppressableWarnings.CLASS_WITH_TOO_MANY_FIELDS will be added to the class.
private int	m_MaxMethods	The maximum number of methods for a class; if this number is exceeded, an annotation @SuppressWarnings with SuppressableWarnings.CLASS_WITH_TOO_MANY_METHODS will be added to the class.
private final Lazy<MethodSpec>	m_Method_Equals	A predefined equals() method.
private final Lazy<MethodSpec>	m_Method_HashCode	A predefined hashCode() method.
private final Lazy<MethodSpec>	m_Method_ToString	A predefined toString() method.
static final String	MSG_CannotOverrideFinalClass	Message: "Cannot override method on final class \'%s\'".
static final String	MSG_CannotOverrideMethod	Message: "Cannot override method with modifier \'%s\'".

Constructor Summary

Constructors

Constructor	Description
JavaComposer()	Creates a new instance of JavaComposer that uses the default Layout.
JavaComposer(boolean addDebugOutput)	Creates a new instance of JavaComposer that uses the default Layout and adds some debug information to the output.
JavaComposer(Layout layout)	Creates a new instance of JavaComposer.
JavaComposer(Layout layout, boolean addDebugOutput)	Creates a new instance of JavaComposer.

Method Summary

Modifier and Type	Method	Description
final boolean	addDebugOutput()	Returns the flag that controls whether the output should be enhanced with some debug information.
final AnnotationSpec.Builder	annotationBuilder(Class<?> type)	Creates a builder for an instance of an implementation for AnnotationSpec from the given Class instance.
final AnnotationSpec.Builder	annotationBuilder(ClassName type)	Creates a builder for an instance of an implementation for AnnotationSpec from the given ClassName instance.
final TypeSpec.Builder	annotationTypeBuilder(CharSequence name)	Creates a builder for an annotation.
final TypeSpec.Builder	annotationTypeBuilder(ClassName className)	Creates a builder for an annotation.
final TypeSpec.Builder	anonymousClassBuilder(String format, Object... args)	Creates a builder for an anonymous class.
final TypeSpec.Builder	anonymousClassBuilder(CodeBlock typeArguments)	Creates a builder for an anonymous class.
final TypeSpec.Builder	classBuilder(CharSequence name)	Creates a builder for a regular class.
final TypeSpec.Builder	classBuilder(ClassName className)	Creates a builder for a regular class.
final CodeBlock.Builder	codeBlockBuilder()	Creates a builder for an instance of CodeBlock.
final CodeBlock	codeBlockOf(String format, Object... args)	Creates a new CodeBlock instance from the given format and arguments.
final MethodSpec.Builder	constructorBuilder()	Creates a builder that builds an instance of MethodSpec for a constructor.
final AnnotationSpec	createAnnotation(Annotation annotation)	Creates an instance of AnnotationSpec from the given Annotation instance.
final AnnotationSpec	createAnnotation(Annotation annotation, boolean includeDefaultValues)	Creates an instance of AnnotationSpec from the given Annotation instance.
final AnnotationSpec	createAnnotation(AnnotationMirror annotation)	Creates an instance of AnnotationSpec from the given AnnotationMirror instance.
final AnnotationSpec	createClassVersionAnnotation()	Returns a @ClassVersion annotation with a default text for ClassVersion.sourceVersion().
final AnnotationSpec	createClassVersionAnnotation(String sourceVersion)	Returns a @ClassVersion annotation with the text for ClassVersion.sourceVersion().
private final CodeBlock	createComment4Constant(CodeBlock comment)	Creates the comment for a constant.
final FieldSpec	createConstant(CharSequence name, int value, CodeBlock comment)	Creates an integer constant.
final FieldSpec	createConstant(CharSequence name, Type type, CodeBlock value, CodeBlock comment)	Creates a constant.
final FieldSpec	createConstant(CharSequence name, String value, CodeBlock comment)	Creates a String constant.
private final FieldSpec	createConstant(CharSequence name, TypeName type, Number value, CodeBlock comment)	Creates a numerical constant.
final FieldSpec	createConstant(CharSequence name, TypeName type, CodeBlock value, CodeBlock comment)	Creates a constant. A constant is an initialised public final static field.
final MethodSpec.Builder	createEqualsBuilder()	Returns a builder for an implementation of the method Object.equals(Object) that just needs the method body for completion.
final MethodSpec	createEqualsMethod(CodeBlock body)	Returns a MethodSpec instance for an implementation of the method Object.equals(Object).
final MethodSpec.Builder	createHashCodeBuilder()	Returns a builder for an implementation of the method Object.hashCode() that just needs the method body for completion.
final MethodSpec	createHashCodeMethod(Collection<? extends FieldSpec> fields)	Returns a MethodSpec instance for an implementation of the method Object.hashCode().
final MethodSpec	createHashCodeMethod(CodeBlock body)	Returns a MethodSpec instance for an implementation of the method Object.hashCode().
final MethodSpec	createHashCodeMethod(FieldSpec... fields)	Returns a MethodSpec instance for an implementation of the method Object.hashCode().
final CodeBlock	createInheritDocComment()	Returns a code block with a comment for overriding methods:
final MethodSpec	createMethod(ExecutableElement method)	Creates a MethodSpec for the given ExecutableElement.
final ParameterSpec	createParameter(Parameter parameter)	Creates an instance of ParameterSpec from the given Parameter instance.
final ParameterSpec	createParameter(VariableElement element)	Creates an instance of ParameterSpec from the given VariableElement instance.
final CodeBlock	createReturnStatement()	Creates a return statement with a comment, using retValue as the name for the return variable.
final CodeBlock	createReturnStatement(CharSequence name)	Creates a return statement with a comment.
final TypeSpec.Builder	createStaticClassBuilder(CharSequence className)	Returns a builder for a static class.
final Optional<AnnotationSpec>	createSuppressWarningsAnnotation(Collection<SuppressableWarnings> warnings)	Returns a @SuppressWarnings annotation with the given values.
final Optional<AnnotationSpec>	createSuppressWarningsAnnotation(SuppressableWarnings... warnings)	Returns a @SuppressWarnings annotation with the given values.
final MethodSpec.Builder	createToStringBuilder()	Returns a builder for an implementation of the method Object.toString() that just needs the method body for completion.
final MethodSpec	createToStringMethod(CodeBlock body)	Returns a MethodSpec instance for an implementation of the method Object.toString().
final AnnotationSpec	createUtilityClassAnnotation()	Returns a @UtilityClass annotation.
final CodeBlock	emptyCodeBlock()	Returns an empty CodeBlock.
final TypeSpec.Builder	enumBuilder(CharSequence name)	Creates a builder for an enum type.
final TypeSpec.Builder	enumBuilder(ClassName className)	Creates a builder for an enum type.
final boolean	equals(Object o)
final FieldSpec.Builder	fieldBuilder(Type type, CharSequence name, Modifier... modifiers)	Creates a builder for an instance of FieldSpec from the given type, name and modifiers.
final FieldSpec.Builder	fieldBuilder(TypeName type, CharSequence name, Modifier... modifiers)	Creates a builder for an instance of FieldSpec from the given type, name and modifiers.
final FieldSpec.Builder	fieldBuilder(TypeSpec type, CharSequence name, Modifier... modifiers)	Creates a builder for an instance of FieldSpec from the given type, name and modifiers.
final CodeProcessorPREVIEW	getCodeProcessor()	Provides access to the code processor for this composer instance.
final Layout	getLayout()	Returns the layout that is used to format the output.
final int	getMaxFields()	Returns the maximum number of fields for a class.
final int	getMaxMethods()	Returns the maximum number of methods for a class.
final int	hashCode()
final TypeSpec.Builder	interfaceBuilder(CharSequence name)	Creates a builder for an interface.
final TypeSpec.Builder	interfaceBuilder(ClassName className)	Creates a builder for an interface.
final JavaFile.Builder	javaFileBuilder(CharSequence packageName, TypeSpec typeSpec)	Creates a builder for a new instance of JavaFile from the given package name and class definition.
final LambdaSpec.Builder	lambdaBuilder()	Creates a builder for an instance of LambdaSpec.
final MethodSpec.Builder	methodBuilder(CharSequence name)	Returns a builder for a regular method.
final MethodSpec.Builder	overridingMethodBuilder(Method method)	Returns a new method builder for a method that overrides the given method.
final MethodSpec.Builder	overridingMethodBuilder(ExecutableElement method)	Returns a new method builder for a method that overrides the given method.
final MethodSpec.Builder	overridingMethodBuilder(ExecutableElement method, DeclaredType enclosing, Types typeUtils)	Returns a new method builder that overrides the given method as a member of of the given enclosing class.
final ParameterSpec.Builder	parameterBuilder(Type type, CharSequence name, Modifier... modifiers)	Creates a builder for a new ParameterSpec instance.
final ParameterSpec.Builder	parameterBuilder(TypeName type, CharSequence name, Modifier... modifiers)	Creates a builder for a new ParameterSpec instance.
final ParameterSpec	parameterOf(Type type, CharSequence name, Modifier... modifiers)	Creates a new ParameterSpec instance for the given arguments.
final ParameterSpec	parameterOf(TypeName type, CharSequence name, Modifier... modifiers)	Creates a new ParameterSpec instance for the given arguments.
final List<ParameterSpec>	parametersOf(Method method)	Retrieves the parameters from the given method.
final List<ParameterSpec>	parametersOf(ExecutableElement method)	Retrieves th e parameters from the given method.
final TypeSpec.Builder	recordBuilder(CharSequence name)	Creates a builder for a record.
final TypeSpec.Builder	recordBuilder(ClassName className)	Creates a builder for a record.
final void	setMaxFields(int value)	Sets the maximum number of fields for a class.
final void	setMaxMethods(int value)	Sets the maximum number of methods for a class.
final CodeBlock	statementOf(String format, Object... args)	Creates a new CodeBlock instance from the given format and arguments, using CodeBlock.Builder.addStatement(String, Object...).

Methods inherited from class java.lang.Object

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

Field Details

JAVADOC_TAG_INHERITDOC

public static final String JAVADOC_TAG_INHERITDOC

The Javadoc tag for inherited documentation: "{@inheritDoc}".

See Also:

• Constant Field Values

JAVADOC_TAG_VALUE

public static final String JAVADOC_TAG_VALUE

The Javadoc tag for a constant value: "{@value}".

See Also:

• Constant Field Values

MSG_CannotOverrideFinalClass

public static final String MSG_CannotOverrideFinalClass

Message: "Cannot override method on final class \'%s\'".

See Also:

• Constant Field Values

MSG_CannotOverrideMethod

public static final String MSG_CannotOverrideMethod

Message: "Cannot override method with modifier \'%s\'".

See Also:

• Constant Field Values

m_AddDebugOutput

private final boolean m_AddDebugOutput

If set to true, some debug information will be added to the output.

m_Annotation_ClassVersion

private final Lazy<AnnotationSpec> m_Annotation_ClassVersion

The @ClassVersion annotation.

m_Annotation_UtilityClass

private final Lazy<AnnotationSpec> m_Annotation_UtilityClass

The @UtilityClass annotation.

m_CodeProcessor

private final CodeProcessorPREVIEW m_CodeProcessor

The code processor associated with this composer instance.

m_JavaDoc_InheritDoc

private final Lazy<CodeBlock> m_JavaDoc_InheritDoc

The Javadoc comment for an overriding method.

m_Layout

private final Layout m_Layout

The layout that is used to format the output.

m_MaxFields

private int m_MaxFields

The maximum number of fields for a class; if this number is exceeded, an annotation @SuppressWarnings with SuppressableWarnings.CLASS_WITH_TOO_MANY_FIELDS will be added to the class.

m_MaxMethods

private int m_MaxMethods

The maximum number of methods for a class; if this number is exceeded, an annotation @SuppressWarnings with SuppressableWarnings.CLASS_WITH_TOO_MANY_METHODS will be added to the class.

m_Method_Equals

private final Lazy<MethodSpec> m_Method_Equals

A predefined equals() method.

m_Method_HashCode

private final Lazy<MethodSpec> m_Method_HashCode

A predefined hashCode() method.

m_Method_ToString

private final Lazy<MethodSpec> m_Method_ToString

A predefined toString() method.

Constructor Details

JavaComposer

public JavaComposer()

Creates a new instance of JavaComposer that uses the default Layout.

JavaComposer

public JavaComposer(Layout layout)

Creates a new instance of JavaComposer.

Parameters:

layout - The layout that is used to format the output.

JavaComposer

public JavaComposer(boolean addDebugOutput)

Creates a new instance of JavaComposer that uses the default Layout and adds some debug information to the output.

Parameters:

addDebugOutput - true if debug information should be added, false if not.

JavaComposer

public JavaComposer(Layout layout,
 boolean addDebugOutput)

Creates a new instance of JavaComposer.

Parameters:

layout - The layout that is used to format the output.

addDebugOutput - true if debug information should be added, false if not.

Method Details

addDebugOutput

public final boolean addDebugOutput()

Returns the flag that controls whether the output should be enhanced with some debug information.

Returns:

true if the debug information should be added to the output, false otherwise.

annotationBuilder

public final AnnotationSpec.Builder annotationBuilder(ClassName type)

Creates a builder for an instance of an implementation for AnnotationSpec from the given ClassName instance.

This builder generates the code for the use of an annotation, while the builders returned from annotationTypeBuilder(CharSequence) and annotationTypeBuilder(ClassName) will generate new annotation types.

Parameters:

type - The class name.

Returns:

The new builder.

annotationBuilder

public final AnnotationSpec.Builder annotationBuilder(Class<?> type)

Creates a builder for an instance of an implementation for AnnotationSpec from the given Class instance.

This builder generates the code for the use of an annotation, while the builders returned from annotationTypeBuilder(CharSequence) and annotationTypeBuilder(ClassName) will generate new annotation types.

Parameters:

type - The class.

Returns:

The new builder.

annotationTypeBuilder

public final TypeSpec.Builder annotationTypeBuilder(ClassName className)

Creates a builder for an annotation.

This method creates a builder for a new annotation, while annotationBuilder(ClassName) and annotationBuilder(Class) will create the builder for the use of an annotation.

Parameters:

className - The name of the annotation.

Returns:

The builder.

annotationTypeBuilder

public final TypeSpec.Builder annotationTypeBuilder(CharSequence name)

Creates a builder for an annotation.

This method creates a builder for a new annotation, while annotationBuilder(ClassName) and annotationBuilder(Class) will create the builder for the use of an annotation.

Parameters:

name - The name of the annotation.

Returns:

The builder.

anonymousClassBuilder

public final TypeSpec.Builder anonymousClassBuilder(CodeBlock typeArguments)

Creates a builder for an anonymous class.

Parameters:

typeArguments - The type arguments.

Returns:

The builder.

anonymousClassBuilder

public final TypeSpec.Builder anonymousClassBuilder(String format,
 Object... args)

Creates a builder for an anonymous class. This method is the shortcut for

  CodeBlock codeBlock = codeBlockBuilder()
      .add( format, args )
      .build();
  TypeSpec.Builder builder = anonymousClassBuilder( codeBlock ); 

Parameters:

format - The format for the code; may be empty.

args - The arguments for the code.

Returns:

The builder.

See Also:

• codeBlockBuilder()
• anonymousClassBuilder(CodeBlock)

classBuilder

public final TypeSpec.Builder classBuilder(ClassName className)

Creates a builder for a regular class.

Parameters:

className - The name of the class.

Returns:

The builder.

classBuilder

public final TypeSpec.Builder classBuilder(CharSequence name)

Creates a builder for a regular class.

Parameters:

name - The name of the class.

Returns:

The builder.

codeBlockBuilder

public final CodeBlock.Builder codeBlockBuilder()

Creates a builder for an instance of CodeBlock.

Returns:

The new builder.

codeBlockOf

public final CodeBlock codeBlockOf(String format,
 Object... args)

Creates a new CodeBlock instance from the given format and arguments.

Note:

• No debug info will be added.

Parameters:

format - The format.

args - The arguments.

Returns:

The new code block.

constructorBuilder

public final MethodSpec.Builder constructorBuilder()

Creates a builder that builds an instance of MethodSpec for a constructor.

Returns:

The builder.

createAnnotation

public final AnnotationSpec createAnnotation(Annotation annotation)

Creates an instance of AnnotationSpec from the given Annotation instance.

Parameters:

annotation - The annotation.

Returns:

The new instance of AnnotationSpec.

createAnnotation

public final AnnotationSpec createAnnotation(Annotation annotation,
 boolean includeDefaultValues)

Creates an instance of AnnotationSpec from the given Annotation instance.

Parameters:

annotation - The annotation.

includeDefaultValues - true to include the annotation's default values, false to ignore them.

Returns:

The new instance of AnnotationSpec.

createAnnotation

public final AnnotationSpec createAnnotation(AnnotationMirror annotation)

Creates an instance of AnnotationSpec from the given AnnotationMirror instance.

Parameters:

annotation - The annotation mirror.

Returns:

The new instance of AnnotationSpec.

createClassVersionAnnotation

public final AnnotationSpec createClassVersionAnnotation()

Returns a @ClassVersion annotation with a default text for ClassVersion.sourceVersion().

Returns:

The annotation.

See Also:

• ClassVersion

createClassVersionAnnotation

public final AnnotationSpec createClassVersionAnnotation(String sourceVersion)

Returns a @ClassVersion annotation with the text for ClassVersion.sourceVersion().

Parameters:

sourceVersion - The text.

Returns:

The annotation.

See Also:

• ClassVersion

createComment4Constant

private final CodeBlock createComment4Constant(CodeBlock comment)

Creates the comment for a constant.

Parameters:

comment - The already existing comment; can be null.

Returns:

The comment for the new constant.

createConstant

public final FieldSpec createConstant(CharSequence name,
 String value,
 CodeBlock comment)

Creates a String constant.

A constant is an initialised public static final field.

Parameters:

name - The name of the constant.

value - The value of the constant.

comment - The description for the constant.

Returns:

The field spec for the new constant.

createConstant

private final FieldSpec createConstant(CharSequence name,
 TypeName type,
 Number value,
 CodeBlock comment)

Creates a numerical constant.

A constant is an initialised public static final field.

Parameters:

name - The name of the constant.

type - The type of the constant.

value - The value of the constant.

comment - The description for the constant.

Returns:

The field spec for the new constant.

createConstant

public final FieldSpec createConstant(CharSequence name,
 int value,
 CodeBlock comment)

Creates an integer constant.

A constant is an initialised public static final field.

Parameters:

name - The name of the constant.

value - The value of the constant.

comment - The description for the constant.

Returns:

The field spec for the new constant.

createConstant

public final FieldSpec createConstant(CharSequence name,
 Type type,
 CodeBlock value,
 CodeBlock comment)

Creates a constant.

A constant is an initialised public static final field.

Parameters:

name - The name of the constant.

type - The type of the constant.

value - The value of the constant.

comment - The description for the constant.

Returns:

The field spec for the new constant.

createConstant

public final FieldSpec createConstant(CharSequence name,
 TypeName type,
 CodeBlock value,
 CodeBlock comment)

Creates a constant.

A constant is an initialised public final static field.

Parameters:

name - The name of the constant.

type - The type of the constant.

value - The value of the constant.

comment - The description for the constant.

Returns:

The field spec for the new constant.

createEqualsBuilder

public final MethodSpec.Builder createEqualsBuilder()

Returns a builder for an implementation of the method Object.equals(Object) that just needs the method body for completion.

The argument has the name "o".

Returns:

The method builder.

createEqualsMethod

public final MethodSpec createEqualsMethod(CodeBlock body)

Returns a MethodSpec instance for an implementation of the method Object.equals(Object).

The argument has the name "o".

Parameters:

body - The method body.

Returns:

The method specification.

createHashCodeBuilder

public final MethodSpec.Builder createHashCodeBuilder()

Returns a builder for an implementation of the method Object.hashCode() that just needs the method body for completion.

Returns:

The method builder.

createHashCodeMethod

public final MethodSpec createHashCodeMethod(CodeBlock body)

Returns a MethodSpec instance for an implementation of the method Object.hashCode().

Parameters:

body - The method body.

Returns:

The method specification.

createHashCodeMethod

public final MethodSpec createHashCodeMethod(FieldSpec... fields)

Returns a MethodSpec instance for an implementation of the method Object.hashCode().

The created method uses Objects.hash(Object...) for the implementation.

Parameters:

fields - The fields that are used for the calculation of the hash code value.

Returns:

The method specification.

createHashCodeMethod

public final MethodSpec createHashCodeMethod(Collection<? extends FieldSpec> fields)

Returns a MethodSpec instance for an implementation of the method Object.hashCode().

The created method uses Objects.hash(Object...) for the implementation.

Parameters:

fields - The fields that are used for the calculation of the hash code value.

Returns:

The method specification.

createInheritDocComment

public final CodeBlock createInheritDocComment()

Returns a code block with a comment for overriding methods:

  /**
   * {@inheritDoc}
   */

Returns:

The comment.

createMethod

public final MethodSpec createMethod(ExecutableElement method)

Creates a MethodSpec for the given ExecutableElement.

This method copies visibility modifiers, type parameters, return type, name, parameters, and throws declarations, but not the body (if any).

Note:

• The annotations will not be copied and must be added separately.

Parameters:

method - The method to override.

Returns:

The builder.

createParameter

public final ParameterSpec createParameter(VariableElement element)

Creates an instance of ParameterSpec from the given VariableElement instance.

Parameters:

element - The variable element.

Returns:

The parameter spec.

createParameter

public final ParameterSpec createParameter(Parameter parameter)

Creates an instance of ParameterSpec from the given Parameter instance.

Parameters:

parameter - The variable element.

Returns:

The parameter spec.

createReturnStatement

public final CodeBlock createReturnStatement()

Creates a return statement with a comment, using retValue as the name for the return variable.

Returns:

The return statement.

createReturnStatement

public final CodeBlock createReturnStatement(CharSequence name)

Creates a return statement with a comment.

Parameters:

name - The name of the variable that is returned.

Returns:

The return statement.

createStaticClassBuilder

public final TypeSpec.Builder createStaticClassBuilder(CharSequence className)

Returns a builder for a static class.

A static class is a final class with a private constructor that has only static members; no instances are allowed for such a class, so none of the static methods are factories for that class.

This would be the skeleton for the new static class:

  <package what.ever.package.was.chosen>;

  import org.tquadrat.foundation.annotation.ClassVersion;
  import org.tquadrat.foundation.annotation.UtilityClass;
  import org.tquadrat.foundation.exception.PrivateConstructorForStaticClassCalledError;

  @UtilityClass
  @ClassVersion(sourceVersion = "Generated with JavaComposer", isGenerated = true)
  public final class StaticClass {
    /**
     * No instance allowed for this class!
     */
    private StaticClass() {
      throw new PrivateConstructorForStaticClassCalledError( StaticClass.class );
    }
  }

Parameters:

className - The name of the new class.

Returns:

The builder.

See Also:

• ClassVersion
• PrivateConstructorForStaticClassCalledError
• UtilityClass

createSuppressWarningsAnnotation

public final Optional<AnnotationSpec> createSuppressWarningsAnnotation(Collection<SuppressableWarnings> warnings)

Returns a @SuppressWarnings annotation with the given values. No annotation will be created if the given collection is empty.

Parameters:

warnings - The warnings to suppress.

Returns:

An instance of Optional that holds the new annotation.

createSuppressWarningsAnnotation

public final Optional<AnnotationSpec> createSuppressWarningsAnnotation(SuppressableWarnings... warnings)

Returns a @SuppressWarnings annotation with the given values. No annotation will be created if the given collection is empty.

Parameters:

warnings - The warnings to suppress.

Returns:

An instance of Optional that holds the new annotation.

createToStringBuilder

public final MethodSpec.Builder createToStringBuilder()

Returns a builder for an implementation of the method Object.toString() that just needs the method body for completion.

Returns:

The method builder.

createToStringMethod

public final MethodSpec createToStringMethod(CodeBlock body)

Returns a MethodSpec instance for an implementation of the method Object.toString().

Parameters:

body - The method body.

Returns:

The method specification.

createUtilityClassAnnotation

public final AnnotationSpec createUtilityClassAnnotation()

Returns a @UtilityClass annotation.

Returns:

The annotation.

See Also:

• UtilityClass

emptyCodeBlock

public final CodeBlock emptyCodeBlock()

Returns an empty CodeBlock.

Returns:

An empty code block.

enumBuilder

public final TypeSpec.Builder enumBuilder(ClassName className)

Creates a builder for an enum type.

Parameters:

className - The name of the class.

Returns:

The builder.

enumBuilder

public final TypeSpec.Builder enumBuilder(CharSequence name)

Creates a builder for an enum type.

Parameters:

name - The name of the class.

Returns:

The builder.

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

fieldBuilder

public final FieldSpec.Builder fieldBuilder(Type type,
 CharSequence name,
 Modifier... modifiers)

Creates a builder for an instance of FieldSpec from the given type, name and modifiers.

Parameters:

type - The type of the FieldSpec to build.

name - The name for the new field.

modifiers - The modifiers.

Returns:

The new builder.

fieldBuilder

public final FieldSpec.Builder fieldBuilder(TypeName type,
 CharSequence name,
 Modifier... modifiers)

Creates a builder for an instance of FieldSpec from the given type, name and modifiers.

Parameters:

type - The type of the FieldSpec to build.

name - The name for the new field.

modifiers - The modifiers.

Returns:

The new builder.

fieldBuilder

public final FieldSpec.Builder fieldBuilder(TypeSpec type,
 CharSequence name,
 Modifier... modifiers)

Creates a builder for an instance of FieldSpec from the given type, name and modifiers.

Parameters:

type - The type of the FieldSpec to build.

name - The name for the new field.

modifiers - The modifiers.

Returns:

The new builder.

getCodeProcessor

public final CodeProcessorPREVIEW getCodeProcessor()

Provides access to the code processor for this composer instance.

Returns:

The code processor.

getLayout

public final Layout getLayout()

Returns the layout that is used to format the output.

Returns:

The layout.

getMaxFields

public final int getMaxFields()

Returns the maximum number of fields for a class. If this number is exceeded, an annotation @SuppressWarnings with SuppressableWarnings.CLASS_WITH_TOO_MANY_FIELDS will be added to the class.

Returns:

The maximum number of fields.

getMaxMethods

public final int getMaxMethods()

Returns the maximum number of methods for a class. If this number is exceeded, an annotation @SuppressWarnings with SuppressableWarnings.CLASS_WITH_TOO_MANY_METHODS will be added to the class.

Returns:

The maximum number of fields.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

interfaceBuilder

public final TypeSpec.Builder interfaceBuilder(ClassName className)

Creates a builder for an interface.

Parameters:

className - The name of the class.

Returns:

The builder.

interfaceBuilder

public final TypeSpec.Builder interfaceBuilder(CharSequence name)

Creates a builder for an interface.

Parameters:

name - The name of the class.

Returns:

The builder.

javaFileBuilder

public final JavaFile.Builder javaFileBuilder(CharSequence packageName,
 TypeSpec typeSpec)

Creates a builder for a new instance of JavaFile from the given package name and class definition.

Parameters:

packageName - The package name; may be empty for the default package.

typeSpec - The class definition.

Returns:

The builder.

lambdaBuilder

public final LambdaSpec.Builder lambdaBuilder()

Creates a builder for an instance of LambdaSpec.

Returns:

The new builder.

methodBuilder

public final MethodSpec.Builder methodBuilder(CharSequence name)

Returns a builder for a regular method.

Parameters:

name - The name for the method.

Returns:

The builder.

overridingMethodBuilder

public final MethodSpec.Builder overridingMethodBuilder(ExecutableElement method)

Returns a new method builder for a method that overrides the given method.

This new builder will copy visibility modifiers, type parameters, return type, name, parameters, and throws declarations. An Override annotation will be added.

Note:

• In JavaPoet 1.2 through 1.7 this method retained annotations from the method and parameters of the overridden method. Since JavaPoet 1.8 and in JavaComposer annotations must be added separately.

Parameters:

method - The method to override.

Returns:

The builder.

overridingMethodBuilder

public final MethodSpec.Builder overridingMethodBuilder(ExecutableElement method,
 DeclaredType enclosing,
 Types typeUtils)

Returns a new method builder that overrides the given method as a member of of the given enclosing class. This will resolve type parameters: for example overriding Comparable.compareTo(T) in a type that implements Comparable<Movie>, the T parameter will be resolved to Movie.

This will copy its visibility modifiers, type parameters, return type, name, parameters, and throws declarations. An Override annotation will be added.

Note:

• In JavaPoet 1.2 through 1.7 this method retained annotations from the method and parameters of the overridden method. Since JavaPoet 1.8 and in JavaComposer annotations must be added separately.

Parameters:

method - The method to override.

enclosing - The enclosing class for the method.

typeUtils - An implementation of some utility methods for operating on types, as provided by the processing environment of an annotation processor.

Returns:

The builder.

overridingMethodBuilder

public final MethodSpec.Builder overridingMethodBuilder(Method method)

Returns a new method builder for a method that overrides the given method.

This new builder will copy visibility modifiers, type parameters, return type, name, parameters, and throws declarations. An Override annotation will be added, but any other annotation will be omitted; this is consistent with the behaviour of overridingMethodBuilder(ExecutableElement) and overridingMethodBuilder(ExecutableElement, DeclaredType, Types).

Parameters:

method - The method to override.

Returns:

The builder.

parameterBuilder

public final ParameterSpec.Builder parameterBuilder(Type type,
 CharSequence name,
 Modifier... modifiers)

Creates a builder for a new ParameterSpec instance.

Parameters:

type - The type of the new parameter.

name - The name of the new parameter.

modifiers - The modifiers for the new parameter.

Returns:

The builder.

parameterBuilder

public final ParameterSpec.Builder parameterBuilder(TypeName type,
 CharSequence name,
 Modifier... modifiers)

Creates a builder for a new ParameterSpec instance.

Parameters:

type - The type of the new parameter.

name - The name of the new parameter.

modifiers - The modifiers for the new parameter.

Returns:

The builder.

parameterOf

public final ParameterSpec parameterOf(Type type,
 CharSequence name,
 Modifier... modifiers)

Creates a new ParameterSpec instance for the given arguments.

Parameters:

type - The type of the new parameter.

name - The name of the new parameter.

modifiers - The modifiers for the new parameter.

Returns:

The parameter specification.

parameterOf

public final ParameterSpec parameterOf(TypeName type,
 CharSequence name,
 Modifier... modifiers)

Creates a new ParameterSpec instance for the given arguments.

Parameters:

type - The type of the new parameter.

name - The name of the new parameter.

modifiers - The modifiers for the new parameter.

Returns:

The parameter specification.

parametersOf

public final List<ParameterSpec> parametersOf(ExecutableElement method)

Retrieves th e parameters from the given method.

Parameters:

method - The method.

Returns:

The parameters of the given method; the returned list can be empty, but it will not be null.

parametersOf

public final List<ParameterSpec> parametersOf(Method method)

Retrieves the parameters from the given method.

Parameters:

method - The method.

Returns:

The parameters of the given method; the returned list can be empty, but it will not be null.

recordBuilder

public final TypeSpec.Builder recordBuilder(ClassName className)

Creates a builder for a record.

Parameters:

className - The name of the record type.

Returns:

The builder.

recordBuilder

public final TypeSpec.Builder recordBuilder(CharSequence name)

Creates a builder for a record.

Parameters:

name - The name of the record type.

Returns:

The builder.

setMaxFields

public final void setMaxFields(int value)

Sets the maximum number of fields for a class. If this number is exceeded, an annotation @SuppressWarnings with SuppressableWarnings.CLASS_WITH_TOO_MANY_FIELDS will be added to the class.

Setting the value to 0 or a negative value will disable this feature.

Parameters:

value - The value.

setMaxMethods

public final void setMaxMethods(int value)

Sets the maximum number of methods for a class. If this number is exceeded, an annotation @SuppressWarnings with SuppressableWarnings.CLASS_WITH_TOO_MANY_METHODS will be added to the class.

Setting the value to 0 or a negative value will disable this feature.

Parameters:

value - The value.

statementOf

public final CodeBlock statementOf(String format,
 Object... args)

Creates a new CodeBlock instance from the given format and arguments, using CodeBlock.Builder.addStatement(String, Object...).

Note:

• No debug info will be added.

Parameters:

format - The format.

args - The arguments.

Returns:

The new code block.