org.microbean.helm.chart.repository

类 ChartRepository.Index

java.lang.Object

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

封闭类:

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.

作者:

Laird Nelson

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ChartRepository.Index.Entry An entry in a Helm chart repository index.

方法概要

限定符和类型	方法和说明
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.

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

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

方法详细资料

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.

参数:

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

返回:

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.

返回:

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.

参数:

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

返回:

an ChartRepository.Index.Entry, or null

抛出:

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.

参数:

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

返回:

a new ChartRepository.Index; never null

抛出:

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

另请参阅:

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.

参数:

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

返回:

a new ChartRepository.Index; never null

抛出:

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