T
- The type of CodegenWriter
to create and manage.@Deprecated
public class CodegenWriterDelegator<T extends CodegenWriter<T,?>>
extends java.lang.Object
Creates and manages CodegenWriter
s for files and namespaces based
on Symbol
s created for a Shape
.
CodegenWriterDelegator
is designed to generate code in files
returned by the Symbol.getDefinitionFile()
method of a Symbol
.
If multiple Symbol
s are created that need to be defined in the same
file, then the CodegenWriterDelegator
ensures that the state of code
generator associated with the file is persisted and only written when all
shapes have been generated.
CodegenWriter
s are lazily created each time a new filename is
requested. If a CodegenWriter
is already associated with a filename,
a newline (\n) is written to the file before providing access to the
CodegenWriter
. All of the files and CodegenWriters stored in the
delegator are eventually written to the provided FileManifest
when
the flushWriters()
method is called.
This class is not thread-safe.
CodegenWriterDelegator
Language-specific code generators that utilize Symbol
and
SymbolDependency
should extend both
CodegenWriterDelegator
and CodegenWriter
to implement
language specific functionality. Extending these classes also makes it
easier to create new instances of them because they will be easier to work
with since generic types aren't needed in concrete implementations.
Constructor and Description |
---|
CodegenWriterDelegator(FileManifest fileManifest,
SymbolProvider symbolProvider,
CodegenWriterFactory<T> codegenWriterFactory)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
flushWriters()
Deprecated.
Writes each pending
CodegenWriter to the FileManifest . |
java.util.List<SymbolDependency> |
getDependencies()
Deprecated.
Gets all of the dependencies that have been registered in writers
created by the
CodegenWriterDelegator . |
java.util.Map<java.lang.String,T> |
getWriters()
Deprecated.
Returns an immutable
Map of created CodegenWriter s. |
void |
setAutomaticSeparator(java.lang.String automaticSeparator)
Deprecated.
Sets the automatic separator that is written to a
CodegenWriter
each time the writer is reused. |
void |
useFileWriter(java.lang.String filename,
java.util.function.Consumer<T> writerConsumer)
Deprecated.
Gets a previously created
CodegenWriter or creates a new one
if needed. |
void |
useFileWriter(java.lang.String filename,
java.lang.String namespace,
java.util.function.Consumer<T> writerConsumer)
Deprecated.
Gets a previously created writer or creates a new one if needed.
|
void |
useShapeWriter(Shape shape,
java.util.function.Consumer<T> writerConsumer)
Deprecated.
|
public CodegenWriterDelegator(FileManifest fileManifest, SymbolProvider symbolProvider, CodegenWriterFactory<T> codegenWriterFactory)
fileManifest
- Where code is written when flushWriters()
is called.symbolProvider
- Maps Shape
to Symbol
to determine the "namespace" and file of a shape.codegenWriterFactory
- Factory used to create new CodegenWriter
s.public java.util.List<SymbolDependency> getDependencies()
CodegenWriterDelegator
.
This method essentially just aggregates the results of calling
CodegenWriter.getDependencies()
of each created writer into
a single array.
This method may be overridden as needed (for example, to add in some list of default dependencies or to inject other generative dependencies).
CodegenWriter
.public void flushWriters()
CodegenWriter
to the FileManifest
.
The toString
method is called on each writer to generate
the code to write to the manifest.
This method clears out the managed CodegenWriter
s, meaning a
subsequent call to getWriters()
will return an empty map.
This method may be overridden as needed.
public final java.util.Map<java.lang.String,T> getWriters()
Map
of created CodegenWriter
s.
Each map key is the relative filename where the code will be written
in the FileManifest
, and each map value is the associated
CodegenWriter
of type T
.
public final void useFileWriter(java.lang.String filename, java.util.function.Consumer<T> writerConsumer)
CodegenWriter
or creates a new one
if needed.
If a writer already exists, a newline is automatically appended to
the writer (either a newline or whatever value was set on
setAutomaticSeparator(java.lang.String)
).
filename
- Name of the file to create.writerConsumer
- Consumer that is expected to write to the CodegenWriter
.public final void useFileWriter(java.lang.String filename, java.lang.String namespace, java.util.function.Consumer<T> writerConsumer)
If a writer already exists, a newline is automatically appended to
the writer (either a newline or whatever value was set on
setAutomaticSeparator(java.lang.String)
).
filename
- Name of the file to create.namespace
- Namespace associated with the file (or an empty string).writerConsumer
- Consumer that is expected to write to the CodegenWriter
.public final void useShapeWriter(Shape shape, java.util.function.Consumer<T> writerConsumer)
Shape
by converting the Shape
to a Symbol
.
Any dependencies (i.e., SymbolDependency
) required by the
Symbol
are automatically registered with the writer.
Any imports required to declare the Symbol
in code (i.e.,
SymbolReference.ContextOption#DECLARE
) are automatically
registered with the writer.
If a writer already exists, a newline is automatically appended to
the writer (either a newline or whatever value was set on
setAutomaticSeparator(java.lang.String)
).
shape
- Shape to create the writer for.writerConsumer
- Consumer that is expected to write to the CodegenWriter
.public final void setAutomaticSeparator(java.lang.String automaticSeparator)
CodegenWriter
each time the writer is reused.
The default line separator is a newline ("\n"), but some implementations may wish to use an alternative value (e.g., "\r\n") or to disable the newline separator altogether by proving an empty string.
automaticSeparator
- The non-null line separator to use.