org.microbean.helm.chart

类 StreamOrientedChartLoader<T>

java.lang.Object

org.microbean.helm.chart.AbstractChartLoader<T>

org.microbean.helm.chart.StreamOrientedChartLoader<T>

类型参数:

T - the type of source from which this StreamOrientedChartLoader is capable of loading Helm charts

所有已实现的接口:

Closeable, AutoCloseable

直接已知子类:

DirectoryChartLoader, TapeArchiveChartLoader, URLChartLoader, ZipInputStreamChartLoader

public abstract class StreamOrientedChartLoader<T>
extends AbstractChartLoader<T>

A partial AbstractChartLoader implementation that is capable of loading a Helm-compatible chart from any source that is convertible into an Iterable of InputStreams indexed by their name.

作者:

Laird Nelson

另请参阅:

toNamedInputStreamEntries(Object)

构造器概要

构造器

限定符	构造器和说明
protected	StreamOrientedChartLoader() Creates a new StreamOrientedChartLoader.

方法概要

限定符和类型	方法和说明
protected TemplateOuterClass.Template.Builder	createTemplateBuilder(ChartOuterClass.Chart.Builder chartBuilder, InputStream stream, String name) Creates a new TemplateOuterClass.Template.Builder from the contents of the supplied InputStream, with the supplied name, and returns it.
protected void	installAny(ChartOuterClass.Chart.Builder chartBuilder, InputStream stream, String name) Installs an Any object, representing an arbitrary chart file with the supplied name and represented by the supplied InputStream, into the supplied Chart.Builder.
protected void	installConfig(ChartOuterClass.Chart.Builder chartBuilder, InputStream stream) Installs a ConfigOuterClass.Config object, represented by the supplied InputStream, into the supplied Chart.Builder.
protected void	installMetadata(ChartOuterClass.Chart.Builder chartBuilder, InputStream stream) Installs a MetadataOuterClass.Metadata object, represented by the supplied InputStream, into the supplied Chart.Builder.
ChartOuterClass.Chart.Builder	load(ChartOuterClass.Chart.Builder parent, Iterable<? extends Map.Entry<? extends String,? extends InputStream>> entrySet, String valueFileName) Creates a new ChartOuterClass.Chart from the supplied notional set of named InputStreams and returns it.
ChartOuterClass.Chart.Builder	load(ChartOuterClass.Chart.Builder parent, T source, String valueFileName) Creates a new ChartOuterClass.Chart from the supplied source in some manner and returns it.
protected abstract Iterable<? extends Map.Entry<? extends String,? extends InputStream>>	toNamedInputStreamEntries(T source) Converts the supplied source into an Iterable of Map.Entry instances whose keys are names and whose values are corresponding InputStreams.

从类继承的方法 org.microbean.helm.chart.AbstractChartLoader

load, load

从类继承的方法 java.lang.Object

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

从接口继承的方法 java.io.Closeable

close

构造器详细资料

StreamOrientedChartLoader

protected StreamOrientedChartLoader()

Creates a new StreamOrientedChartLoader.

方法详细资料

toNamedInputStreamEntries

protected abstract Iterable<? extends Map.Entry<? extends String,? extends InputStream>> toNamedInputStreamEntries(T source)
                                                                                                            throws IOException

Converts the supplied source into an Iterable of Map.Entry instances whose keys are names and whose values are corresponding InputStreams.

Implementations of this method must not return null.

The Iterable of Map.Entry instances returned by implementations of this method must produce an Iterator that will never return null from any invocation of its Iterator.next() method when, on the same thread, the return value of an invocation of its Iterator.hasNext() method has previously returned true.

Map.Entry instances returned by Iterator instances produced by the Iterable returned by this method must never return null from their Map.Entry.getKey() method. They are permitted to return null from their Map.Entry.getValue() method, and this feature can be used, for example, to indicate that a particular entry is a directory.

参数:

source - the source to convert; must not be null

返回:

an Iterable of suitable Map.Entry instances; never null

抛出:

NullPointerException - if source is null

IOException - if an error occurs while converting

load

public ChartOuterClass.Chart.Builder load(ChartOuterClass.Chart.Builder parent,
                                          T source,
                                          String valueFileName)
                                   throws IOException

Creates a new ChartOuterClass.Chart from the supplied source in some manner and returns it.

This method never returns null.

指定者:

load 在类中 AbstractChartLoader<T>

参数:

source - the source object from which to load a new ChartOuterClass.Chart; must not be null

valueFileName - the value filename

parent - the ChartOuterClass.Chart.Builder that will serve as the parent of the ChartOuterClass.Chart.Builder that will be returned; may be (and often is) null, indicating that the ChartOuterClass.Chart.Builder being returned does not represent a subchart; must not be what is returned

返回:

a new ChartOuterClass.Chart; never null

抛出:

NullPointerException - if source is null

IllegalStateException

IOException - if a problem is encountered while creating the ChartOuterClass.Chart to return

另请参阅:

toNamedInputStreamEntries(Object)

load

public ChartOuterClass.Chart.Builder load(ChartOuterClass.Chart.Builder parent,
                                          Iterable<? extends Map.Entry<? extends String,? extends InputStream>> entrySet,
                                          String valueFileName)
                                   throws IOException

Creates a new ChartOuterClass.Chart from the supplied notional set of named InputStreams and returns it.

This method never returns null.

This method is called by the AbstractChartLoader.load(Object) method.

参数:

entrySet - the Iterable of Map.Entry instances normally returned by the toNamedInputStreamEntries(Object) method; must not be null

返回:

a new ChartOuterClass.Chart; never null

抛出:

NullPointerException - if entrySet is null

IOException - if a problem is encountered while creating the ChartOuterClass.Chart to return

另请参阅:

toNamedInputStreamEntries(Object), AbstractChartLoader.load(Object)

installConfig

protected void installConfig(ChartOuterClass.Chart.Builder chartBuilder,
                             InputStream stream)
                      throws IOException

Installs a ConfigOuterClass.Config object, represented by the supplied InputStream, into the supplied Chart.Builder.

参数:

chartBuilder - the Chart.Builder to affect; must not be null

stream - an InputStream representing valid values file contents as defined by the chart specification; must not be null

抛出:

NullPointerException - if chartBuilder or stream is null

IOException - if there was a problem reading from the supplied InputStream

另请参阅:

ChartOuterClass.Chart.Builder.getValuesBuilder(), ConfigOuterClass.Config.Builder.setRawBytes(ByteString)

installMetadata

protected void installMetadata(ChartOuterClass.Chart.Builder chartBuilder,
                               InputStream stream)
                        throws IOException

Installs a MetadataOuterClass.Metadata object, represented by the supplied InputStream, into the supplied Chart.Builder.

参数:

chartBuilder - the Chart.Builder to affect; must not be null

stream - an InputStream representing valid Chart.yaml contents as defined by the chart specification; must not be null

抛出:

NullPointerException - if chartBuilder or stream is null

IOException - if there was a problem reading from the supplied InputStream

另请参阅:

ChartOuterClass.Chart.Builder.getMetadataBuilder(), MetadataOuterClass.Metadata.Builder

createTemplateBuilder

protected TemplateOuterClass.Template.Builder createTemplateBuilder(ChartOuterClass.Chart.Builder chartBuilder,
                                                                    InputStream stream,
                                                                    String name)
                                                             throws IOException

Creates a new TemplateOuterClass.Template.Builder from the contents of the supplied InputStream, with the supplied name, and returns it.

This method never returns null.

参数:

chartBuilder - a ChartOuterClass.Chart.Builder whose ChartOuterClass.Chart.Builder.addTemplatesBuilder() method will be called to create the new TemplateOuterClass.Template.Builder instance; must not be null

stream - an InputStream containing valid template contents as defined by the chart specification; must not be null

name - the name for the new TemplateOuterClass.Template that will ultimately reside within the chart; must not be null

返回:

a new TemplateOuterClass.Template.Builder; never null

抛出:

NullPointerException - if chartBuilder, stream or name is null

IOException - if there was a problem reading from the supplied InputStream

另请参阅:

TemplateOuterClass.Template.Builder

installAny

protected void installAny(ChartOuterClass.Chart.Builder chartBuilder,
                          InputStream stream,
                          String name)
                   throws IOException

Installs an Any object, representing an arbitrary chart file with the supplied name and represented by the supplied InputStream, into the supplied Chart.Builder.

参数:

chartBuilder - the Chart.Builder to affect; must not be null

stream - an InputStream representing valid chart file contents as defined by the chart specification; must not be null

name - the name of the file within the chart; must not be null

抛出:

NullPointerException - if chartBuilder or stream or name is null

IOException - if there was a problem reading from the supplied InputStream

另请参阅:

ChartOuterClass.Chart.Builder.addFilesBuilder()