Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class EnumSpecImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.TypeSpecImpl

org.tquadrat.foundation.javacomposer.internal.EnumSpecImpl

All Implemented Interfaces:

TypeSpec

@ClassVersion(sourceVersion="$Id: EnumSpecImpl.java 1063 2023-09-26 15:14:16Z tquadrat $")
@API(status=INTERNAL,
     since="0.2.0")
public final class EnumSpecImpl
extends TypeSpecImpl

The implementation of TypeSpec for an enum type.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: EnumSpecImpl.java 1063 2023-09-26 15:14:16Z tquadrat $

Since:

0.2.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.internal.EnumSpecImpl"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EnumSpecImpl.BuilderImpl	The implementation of TypeSpec.Builder for enum types.

Nested classes/interfaces inherited from class org.tquadrat.foundation.javacomposer.internal.TypeSpecImpl

TypeSpecImpl.Kind

Nested classes/interfaces inherited from interface org.tquadrat.foundation.javacomposer.TypeSpec

TypeSpec.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,ClassSpecImpl>	m_EnumConstants	The enum constants for this type.

Fields inherited from class org.tquadrat.foundation.javacomposer.internal.TypeSpecImpl

NAME_ANONYMOUS_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EnumSpecImpl(EnumSpecImpl type)	Creates a dummy type spec for type-resolution in CodeWriter only while emitting the type declaration but before entering the type body.
	EnumSpecImpl(EnumSpecImpl.BuilderImpl builder)	Creates a new TypeSpecImpl instance.

Method Summary

Modifier and Type	Method	Description
protected final TypeSpecImpl	createCopy()	Creates a dummy copy of the type spec that is used by TypeSpecImpl.emit(CodeWriter, String, Set) internally.
protected final void	emit4Foundation(CodeWriter codeWriter, String enumName, Set<Modifier> implicitModifiers)	Emits the type to the given code writer, using the layout as defined by the Foundation library code.
protected final void	emit4JavaPoet(CodeWriter codeWriter, String enumName, Set<Modifier> implicitModifiers)	Emits the type to the given code writer, using the layout as defined by the original JavaPoet code.
final boolean	equals(Object o)
protected final Map<String,ClassSpecImpl>	getEnumConstants()	Returns the enum values for this type.
final int	hashCode()
final EnumSpecImpl.BuilderImpl	toBuilder()	Returns a new builder that is initialised with this TypeSpec instance.

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

anonymousTypeArguments, compareMethodSpecs, emit, getAnnotations, getFactory, getFieldSpecs, getInitializerBlock, getJavadoc, getMethodSpecs, getStaticBlock, getStaticImports, getSuperClass, getSuperInterfaces, getSuppressableWarnings, getTypeVariables, hasModifier, innerClasses, modifiers, name, originatingElements, toString, typeSpecs

Methods inherited from class java.lang.Object

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

Field Details

m_EnumConstants

private final Map<String,ClassSpecImpl> m_EnumConstants

The enum constants for this type.

Constructor Details

EnumSpecImpl

public EnumSpecImpl(EnumSpecImpl.BuilderImpl builder)

Creates a new TypeSpecImpl instance.

Parameters:

builder - The builder for this instance.

EnumSpecImpl

private EnumSpecImpl(EnumSpecImpl type)

Creates a dummy type spec for type-resolution in CodeWriter only while emitting the type declaration but before entering the type body.

Parameters:

type - The source type.

Method Details

createCopy

protected final TypeSpecImpl createCopy()

Creates a dummy copy of the type spec that is used by TypeSpecImpl.emit(CodeWriter, String, Set) internally.

Specified by:

createCopy in class TypeSpecImpl

Returns:

The dummy copy.

emit4Foundation

protected final void emit4Foundation(CodeWriter codeWriter,
 String enumName,
 Set<Modifier> implicitModifiers)
                              throws UncheckedIOException

Emits the type to the given code writer, using the layout as defined by the Foundation library code.

Specified by:

emit4Foundation in class TypeSpecImpl

Parameters:

codeWriter - The target code writer.

enumName - The name of the enum; can be null.

implicitModifiers - The implicit modifiers.

Throws:

UncheckedIOException - A problem occurred when writing to the output target.

emit4JavaPoet

protected final void emit4JavaPoet(CodeWriter codeWriter,
 String enumName,
 Set<Modifier> implicitModifiers)
                            throws UncheckedIOException

Emits the type to the given code writer, using the layout as defined by the original JavaPoet code.

Specified by:

emit4JavaPoet in class TypeSpecImpl

Parameters:

codeWriter - The target code writer.

enumName - The name of the enum; can be null.

implicitModifiers - The implicit modifiers.

Throws:

UncheckedIOException - A problem occurred when writing to the output target.

equals

public final boolean equals(Object o)

Specified by:

equals in interface TypeSpec

Specified by:

equals in class TypeSpecImpl

getEnumConstants

protected final Map<String,ClassSpecImpl> getEnumConstants()

Returns the enum values for this type.

Overrides:

getEnumConstants in class TypeSpecImpl

Returns:

The enum values.

hashCode

public final int hashCode()

Specified by:

hashCode in interface TypeSpec

Specified by:

hashCode in class TypeSpecImpl

toBuilder

public final EnumSpecImpl.BuilderImpl toBuilder()

Returns a new builder that is initialised with this TypeSpec instance.

Specified by:

toBuilder in interface TypeSpec

Specified by:

toBuilder in class TypeSpecImpl

Returns:

The new builder.