org.microbean.helm.chart

Class DirectoryChartLoader

java.lang.Object

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

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

org.microbean.helm.chart.DirectoryChartLoader

All Implemented Interfaces:

Closeable, AutoCloseable

public class DirectoryChartLoader
extends StreamOrientedChartLoader<Path>

A StreamOrientedChartLoader<Path> that creates ChartOuterClass.Chart instances from filesystem directories represented as Path objects.

Author:

Laird Nelson

See Also:

toNamedInputStreamEntries(Path), StreamOrientedChartLoader

Constructor Summary

Constructors

Constructor and Description
DirectoryChartLoader() Creates a new DirectoryChartLoader.
DirectoryChartLoader(boolean followSymlinks) Creates a new DirectoryChartLoader.

Method Summary

Modifier and Type	Method and Description
void	close() Does nothing on purpose.
protected Iterable<? extends Map.Entry<? extends String,? extends InputStream>>	toNamedInputStreamEntries(Path path) Converts the supplied Path, which must be non-null and a directory, into an Iterable of Map.Entry instances, each of which consists of an InputStream associated with a 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

DirectoryChartLoader

public DirectoryChartLoader()

Creates a new DirectoryChartLoader.

When loading charts, symbolic links are not followed.

See Also:

DirectoryChartLoader(boolean)

DirectoryChartLoader

public DirectoryChartLoader(boolean followSymlinks)

Creates a new DirectoryChartLoader.

Parameters:

followSymlinks - if true, then symbolic links will be followed during chart loading

Method Detail

toNamedInputStreamEntries

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

Converts the supplied Path, which must be non-null and a directory, into an Iterable of Map.Entry instances, each of which consists of an InputStream associated with a name.

This method never returns null.

Overrides of this method are not permitted to return null.

Specified by:

toNamedInputStreamEntries in class StreamOrientedChartLoader<Path>

Parameters:

path - the Path to read; must be non-null and must be a directory 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 directory represented by the supplied Path or any of its subdirectories or files

close

public void close()
           throws IOException

Does nothing on purpose.

Throws:

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