Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class JavaFileImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.JavaFileImpl

All Implemented Interfaces:

JavaFile

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

The implementation of JavaFile for a Java file containing a single top level class.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JavaFileImpl.BuilderImpl	The builder for an instance of JavaFileImpl as an implementation of JavaFile.Builder.

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

JavaFile.Builder

Field Summary

Fields

Modifier and Type	Field	Description
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_FileComment	The file comment.
private final Layout	m_Layout	The layout for the output of this JavaFile.
private final String	m_PackageName	The name of the package for the class.
private final boolean	m_SkipJavaLangImports	Flag that determines whether to skip the imports for classes from the package java.lang.
private final Set<String>	m_StaticImports	The static imports.
private final TypeSpecImpl	m_TypeSpec	The TypeSpecImpl for the class in the JavaFileImpl.
private static final Appendable	NULL_APPENDABLE	An implementation of Appendable that places any data that is put to it into the void.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JavaFileImpl(JavaFileImpl.BuilderImpl builder)	Creates a new JavaFileImpl instance.

Method Summary

Modifier and Type	Method	Description
static JavaFileImpl.BuilderImpl	builder(CharSequence packageName, TypeSpec typeSpec)	Deprecated, for removal: This API element is subject to removal in a future version. Got obsolete with the introduction of JavaComposer.
private final void	emit(CodeWriter codeWriter)	Writes this instance of JavaFile to the given CodeWriter instance.
final boolean	equals(Object o)
final JavaComposer	getFactory()	Returns the JavaComposer factory.
final int	hashCode()
private final String	initializeCachedString()	The initializer for m_CachedString.
final JavaFile.Builder	toBuilder()	Returns a new builder that is initialised with this JavaFile instance.
final JavaFileObject	toJavaFileObject()	Creates a JavaFileObject from this instance of JavaFile.
final String	toString()
final void	writeTo(File directory)	Writes this JavaFile instance to the given target folder as a UTF-8 file, using the standard directory structure for the packages.
final void	writeTo(Appendable out)	Writes this JavaFile instance to the given Appendable.
void	writeTo(Path directory)	Writes this JavaFile instance to the given target folder as a UTF-8 file, using the standard directory structure for the packages.
final void	writeTo(Filer filer)	Writes JavaFile instance to the given Filer instance.

Methods inherited from class java.lang.Object

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

Field Details

NULL_APPENDABLE

private static final Appendable NULL_APPENDABLE

An implementation of Appendable that places any data that is put to it into the void.

m_CachedString

private final Lazy<String> m_CachedString

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

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_FileComment

private final CodeBlockImpl m_FileComment

The file comment.

m_Layout

private final Layout m_Layout

The layout for the output of this JavaFile.

m_PackageName

private final String m_PackageName

The name of the package for the class.

m_SkipJavaLangImports

private final boolean m_SkipJavaLangImports

Flag that determines whether to skip the imports for classes from the package java.lang.

m_StaticImports

private final Set<String> m_StaticImports

The static imports.

m_TypeSpec

private final TypeSpecImpl m_TypeSpec

The TypeSpecImpl for the class in the JavaFileImpl.

Constructor Details

JavaFileImpl

private JavaFileImpl(JavaFileImpl.BuilderImpl builder)

Creates a new JavaFileImpl instance.

Parameters:

builder - The builder that was used to collect the data for the new instance.

Method Details

builder

@Deprecated(since="0.2.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="0.0.5")
public static JavaFileImpl.BuilderImpl builder(CharSequence packageName,
 TypeSpec typeSpec)

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 a new instance of JavaFile from the given package name and class definition.

Parameters:

packageName - The package name.

typeSpec - The class definition.

Returns:

The builder.

emit

private final void emit(CodeWriter codeWriter)
                 throws UncheckedIOException

Writes this instance of JavaFile to the given CodeWriter instance.

Parameters:

codeWriter - The code writer.

Throws:

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

equals

public final boolean equals(Object o)

Specified by:

equals in interface JavaFile

Overrides:

equals in class Object

getFactory

public final JavaComposer getFactory()

Returns the JavaComposer factory.

Returns:

The reference to the factory.

hashCode

public final int hashCode()

Specified by:

hashCode in interface JavaFile

Overrides:

hashCode in class Object

initializeCachedString

private final String initializeCachedString()

The initializer for m_CachedString.

Returns:

The return value for toString().

toBuilder

public final JavaFile.Builder toBuilder()

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

Specified by:

toBuilder in interface JavaFile

Returns:

The new builder.

toJavaFileObject

public final JavaFileObject toJavaFileObject()

Creates a JavaFileObject from this instance of JavaFile.

Specified by:

toJavaFileObject in interface JavaFile

Returns:

The JavaFileObject.

toString

public final String toString()

Specified by:

toString in interface JavaFile

Overrides:

toString in class Object

writeTo

public final void writeTo(Appendable out)
                   throws IOException

Writes this JavaFile instance to the given Appendable.

Specified by:

writeTo in interface JavaFile

Parameters:

out - The output target.

Throws:

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

writeTo

public final void writeTo(File directory)
                   throws IOException

Writes this JavaFile instance to the given target folder as a UTF-8 file, using the standard directory structure for the packages.

Specified by:

writeTo in interface JavaFile

Parameters:

directory - The target folder.

Throws:

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

writeTo

public final void writeTo(Filer filer)
                   throws IOException

Writes JavaFile instance to the given Filer instance.

Specified by:

writeTo in interface JavaFile

Parameters:

filer - The target.

Throws:

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

writeTo

public void writeTo(Path directory)
             throws IOException

Writes this JavaFile instance to the given target folder as a UTF-8 file, using the standard directory structure for the packages.

Specified by:

writeTo in interface JavaFile

Parameters:

directory - The target folder.

Throws:

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