org.microbean.helm.chart

Class Requirements.Dependency

java.lang.Object

org.microbean.helm.chart.Requirements.Dependency

Enclosing class:

Requirements

public static final class Requirements.Dependency
extends Object

A description of a subchart that should be present in a parent Helm chart; not normally used directly by end users.

Author:

Laird Nelson

See Also:

Requirements

Constructor Summary

Constructors

Constructor and Description
Dependency() Creates a new Requirements.Dependency.

Method Summary

Modifier and Type	Method and Description
String	getAlias() Returns the alias to use for the subchart identified by this Requirements.Dependency.
String	getCondition() Returns a period-separated path that, when evaluated against a Map of Maps representing user-supplied or default values, will hopefully result in a value that can, in turn, be evaluated as a truth-value to aid in the enabling and disabling of subcharts.
Collection<Object>	getImportValues() Returns a Collection representing the contents of a requirements.yaml's import-values section.
String	getName() Returns the name of the subchart being represented by this Requirements.Dependency.
String	getRepository() Returns the String representation of a URI which, when index.yaml is appended to it, results in a URI designating a Helm chart repository index.
Collection<String>	getTags() Returns the Collection of tags that can be used to enable or disable subcharts.
String	getVersion() Returns the range of acceptable semantic versions of the subchart being represented by this Requirements.Dependency.
boolean	isEnabled() Returns true if the subchart this Requirements.Dependency identifies is to be considered enabled.
boolean	selects(ChartOuterClass.ChartOrBuilder chart) Returns true if this Requirements.Dependency identifies the given ChartOuterClass.ChartOrBuilder.
void	setAlias(String alias) Sets the alias to use for the subchart identified by this Requirements.Dependency.
void	setCondition(String condition) Sets the period-separated path that, when evaluated against a Map of Maps representing user-supplied or default values, will hopefully result in a value that can, in turn, be evaluated as a truth-value to aid in the enabling and disabling of subcharts.
void	setEnabled(boolean enabled) Sets whether the subchart this Requirements.Dependency identifies is to be considered enabled.
void	setImportValues(Collection<Object> importValues) Sets the Collection representing the contents of a requirements.yaml's import-values section.
void	setName(String name) Sets the name of the subchart being represented by this Requirements.Dependency.
void	setRepository(String repository) Sets the String representation of a URI which, when index.yaml is appended to it, results in a URI designating a Helm chart repository index.
void	setTags(Collection<String> tags) Sets the Collection of tags that can be used to enable or disable subcharts.
void	setVersion(String versionRange) Sets the range of acceptable semantic versions of the subchart being represented by this Requirements.Dependency.
String	toString() Returns a String representation of this Requirements.Dependency.

Methods inherited from class java.lang.Object

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

Constructor Detail

Dependency

public Dependency()

Creates a new Requirements.Dependency.

Method Detail

getName

public final String getName()

Returns the name of the subchart being represented by this Requirements.Dependency.

This method may return null.

Returns:

the name of the subchart being represented by this Requirements.Dependency, or null

See Also:

setName(String)

setName

public final void setName(String name)

Sets the name of the subchart being represented by this Requirements.Dependency.

Parameters:

name - the new name; may be null

See Also:

getName()

getVersion

public final String getVersion()

Returns the range of acceptable semantic versions of the subchart being represented by this Requirements.Dependency.

This method may return null.

Returns:

the range of acceptable semantic versions of the subchart being represented by this Requirements.Dependency, or null

See Also:

setVersion(String)

setVersion

public final void setVersion(String versionRange)

Sets the range of acceptable semantic versions of the subchart being represented by this Requirements.Dependency.

Parameters:

versionRange - the new semantic version range; may be null

See Also:

getVersion()

getRepository

public final String getRepository()

Returns the String representation of a URI which, when index.yaml is appended to it, results in a URI designating a Helm chart repository index.

This method may return null.

Returns:

the String representation of a URI which, when index.yaml is appended to it, results in a URI designating a Helm chart repository index, or null

See Also:

setRepository(String)

setRepository

public final void setRepository(String repository)

Sets the String representation of a URI which, when index.yaml is appended to it, results in a URI designating a Helm chart repository index.

Parameters:

repository - the String representation of a URI which, when index.yaml is appended to it, results in a URI designating a Helm chart repository index, or null

See Also:

getRepository()

getCondition

public final String getCondition()

Returns a period-separated path that, when evaluated against a Map of Maps representing user-supplied or default values, will hopefully result in a value that can, in turn, be evaluated as a truth-value to aid in the enabling and disabling of subcharts.

This method may return null.

This method may return a value that actually holds several such paths separated by commas. This is an artifact of the design of Helm's requirements.yaml file.

Returns:

a period-separated path that, when evaluated against a Map of Maps representing user-supplied or default values, will hopefully result in a value that can, in turn, be evaluated as a truth-value to aid in the enabling and disabling of subcharts, or null

See Also:

setCondition(String)

setCondition

public final void setCondition(String condition)

Sets the period-separated path that, when evaluated against a Map of Maps representing user-supplied or default values, will hopefully result in a value that can, in turn, be evaluated as a truth-value to aid in the enabling and disabling of subcharts.

Parameters:

condition - a period-separated path that, when evaluated against a Map of Maps representing user-supplied or default values, will hopefully result in a value that can, in turn, be evaluated as a truth-value to aid in the enabling and disabling of subcharts, or null

See Also:

getCondition()

getTags

public final Collection<String> getTags()

Returns the Collection of tags that can be used to enable or disable subcharts.

This method may return null.

Returns:

the Collection of tags that can be used to enable or disable subcharts, or null

See Also:

setTags(Collection)

setTags

public final void setTags(Collection<String> tags)

Sets the Collection of tags that can be used to enable or disable subcharts.

Parameters:

tags - the Collection of tags that can be used to enable or disable subcharts; may be null

See Also:

getTags()

isEnabled

public final boolean isEnabled()

Returns true if the subchart this Requirements.Dependency identifies is to be considered enabled.

Returns:

true if the subchart this Requirements.Dependency identifies is to be considered enabled; false otherwise

See Also:

setEnabled(boolean)

setEnabled

public final void setEnabled(boolean enabled)

Sets whether the subchart this Requirements.Dependency identifies is to be considered enabled.

Parameters:

enabled - whether the subchart this Requirements.Dependency identifies is to be considered enabled

See Also:

isEnabled()

getImportValues

public final Collection<Object> getImportValues()

Returns a Collection representing the contents of a requirements.yaml's import-values section.

This method may return null.

Returns:

a Collection representing the contents of a requirements.yaml's import-values section, or null

See Also:

setImportValues(Collection)

setImportValues

public final void setImportValues(Collection<Object> importValues)

Sets the Collection representing the contents of a requirements.yaml's import-values section.

Parameters:

importValues - the Collection representing the contents of a requirements.yaml's import-values section; may be null

See Also:

getImportValues()

getAlias

public final String getAlias()

Returns the alias to use for the subchart identified by this Requirements.Dependency.

This method may return null.

Returns:

the alias to use for the subchart identified by this Requirements.Dependency, or null

See Also:

setAlias(String)

setAlias

public final void setAlias(String alias)

Sets the alias to use for the subchart identified by this Requirements.Dependency.

Parameters:

alias - the alias to use for the subchart identified by this Requirements.Dependency; may be null

See Also:

getAlias()

selects

public final boolean selects(ChartOuterClass.ChartOrBuilder chart)

Returns true if this Requirements.Dependency identifies the given ChartOuterClass.ChartOrBuilder.

Parameters:

chart - the ChartOuterClass.ChartOrBuilder to check; may be null in which case false will be returned

Returns:

true if this Requirements.Dependency identifies the given ChartOuterClass.ChartOrBuilder; false otherwise

toString

public final String toString()

Returns a String representation of this Requirements.Dependency.

This method never returns null.

Overrides:

toString in class Object

Returns:

a non-null String representation of this Requirements.Dependency