org.microbean.helm.chart

Class AbstractArchiveChartWriter

java.lang.Object

org.microbean.helm.chart.AbstractChartWriter

org.microbean.helm.chart.AbstractArchiveChartWriter

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

TapeArchiveChartWriter

public abstract class AbstractArchiveChartWriter
extends AbstractChartWriter

A partial AbstractChartWriter whose implementations save ChartOuterClass.ChartOrBuilder objects to a destination that can be considered an archive of some sort.

Author:

Laird Nelson

Nested Class Summary

Nested classes/interfaces inherited from class org.microbean.helm.chart.AbstractChartWriter

AbstractChartWriter.Context

Constructor Summary

Constructors

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

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 AbstractChartWriter.write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked.
protected void	endWrite(AbstractChartWriter.Context context, ChartOuterClass.ChartOrBuilder parent, ChartOuterClass.ChartOrBuilder chartBuilder) A callback method invoked when the AbstractChartWriter.write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to end the write operation.
protected void	writeConfig(AbstractChartWriter.Context context, ConfigOuterClass.ConfigOrBuilder config) A callback method invoked when the AbstractChartWriter.write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant ConfigOuterClass.ConfigOrBuilder object.
protected abstract void	writeEntry(AbstractChartWriter.Context context, String path, String contents) Writes the supplied contents to an appropriate archive entry that is expected to be suffixed with the supplied path in the context of the write operation described by the supplied Context.
protected void	writeFile(AbstractChartWriter.Context context, AnyOrBuilder file) A callback method invoked when the AbstractChartWriter.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 void	writeMetadata(AbstractChartWriter.Context context, MetadataOuterClass.MetadataOrBuilder metadata) A callback method invoked when the AbstractChartWriter.write(Context, ChartOuterClass.ChartOrBuilder, ChartOuterClass.ChartOrBuilder) method has been invoked and it is time to write a relevant MetadataOuterClass.MetadataOrBuilder object.
protected void	writeTemplate(AbstractChartWriter.Context context, TemplateOuterClass.TemplateOrBuilder template) A callback method invoked when the AbstractChartWriter.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 org.microbean.helm.chart.AbstractChartWriter

createYaml, toYAML, write, write, writeSubchart

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

AbstractArchiveChartWriter

protected AbstractArchiveChartWriter()

Creates a new AbstractArchiveChartWriter.

Method Detail

beginWrite

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

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

The default implementation of this method does nothing.

The AbstractArchiveChartWriter implementation stores a String representing the required path layout under a "path" key in the supplied Context.

Overrides:

beginWrite in class AbstractChartWriter

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

writeMetadata

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

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

The AbstractArchiveChartWriter implementation writes the YAML representation of the supplied MetadataOuterClass.MetadataOrBuilder to an appropriate archive entry named Chart.yaml within the current chart path.

Specified by:

writeMetadata in class AbstractChartWriter

Parameters:

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

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

Throws:

NullPointerException - if either context or metadata is null

IOException - if a write error occurs

writeConfig

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

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

This implementation writes the YAML representation of the supplied ConfigOuterClass.ConfigOrBuilder to an appropriate archive entry named values.yaml within the current chart path.

Specified by:

writeConfig in class AbstractChartWriter

Parameters:

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

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

Throws:

NullPointerException - if context is null

IOException - if a write error occurs

writeTemplate

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

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

This implementation writes the data of the supplied TemplateOuterClass.TemplateOrBuilder to an appropriate archive entry named in part by the return value of the TemplateOuterClass.TemplateOrBuilder.getName() method within the current chart path.

Specified by:

writeTemplate in class AbstractChartWriter

Parameters:

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

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

Throws:

NullPointerException - if context is null

IOException - if a write error occurs

writeFile

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

A callback method invoked when the AbstractChartWriter.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).

This implementation writes the contents of the supplied AnyOrBuilder to an appropriate archive entry named in part by the return value of the AnyOrBuilder.getTypeUrl() method within the current chart path.

Specified by:

writeFile in class AbstractChartWriter

Parameters:

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

file - the AnyOrBuilder to write; must not be null

Throws:

NullPointerException - if context is null

IOException - if a write error occurs

endWrite

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

A callback method invoked when the AbstractChartWriter.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.

This implementation ensures that the current chart path, residing under the "path" key in the supplied AbstractChartWriter.Context, is reset properly.

Overrides:

endWrite in class AbstractChartWriter

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:

NullPointerException - if either context or chartBuilder is null

IOException - if a write error occurs

writeEntry

protected abstract void writeEntry(AbstractChartWriter.Context context,
                                   String path,
                                   String contents)
                            throws IOException

Writes the supplied contents to an appropriate archive entry that is expected to be suffixed with the supplied path in the context of the write operation described by the supplied Context.

Parameters:

context - the Context describing the write operation in effect; must not be null

path - the path within an abstract archive to write; interpreted as being relative to the current notional chart path, whatever that might be; must not be null or empty

contents - the contents to write; must not be null

Throws:

IOException - if a write error occurs

NullPointerException - if context, path or contents is null

IllegalArgumentException - if path is empty