ChartRepository.Index.Entry (microBean Helm 2.8.2.1.1.1 API)

java.lang.Object
- org.microbean.helm.chart.repository.ChartRepository.Index.Entry

All Implemented Interfaces:

Comparable<ChartRepository.Index.Entry>

Enclosing class:

ChartRepository.Index
```
@Experimental
public static final class ChartRepository.Index.Entry
extends Object
implements Comparable<ChartRepository.Index.Entry>
```
An entry in a Helm chart repository index.

Author:

Laird Nelson

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(ChartRepository.Index.Entry her)` Compares this `ChartRepository.Index.Entry` to the supplied `ChartRepository.Index.Entry` and returns a value less than `0` if this `ChartRepository.Index.Entry` is "less than" the supplied `ChartRepository.Index.Entry`, `1` if this `ChartRepository.Index.Entry` is "greater than" the supplied `ChartRepository.Index.Entry` and `0` if this `ChartRepository.Index.Entry` is equal to the supplied `ChartRepository.Index.Entry`.
`boolean`	`equals(Object other)` Returns `true` if the supplied `Object` is an `ChartRepository.Index.Entry` and has a name and version equal to those of this `ChartRepository.Index.Entry`.
`String`	`getDigest()` Returns the SHA-256 message digest, in hexadecimal-encoded `String` form, associated with this `ChartRepository.Index.Entry`.
`static @Experimental String`	`getDigest(InputStream inputStream)` Computes a SHA-256 message digest of the bytes readable from the supplied `InputStream` and returns the result of hexadecimal-encoding it.
`URI`	`getFirstUri()` A convenience method that returns the first `URI` in the `Set` of `URI`s returned by the `getUris()` method.
`MetadataOuterClass.MetadataOrBuilder`	`getMetadataOrBuilder()` Returns the `MetadataOuterClass.MetadataOrBuilder` that comprises most of the contents of this `ChartRepository.Index.Entry`.
`String`	`getName()` Returns the return value of invoking the `MetadataOuterClass.MetadataOrBuilder.getName()` method on the `MetadataOuterClass.MetadataOrBuilder` returned by this `ChartRepository.Index.Entry`'s `getMetadataOrBuilder()` method.
`Set<URI>`	`getUris()` Returns a non-`null`, immutable `Set` of `URI`s representing the URIs from which the Helm chart described by this `ChartRepository.Index.Entry` may be downloaded.
`String`	`getVersion()` Returns the return value of invoking the `MetadataOuterClass.MetadataOrBuilder.getVersion()` method on the `MetadataOuterClass.MetadataOrBuilder` returned by this `ChartRepository.Index.Entry`'s `getMetadataOrBuilder()` method.
`int`	`hashCode()` Returns a hashcode for this `ChartRepository.Index.Entry` based off its name and version.
`String`	`toString()` Returns a non-`null` `String` representation of this `ChartRepository.Index.Entry`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - compareTo
```
public final int compareTo(ChartRepository.Index.Entry her)
```
    Compares this ChartRepository.Index.Entry to the supplied ChartRepository.Index.Entry and returns a value less than 0 if this ChartRepository.Index.Entry is "less than" the supplied ChartRepository.Index.Entry, 1 if this ChartRepository.Index.Entry is "greater than" the supplied ChartRepository.Index.Entry and 0 if this ChartRepository.Index.Entry is equal to the supplied ChartRepository.Index.Entry.
    ChartRepository.Index.Entry objects are compared by name first, then version.
    
    It is intended that this compareTo(ChartRepository.Index.Entry) method is consistent with equals.
    
    Specified by:
    
    compareTo in interface Comparable<ChartRepository.Index.Entry>
    
    Parameters:
    
    her - the ChartRepository.Index.Entry to compare; must not be null
    
    Returns:
    
    a value less than 0 if this ChartRepository.Index.Entry is "less than" the supplied ChartRepository.Index.Entry, 1 if this ChartRepository.Index.Entry is "greater than" the supplied ChartRepository.Index.Entry and 0 if this ChartRepository.Index.Entry is equal to the supplied ChartRepository.Index.Entry
    
    Throws:
    
    NullPointerException - if the supplied ChartRepository.Index.Entry is null
  - hashCode
```
public final int hashCode()
```
    Returns a hashcode for this ChartRepository.Index.Entry based off its name and version.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hashcode for this ChartRepository.Index.Entry
    
    See Also:
    
    compareTo(ChartRepository.Index.Entry), equals(Object), getName(), getVersion()
  - equals
```
public final boolean equals(Object other)
```
    Returns true if the supplied Object is an ChartRepository.Index.Entry and has a name and version equal to those of this ChartRepository.Index.Entry.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - the Object to test; may be null in which case false will be returned
    
    Returns:
    
    true if this ChartRepository.Index.Entry is equal to the supplied Object; false otherwise
    
    See Also:
    
    compareTo(ChartRepository.Index.Entry), getName(), getVersion(), hashCode()
  - getMetadataOrBuilder
```
public final MetadataOuterClass.MetadataOrBuilder getMetadataOrBuilder()
```
    Returns the MetadataOuterClass.MetadataOrBuilder that comprises most of the contents of this ChartRepository.Index.Entry.
    This method never returns null.
    
    Returns:
    
    the MetadataOuterClass.MetadataOrBuilder that comprises most of the contents of this ChartRepository.Index.Entry; never null
  - getName
```
public final String getName()
```
    Returns the return value of invoking the MetadataOuterClass.MetadataOrBuilder.getName() method on the MetadataOuterClass.MetadataOrBuilder returned by this ChartRepository.Index.Entry's getMetadataOrBuilder() method.
    This method may return null.
    
    Returns:
    
    this ChartRepository.Index.Entry's name, or null
    
    See Also:
    
    MetadataOuterClass.MetadataOrBuilder.getName()
  - getVersion
```
public final String getVersion()
```
    Returns the return value of invoking the MetadataOuterClass.MetadataOrBuilder.getVersion() method on the MetadataOuterClass.MetadataOrBuilder returned by this ChartRepository.Index.Entry's getMetadataOrBuilder() method.
    This method may return null.
    
    Returns:
    
    this ChartRepository.Index.Entry's version, or null
    
    See Also:
    
    MetadataOuterClass.MetadataOrBuilder.getVersion()
  - getUris
```
public final Set<URI> getUris()
```
    Returns a non-null, immutable Set of URIs representing the URIs from which the Helm chart described by this ChartRepository.Index.Entry may be downloaded.
    This method never returns null.
    
    Returns:
    
    a non-null, immutable Set of URIs representing the URIs from which the Helm chart described by this ChartRepository.Index.Entry may be downloaded
    
    See Also:
    
    getFirstUri()
  - getFirstUri
```
public final URI getFirstUri()
```
    A convenience method that returns the first URI in the Set of URIs returned by the getUris() method.
    This method may return null.
    
    Returns:
    
    the first URI in the Set of URIs returned by the getUris() method, or null
    
    See Also:
    
    getUris()
  - getDigest
```
public final String getDigest()
```
    Returns the SHA-256 message digest, in hexadecimal-encoded String form, associated with this ChartRepository.Index.Entry.
    This method may return null.
    
    Returns:
    
    the SHA-256 message digest, in hexadecimal-encoded String form, associated with this ChartRepository.Index.Entry, or null
  - toString
```
public final String toString()
```
    Returns a non-null String representation of this ChartRepository.Index.Entry.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a non-null String representation of this ChartRepository.Index.Entry
  - getDigest
```
@Experimental
public static final @Experimental String getDigest(InputStream inputStream)
                                                          throws IOException
```
    Computes a SHA-256 message digest of the bytes readable from the supplied InputStream and returns the result of hexadecimal-encoding it.
    This method never returns null.
    
    Parameters:
    
    inputStream - the InputStream to read from; must not be null
    
    Returns:
    
    a hexadecimal-encoded SHA-256 message digest; never null
    
    Throws:
    
    NullPointerException - if inputStream is null
    
    IOException - if an input or output error occurs

Class ChartRepository.Index.Entry

Method Summary

Methods inherited from class java.lang.Object

Method Detail

compareTo

hashCode

equals

getMetadataOrBuilder

getName

getVersion

getUris

getFirstUri

getDigest

toString

getDigest