org.microbean.helm.chart.repository

Class ChartRepository.Index

java.lang.Object

org.microbean.helm.chart.repository.ChartRepository.Index

Enclosing class:

ChartRepository

@Experimental
public static final class ChartRepository.Index
extends Object

A class representing certain of the contents of a Helm chart repository's index.yaml file.

Author:

Laird Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChartRepository.Index.Entry An entry in a Helm chart repository index.

Method Summary

Modifier and Type	Method and Description
Map<String,SortedSet<ChartRepository.Index.Entry>>	getEntries() Returns a non-null, immutable Map of SortedSets of ChartRepository.Index.Entry objects, indexed by the name of the Helm chart they describe.
ChartRepository.Index.Entry	getEntry(String name, String versionString) Returns an ChartRepository.Index.Entry identified by the supplied name and version, if there is one.
static ChartRepository.Index	loadFrom(InputStream stream) Creates a new ChartRepository.Index whose contents are sourced from the Helm chart repository index YAML contents represented by the supplied InputStream.
static ChartRepository.Index	loadFrom(Path path) Creates a new ChartRepository.Index whose contents are sourced from the YAML file located at the supplied Path.
@Experimental ChartRepository.Index	merge(ChartRepository.Index other) Creates and returns a new ChartRepository.Index consisting of all this ChartRepository.Index instance's entries augmented with those entries from the supplied ChartRepository.Index that this ChartRepository.Index instance did not already contain.

Methods inherited from class java.lang.Object

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

Method Detail

merge

@Experimental
public final @Experimental ChartRepository.Index merge(ChartRepository.Index other)

Creates and returns a new ChartRepository.Index consisting of all this ChartRepository.Index instance's entries augmented with those entries from the supplied ChartRepository.Index that this ChartRepository.Index instance did not already contain.

Parameters:

other - the ChartRepository.Index to merge in; may be null

Returns:

a new ChartRepository.Index reflecting the merge operation

getEntries

public final Map<String,SortedSet<ChartRepository.Index.Entry>> getEntries()

Returns a non-null, immutable Map of SortedSets of ChartRepository.Index.Entry objects, indexed by the name of the Helm chart they describe.

Returns:

a non-null, immutable Map of SortedSets of ChartRepository.Index.Entry objects, indexed by the name of the Helm chart they describe

getEntry

public final ChartRepository.Index.Entry getEntry(String name,
                                                  String versionString)

Returns an ChartRepository.Index.Entry identified by the supplied name and version, if there is one.

This method may return null.

Parameters:

name - the name of the Helm chart whose related ChartRepository.Index.Entry is desired; must not be null

versionString - the version of the Helm chart whose related ChartRepository.Index.Entry is desired; may be null in which case "latest" semantics are implied

Returns:

an ChartRepository.Index.Entry, or null

Throws:

NullPointerException - if name is null

loadFrom

public static final ChartRepository.Index loadFrom(Path path)
                                            throws IOException,
                                                   URISyntaxException

Creates a new ChartRepository.Index whose contents are sourced from the YAML file located at the supplied Path.

This method never returns null.

Parameters:

path - the Path to a YAML file whose contents are those of a Helm chart repository index; must not be null

Returns:

a new ChartRepository.Index; never null

Throws:

IOException - if there was a problem reading the file

URISyntaxException - if one of the URIs in the file was invalid

NullPointerException - if path is null

See Also:

loadFrom(InputStream)

loadFrom

public static final ChartRepository.Index loadFrom(InputStream stream)
                                            throws IOException,
                                                   URISyntaxException

Creates a new ChartRepository.Index whose contents are sourced from the Helm chart repository index YAML contents represented by the supplied InputStream.

This method never returns null.

Parameters:

stream - the InputStream to a YAML file whose contents are those of a Helm chart repository index; must not be null

Returns:

a new ChartRepository.Index; never null

Throws:

IOException - if there was a problem reading the file

URISyntaxException - if one of the URIs in the file was invalid

NullPointerException - if path is null