org.microbean.helm.chart

Class URLChartLoader

java.lang.Object

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

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

org.microbean.helm.chart.URLChartLoader

All Implemented Interfaces:

Closeable, AutoCloseable

public class URLChartLoader
extends StreamOrientedChartLoader<URL>

A StreamOrientedChartLoader<URL> that creates ChartOuterClass.Chart instances from URL instances.

Thread Safety

This class is safe for concurrent use by multiple threads.

Author:

Laird Nelson

See Also:

toNamedInputStreamEntries(URL), StreamOrientedChartLoader

Constructor Summary

Constructors

Constructor and Description
URLChartLoader() Creates a new URLChartLoader.

Method Summary

Modifier and Type	Method and Description
void	close() Closes resources opened by this URLChartLoader's toNamedInputStreamEntries(URL) method.
protected InputStream	openStream(URL url) Returns an InputStream corresponding to the supplied URL.
protected Iterable<? extends Map.Entry<? extends String,? extends InputStream>>	toNamedInputStreamEntries(URL url) Converts the supplied URL into an Iterable of Map.Entry instances, each of which consists of an InputStream representing a resource within a Helm chart together with its (relative to the chart) name.

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

createTemplateBuilder, installAny, installConfig, installMetadata, load, load

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

load

Methods inherited from class java.lang.Object

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

Constructor Detail

URLChartLoader

public URLChartLoader()

Creates a new URLChartLoader.

Method Detail

toNamedInputStreamEntries

protected Iterable<? extends Map.Entry<? extends String,? extends InputStream>> toNamedInputStreamEntries(URL url)
                                                                                                   throws IOException

Converts the supplied URL into an Iterable of Map.Entry instances, each of which consists of an InputStream representing a resource within a Helm chart together with its (relative to the chart) name.

This method never returns null.

Overrides of this method are not permitted to return null.

Specified by:

toNamedInputStreamEntries in class StreamOrientedChartLoader<URL>

Parameters:

url - the URL to dereference; must be non-null or an effectively empty Iterable will be returned

Returns:

a non-null Iterable of Map.Entry instances representing named InputStreams

Throws:

IOException - if there is a problem reading from the supplied URL

openStream

protected InputStream openStream(URL url)
                          throws IOException

Returns an InputStream corresponding to the supplied URL.

This method may return null.

Overrides of this method are permitted to return null.

Parameters:

url - the URL whose affiliated InputStream should be returned; may be null in which case null will be returned

Returns:

an InputStream appropriate for the supplied URL, or null

Throws:

IOException - if an error occurs while connecting to the supplied URL

close

public void close()
           throws IOException

Closes resources opened by this URLChartLoader's toNamedInputStreamEntries(URL) method.

Throws:

IOException - if a subclass has overridden this method and an error occurs