Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class FieldSpecImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.FieldSpecImpl

All Implemented Interfaces:

FieldSpec

@ClassVersion(sourceVersion="$Id: FieldSpecImpl.java 1105 2024-02-28 12:58:46Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public final class FieldSpecImpl
extends Object
implements FieldSpec

The implementation for FieldSpec.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FieldSpecImpl.BuilderImpl	The implementation of FieldSpec.Builder

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

FieldSpec.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final List<AnnotationSpecImpl>	m_Annotations	The annotations for the field.
private final Lazy<String>	m_CachedString	Lazily initialised return value of toString() for this instance.
private final JavaComposer	m_Composer	The reference to the factory.
private final CodeBlockImpl	m_Initializer	The initializer for the field.
private final CodeBlockImpl	m_Javadoc	The Javadoc comment for the field.
private final Set<Modifier>	m_Modifiers	The modifiers for the field.
private final String	m_Name	The name for the field.
private final Set<String>	m_StaticImports	The static imports.
private final TypeNameImpl	m_Type	The type of the field.

Constructor Summary

Constructors

Constructor	Description
FieldSpecImpl(FieldSpecImpl.BuilderImpl builder)	Creates a new FieldSpecImpl instance.

Method Summary

Modifier and Type	Method	Description
static final FieldSpecImpl.BuilderImpl	builder(Type type, CharSequence name, Modifier... modifiers)	Deprecated, for removal: This API element is subject to removal in a future version. Got obsolete with the introduction of JavaComposer.
static final FieldSpecImpl.BuilderImpl	builder(TypeName type, CharSequence name, Modifier... modifiers)	Deprecated, for removal: This API element is subject to removal in a future version. Got obsolete with the introduction of JavaComposer.
static FieldSpecImpl.BuilderImpl	builder(TypeSpec type, CharSequence name, Modifier... modifiers)	Deprecated, for removal: This API element is subject to removal in a future version. Got obsolete with the introduction of JavaComposer.
final void	emit(CodeWriter codeWriter, Collection<Modifier> implicitModifiers)	Emits this FieldSpec instance to the given code writer.
final boolean	equals(Object o)
final JavaComposer	getFactory()	Returns the JavaComposer factory.
final CodeBlockImpl	getJavadoc()	Returns the Javadoc for this field.
final Set<String>	getStaticImports()	Returns the static imports for this code block.
final int	hashCode()
final boolean	hasInitializer()	Checks whether the field has an initializer.
final boolean	hasModifier(Modifier modifier)	Checks whether the given modifier was applied to this field.
private final String	initializeCachedString()	The initializer for m_CachedString.
final Set<Modifier>	modifiers()	Returns the modifiers for this field.
final String	name()	Returns the name for this field.
final FieldSpecImpl.BuilderImpl	toBuilder()	Returns a builder that is already initialised with the components that built this field.
final String	toString()
final TypeNameImpl	type()	Returns the type of the field.

Methods inherited from class java.lang.Object

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

Field Details

m_Annotations

private final List<AnnotationSpecImpl> m_Annotations

The annotations for the field.

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_CachedString

private final Lazy<String> m_CachedString

Lazily initialised return value of toString() for this instance.

m_Initializer

private final CodeBlockImpl m_Initializer

The initializer for the field.

m_Javadoc

private final CodeBlockImpl m_Javadoc

The Javadoc comment for the field.

m_Modifiers

private final Set<Modifier> m_Modifiers

The modifiers for the field.

m_Name

private final String m_Name

The name for the field.

m_StaticImports

private final Set<String> m_StaticImports

The static imports.

m_Type

private final TypeNameImpl m_Type

The type of the field.

Constructor Details

FieldSpecImpl

public FieldSpecImpl(FieldSpecImpl.BuilderImpl builder)

Creates a new FieldSpecImpl instance.

Parameters:

builder - The builder.

Method Details

builder

@Deprecated(since="0.2.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="0.0.5")
public static final FieldSpecImpl.BuilderImpl builder(Type type,
 CharSequence name,
 Modifier... modifiers)

Deprecated, for removal: This API element is subject to removal in a future version.

Got obsolete with the introduction of JavaComposer.

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.

builder

@Deprecated(since="0.2.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="0.0.5")
public static final FieldSpecImpl.BuilderImpl builder(TypeName type,
 CharSequence name,
 Modifier... modifiers)

Deprecated, for removal: This API element is subject to removal in a future version.

Got obsolete with the introduction of JavaComposer.

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.

builder

@Deprecated(since="0.2.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="0.0.5")
public static FieldSpecImpl.BuilderImpl builder(TypeSpec type,
 CharSequence name,
 Modifier... modifiers)

Deprecated, for removal: This API element is subject to removal in a future version.

Got obsolete with the introduction of JavaComposer.

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.

emit

public final void emit(CodeWriter codeWriter,
 Collection<Modifier> implicitModifiers)
                throws UncheckedIOException

Emits this FieldSpec instance to the given code writer.

Parameters:

codeWriter - The code writer.

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 FieldSpec

Overrides:

equals in class Object

getFactory

public final JavaComposer getFactory()

Returns the JavaComposer factory.

Returns:

The reference to the factory.

getJavadoc

@API(status=INTERNAL,
     since="0.2.0")
public final CodeBlockImpl getJavadoc()

Returns the Javadoc for this field.

Returns:

The Javadoc.

Since:

0.2.0

getStaticImports

@API(status=INTERNAL,
     since="0.2.0")
public final Set<String> getStaticImports()

Returns the static imports for this code block.

Returns:

The static imports.

hashCode

public final int hashCode()

Specified by:

hashCode in interface FieldSpec

Overrides:

hashCode in class Object

hasInitializer

public final boolean hasInitializer()

Checks whether the field has an initializer.

Returns:

true if the field has an initializer, false otherwise.

hasModifier

public final boolean hasModifier(Modifier modifier)

Checks whether the given modifier was applied to this field.

Specified by:

hasModifier in interface FieldSpec

Parameters:

modifier - The modifier.

Returns:

true if the given modifier has been applied to this field.

initializeCachedString

private final String initializeCachedString()

The initializer for m_CachedString.

Returns:

The return value for toString().

modifiers

public final Set<Modifier> modifiers()

Returns the modifiers for this field.

Specified by:

modifiers in interface FieldSpec

Returns:

The modifiers.

name

public final String name()

Returns the name for this field.

Specified by:

name in interface FieldSpec

Returns:

The name.

toBuilder

public final FieldSpecImpl.BuilderImpl toBuilder()

Returns a builder that is already initialised with the components that built this field.

Specified by:

toBuilder in interface FieldSpec

Returns:

The builder.

toString

public final String toString()

Specified by:

toString in interface FieldSpec

Overrides:

toString in class Object

type

public final TypeNameImpl type()

Returns the type of the field.

Specified by:

type in interface FieldSpec

Returns:

The type.