org.microbean.helm.chart

Class AbstractChartWriter

java.lang.Object

org.microbean.helm.chart.AbstractChartWriter

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

AbstractArchiveChartWriter

public abstract class AbstractChartWriter
extends Object
implements Closeable

An object capable of writing or serializing or otherwise representing a ChartOuterClass.ChartOrBuilder.

Author:

Laird Nelson

See Also:

write(ChartOuterClass.ChartOrBuilder)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractChartWriter.Context A class representing the state of a write operation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractChartWriter() Creates a new AbstractChartWriter.

Method Summary

Modifier and Type	Method and Description
protected void	beginWrite(AbstractChartWriter.Context context, ChartOuterClass.ChartOrBuilder parent, ChartOuterClass.ChartOrBuilder chartBuilder) A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked.
protected Yaml	createYaml() Creates and returns a new Yaml instance for (optional) use in writing ConfigOuterClass.ConfigOrBuilder and MetadataOuterClass.MetadataOrBuilder objects.
protected void	endWrite(AbstractChartWriter.Context context, ChartOuterClass.ChartOrBuilder parent, ChartOuterClass.ChartOrBuilder chartBuilder) A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to end the write operation.
protected String	toYAML(AbstractChartWriter.Context context, Object data) Marshals the supplied Object to YAML in the context of the supplied AbstractChartWriter.Context and returns the result.
protected void	write(AbstractChartWriter.Context context, ChartOuterClass.ChartOrBuilder parent, ChartOuterClass.ChartOrBuilder chartBuilder) Writes or serializes or otherwise represents the supplied chartBuilder as a subchart of the supplied parent (which may be, and often is, null).
void	write(ChartOuterClass.ChartOrBuilder chartBuilder) Writes or serializes or otherwise represents the supplied ChartOuterClass.ChartOrBuilder.
protected abstract void	writeConfig(AbstractChartWriter.Context context, ConfigOuterClass.ConfigOrBuilder config) A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant ConfigOuterClass.ConfigOrBuilder object.
protected abstract void	writeFile(AbstractChartWriter.Context context, AnyOrBuilder file) A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant AnyOrBuilder object (representing an otherwise undifferentiated Helm chart file).
protected abstract void	writeMetadata(AbstractChartWriter.Context context, MetadataOuterClass.MetadataOrBuilder metadata) A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant MetadataOuterClass.MetadataOrBuilder object.
protected void	writeSubchart(AbstractChartWriter.Context context, ChartOuterClass.ChartOrBuilder parent, ChartOuterClass.ChartOrBuilder subchart) A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant ChartOuterClass.ChartOrBuilder object (representing a subchart within an encompassing parent Helm chart).
protected abstract void	writeTemplate(AbstractChartWriter.Context context, TemplateOuterClass.TemplateOrBuilder template) A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant TemplateOuterClass.TemplateOrBuilder object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

AbstractChartWriter

protected AbstractChartWriter()

Creates a new AbstractChartWriter.

Method Detail

write

public final void write(ChartOuterClass.ChartOrBuilder chartBuilder)
                 throws IOException

Writes or serializes or otherwise represents the supplied ChartOuterClass.ChartOrBuilder.

Parameters:

chartBuilder - the ChartOuterClass.ChartOrBuilder to write; must not be null

Throws:

IOException - if a write error occurs

NullPointerException - if chartBuilder is null

IllegalArgumentException - if the ChartOuterClass.ChartOrBuilder.getMetadata() method returns null, or if the MetadataOuterClass.MetadataOrBuilder.getName() method returns null, or if the MetadataOuterClass.MetadataOrBuilder.getVersion() method returns null

IllegalStateException - if a subclass has overridden the createYaml() method to return null and calls it

See Also:

write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder)

write

protected void write(AbstractChartWriter.Context context,
                     ChartOuterClass.ChartOrBuilder parent,
                     ChartOuterClass.ChartOrBuilder chartBuilder)
              throws IOException

Writes or serializes or otherwise represents the supplied chartBuilder as a subchart of the supplied parent (which may be, and often is, null).

Parameters:

context - the AbstractChartWriter.Context representing the write operation; may be null

parent - the ChartOuterClass.ChartOrBuilder functioning as the parent chart; may be, and often is, null; must not be identical to the chartBuilder parameter value

chartBuilder - the ChartOuterClass.ChartOrBuilder to actually write; must not be null; must not be identical to the parent parameter value

Throws:

IOException - if a write error occurs

NullPointerException - if chartBuilder is null

IllegalArgumentException - if parent is identical to chartBuilder, or if the ChartOuterClass.ChartOrBuilder.getMetadata() method returns null, or if the MetadataOuterClass.MetadataOrBuilder.getName() method returns null, or if the MetadataOuterClass.MetadataOrBuilder.getVersion() method returns null

IllegalStateException - if a subclass has overridden the createYaml() method to return null and calls it

See Also:

beginWrite(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder), writeMetadata(Context, MetadataOuterClass.MetadataOrBuilder), writeConfig(Context, ConfigOuterClass.ConfigOrBuilder), writeTemplate(Context, TemplateOuterClass.TemplateOrBuilder), writeFile(Context, AnyOrBuilder), writeSubchart(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder), endWrite(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder)

createYaml

protected Yaml createYaml()

Creates and returns a new Yaml instance for (optional) use in writing ConfigOuterClass.ConfigOrBuilder and MetadataOuterClass.MetadataOrBuilder objects.

This method never returns null.

Overrides of this method must not return null.

Behavior is undefined if overrides of this method interact with other methods defined by this class.

Returns:

a non-null Yaml instance

toYAML

protected final String toYAML(AbstractChartWriter.Context context,
                              Object data)
                       throws IOException

Marshals the supplied Object to YAML in the context of the supplied AbstractChartWriter.Context and returns the result.

This method never returns null.

This method may call the createYaml() method.

Parameters:

context - the AbstractChartWriter.Context representing the write operation; must not be null

data - the Object to convert to its YAML representation; may be null

Returns:

a non-null String consisting of the appropriate YAML represesentation of the supplied data

Throws:

IOException - if a YAML serialization error occurs

NullPointerException - if context is null

See Also:

createYaml(), Yaml.dumpAsMap(Object)

beginWrite

protected void beginWrite(AbstractChartWriter.Context context,
                          ChartOuterClass.ChartOrBuilder parent,
                          ChartOuterClass.ChartOrBuilder chartBuilder)
                   throws IOException

A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked.

The default implementation of this method does nothing.

Parameters:

context - the AbstractChartWriter.Context representing the write operation; must not be null

parent - the ChartOuterClass.ChartOrBuilder functioning as the parent chart; may be, and often is, null; must not be identical to the chartBuilder parameter value

chartBuilder - the ChartOuterClass.ChartOrBuilder to actually write; must not be null; must not be identical to the parent parameter value

Throws:

IOException - if a write error occurs

NullPointerException - if either context or chartBuilder is null

IllegalArgumentException - if parent is identical to chartBuilder

IllegalStateException - if a subclass has overridden the createYaml() method to return null and calls it from this method for some reason

writeMetadata

protected abstract void writeMetadata(AbstractChartWriter.Context context,
                                      MetadataOuterClass.MetadataOrBuilder metadata)
                               throws IOException

A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant MetadataOuterClass.MetadataOrBuilder object.

Parameters:

context - the AbstractChartWriter.Context representing the write operation; must not be null

metadata - the MetadataOuterClass.MetadataOrBuilder to write; must not be null

Throws:

IOException - if a write error occurs

NullPointerException - if either context or metadata is null

IllegalStateException - if a subclass has overridden the createYaml() method to return null and calls it from this method

writeConfig

protected abstract void writeConfig(AbstractChartWriter.Context context,
                                    ConfigOuterClass.ConfigOrBuilder config)
                             throws IOException

A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant ConfigOuterClass.ConfigOrBuilder object.

Parameters:

context - the AbstractChartWriter.Context representing the write operation; must not be null

config - the ConfigOuterClass.ConfigOrBuilder to write; must not be null

Throws:

IOException - if a write error occurs

NullPointerException - if either context or config is null

IllegalStateException - if a subclass has overridden the createYaml() method to return null and calls it from this method

writeTemplate

protected abstract void writeTemplate(AbstractChartWriter.Context context,
                                      TemplateOuterClass.TemplateOrBuilder template)
                               throws IOException

A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant TemplateOuterClass.TemplateOrBuilder object.

Parameters:

context - the AbstractChartWriter.Context representing the write operation; must not be null

template - the TemplateOuterClass.TemplateOrBuilder to write; must not be null

Throws:

IOException - if a write error occurs

NullPointerException - if either context or template is null

IllegalStateException - if a subclass has overridden the createYaml() method to return null and calls it from this method for some reason

writeFile

protected abstract void writeFile(AbstractChartWriter.Context context,
                                  AnyOrBuilder file)
                           throws IOException

A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant AnyOrBuilder object (representing an otherwise undifferentiated Helm chart file).

Parameters:

context - the AbstractChartWriter.Context representing the write operation; must not be null

file - the AnyOrBuilder to write; must not be null

Throws:

IOException - if a write error occurs

NullPointerException - if either context or file is null

IllegalStateException - if a subclass has overridden the createYaml() method to return null and calls it from this method for some reason

writeSubchart

protected void writeSubchart(AbstractChartWriter.Context context,
                             ChartOuterClass.ChartOrBuilder parent,
                             ChartOuterClass.ChartOrBuilder subchart)
                      throws IOException

A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant ChartOuterClass.ChartOrBuilder object (representing a subchart within an encompassing parent Helm chart).

The default implementation of this method calls the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method.

Parameters:

context - the AbstractChartWriter.Context representing the write operation; must not be null

parent - the ChartOuterClass.ChartOrBuilder representing the Helm chart that parents the subchart parameter value; must not be null

subchart - the ChartOuterClass.ChartOrBuilder representing the subchart to write; must not be null

Throws:

IOException - if a write error occurs

NullPointerException - if either context or parent or subchart is null

IllegalArgumentException - if parent is identical to subchart, or if the ChartOuterClass.ChartOrBuilder.getMetadata() method returns null when invoked on either non-null ChartOuterClass.ChartOrBuilder, or if the MetadataOuterClass.MetadataOrBuilder.getName() method returns null, or if the MetadataOuterClass.MetadataOrBuilder.getVersion() method returns null

IllegalStateException - if a subclass has overridden the createYaml() method to return null and calls it from this method for some reason

See Also:

write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder)

endWrite

protected void endWrite(AbstractChartWriter.Context context,
                        ChartOuterClass.ChartOrBuilder parent,
                        ChartOuterClass.ChartOrBuilder chartBuilder)
                 throws IOException

A callback method invoked when the write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to end the write operation.

The default implementation of this method does nothing.

Parameters:

context - the AbstractChartWriter.Context representing the write operation; must not be null

parent - the ChartOuterClass.ChartOrBuilder representing the Helm chart that parents the chartBuilder parameter value; may be, and often is, null

chartBuilder - the ChartOuterClass.ChartOrBuilder representing the chart currently involved in the write operation; must not be null

Throws:

IOException - if a write error occurs

NullPointerException - if either context or chartBuilder is null

IllegalArgumentException - if parent is identical to chartBuilder

IllegalStateException - if a subclass has overridden the createYaml() method to return null and calls it from this method for some reason