org.microbean.helm.chart

Class Requirements

java.lang.Object

org.microbean.helm.chart.Requirements

public final class Requirements
extends Object

A specification of a Helm chart's dependencies; not normally used directly by end users.

Helm charts support a requirements.yaml resource, in YAML format, whose sole member is a dependencies list. This class represents that resource.

Thread Safety

Instances of this class are not suitable for concurrent access by multiple threads.

Author:

Laird Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Requirements.Dependency A description of a subchart that should be present in a parent Helm chart; not normally used directly by end users.
static class	Requirements.DependencyBeanInfo A SimpleBeanInfo describing the Java Bean properties for the Requirements.Dependency class; not normally used directly by end users.

Constructor Summary

Constructors

Constructor and Description
Requirements() Creates a new Requirements.

Method Summary

Modifier and Type	Method and Description
static ChartOuterClass.Chart.Builder	apply(ChartOuterClass.Chart.Builder chartBuilder, ConfigOuterClass.ConfigOrBuilder userSuppliedValues) Applies a variety of rules concerning subchart aliasing and enablement to the contents of the supplied Chart.Builder.
static Requirements	fromChartOrBuilder(ChartOuterClass.ChartOrBuilder chart) Creates a new Requirements from a top-level requirements.yaml resource present in the supplied ChartOuterClass.ChartOrBuilder and returns it.
Collection<Requirements.Dependency>	getDependencies() Returns the Collection of Requirements.Dependency instances comprising this Requirements.
boolean	isEmpty() Returns true if this Requirements has no Requirements.Dependency instances.
void	setDependencies(Collection<Requirements.Dependency> dependencies) Installs the Collection of Requirements.Dependency instances comprising this Requirements.

Methods inherited from class java.lang.Object

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

Constructor Detail

Requirements

public Requirements()

Creates a new Requirements.

Method Detail

isEmpty

public final boolean isEmpty()

Returns true if this Requirements has no Requirements.Dependency instances.

Returns:

true if this Requirements is empty; false otherwise

getDependencies

public final Collection<Requirements.Dependency> getDependencies()

Returns the Collection of Requirements.Dependency instances comprising this Requirements.

This method may return null.

See Also:

setDependencies(Collection)

setDependencies

public final void setDependencies(Collection<Requirements.Dependency> dependencies)

Installs the Collection of Requirements.Dependency instances comprising this Requirements.

Parameters:

dependencies - the Collection of Requirements.Dependency instances that will comprise this Requirements; may be null; not copied or cloned

See Also:

getDependencies()

fromChartOrBuilder

public static final Requirements fromChartOrBuilder(ChartOuterClass.ChartOrBuilder chart)

Creates a new Requirements from a top-level requirements.yaml resource present in the supplied ChartOuterClass.ChartOrBuilder and returns it.

This method may return null if the supplied ChartOuterClass.ChartOrBuilder is itself null or doesn't have a requirements.yaml resource.

Parameters:

chart - the ChartOuterClass.ChartOrBuilder housing a requirement.yaml resource; may be null in which case null will be returned

Returns:

a new Requirements or null

apply

public static final ChartOuterClass.Chart.Builder apply(ChartOuterClass.Chart.Builder chartBuilder,
                                                        ConfigOuterClass.ConfigOrBuilder userSuppliedValues)

Applies a variety of rules concerning subchart aliasing and enablement to the contents of the supplied Chart.Builder.

This method never returns null

Parameters:

chartBuilder - the Chart.Builder whose subcharts may be affected; must not be null

userSuppliedValues - a ConfigOuterClass.ConfigOrBuilder representing overriding values; may be null

Returns:

the supplied chartBuilder for convenience; never null

Throws:

NullPointerException - if chartBuilder is null