org.microbean.helm.chart

Class TapeArchiveChartWriter

java.lang.Object

org.microbean.helm.chart.AbstractChartWriter

org.microbean.helm.chart.AbstractArchiveChartWriter

org.microbean.helm.chart.TapeArchiveChartWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class TapeArchiveChartWriter
extends AbstractArchiveChartWriter

An AbstractArchiveChartWriter that saves ChartOuterClass.ChartOrBuilder objects to a supplied OutputStream in TAR format, using a TarOutputStream internally.

Author:

Laird Nelson

Nested Class Summary

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

AbstractChartWriter.Context

Constructor Summary

Constructors

Constructor and Description
TapeArchiveChartWriter(OutputStream outputStream) Creates a new TapeArchiveChartWriter.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this TapeArchiveChartWriter by closing its underlying TarOutputStream.
protected void	writeEntry(AbstractChartWriter.Context context, String path, String contents) Creates a new TarHeader and a TarEntry wrapping it and writes it and the supplied contents to the underlying TarOutputStream.

Methods inherited from class org.microbean.helm.chart.AbstractArchiveChartWriter

beginWrite, endWrite, writeConfig, writeFile, writeMetadata, writeTemplate

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

Constructor Detail

TapeArchiveChartWriter

public TapeArchiveChartWriter(OutputStream outputStream)

Creates a new TapeArchiveChartWriter.

Parameters:

outputStream - the OutputStream to write to; must not be null and should be buffered at some level

See Also:

AbstractArchiveChartWriter.AbstractArchiveChartWriter(), TarOutputStream.TarOutputStream(OutputStream)

Method Detail

writeEntry

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

Creates a new TarHeader and a TarEntry wrapping it and writes it and the supplied contents to the underlying TarOutputStream.

Specified by:

writeEntry in class AbstractArchiveChartWriter

Parameters:

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

path - the path within a tape archive to write; interpreted as being relative to the current chart path; 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

close

public void close()
           throws IOException

Closes this TapeArchiveChartWriter by closing its underlying TarOutputStream. This TapeArchiveChartWriter cannot be used again.

Throws:

IOException - if there was a problem closing the underlying TarOutputStream