org.microbean.helm.chart

Class AbstractChartLoader<T>

java.lang.Object

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

Type Parameters:

T - the type of source from which ChartOuterClass.Charts may be loaded

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

StreamOrientedChartLoader

public abstract class AbstractChartLoader<T>
extends Object
implements Closeable

An abstract class whose implementations are capable of reading in the raw materials for a Helm chart from some kind of source and creating new ChartOuterClass.Chart instances from such raw materials.

Implementations should pay close attention to any potential resource leaks and control them in their implementation of the Closeable.close() method.

Author:

Laird Nelson

See Also:

load(Object), load(hapi.chart.ChartOuterClass.Chart.Builder, Object), ChartOuterClass.Chart

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract ChartOuterClass.Chart.Builder	load(ChartOuterClass.Chart.Builder parent, T source) Creates a new ChartOuterClass.Chart.Builder from the supplied source and returns it.
ChartOuterClass.Chart.Builder	load(T source) Creates a new "top-level" ChartOuterClass.Chart.Builder from the supplied source and returns it.

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

AbstractChartLoader

protected AbstractChartLoader()

Creates a new AbstractChartLoader.

Method Detail

load

public final ChartOuterClass.Chart.Builder load(T source)
                                         throws IOException

Creates a new "top-level" ChartOuterClass.Chart.Builder from the supplied source and returns it.

Implementations of this method must not return null.

Parameters:

source - the source from which a new ChartOuterClass.Chart.Builder should be created; must not be null

Returns:

a new ChartOuterClass.Chart.Builder; never null

Throws:

NullPointerException - if source is null

IOException - if reading the supplied source could not complete normally

See Also:

load(ChartOuterClass.Chart.Builder, Object)

load

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

Creates a new ChartOuterClass.Chart.Builder from the supplied source and returns it.

Implementations of this method must not return null and must not return parent.

Parameters:

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

source - the source from which a new ChartOuterClass.Chart.Builder should be created; must not be null

Returns:

a new ChartOuterClass.Chart.Builder; never null; never parent

Throws:

NullPointerException - if source is null

IOException - if reading the supplied source could not complete normally