org.springframework.boot.buildpack.platform.docker.type

Class VolumeName

java.lang.Object

org.springframework.boot.buildpack.platform.docker.type.VolumeName

public final class VolumeName
extends java.lang.Object

A Docker volume name.

Since:

2.3.0

Method Summary

Modifier and Type	Method and Description
static <S> VolumeName	basedOn(S source, java.util.function.Function<S,java.lang.String> nameExtractor, java.lang.String prefix, java.lang.String suffix, int digestLength) Factory method to create a new VolumeName based on an object.
static <S> VolumeName	basedOn(S source, java.lang.String prefix, java.lang.String suffix, int digestLength) Factory method to create a new VolumeName based on an object.
boolean	equals(java.lang.Object obj)
int	hashCode()
static VolumeName	of(java.lang.String value) Factory method to create a VolumeName with a specific value.
static VolumeName	random(java.lang.String prefix) Factory method to create a new VolumeName with a random name.
static VolumeName	random(java.lang.String prefix, int randomLength) Factory method to create a new VolumeName with a random name.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

random

public static VolumeName random(java.lang.String prefix)

Factory method to create a new VolumeName with a random name.

Parameters:

prefix - the prefix to use with the random name

Returns:

a randomly named volume

random

public static VolumeName random(java.lang.String prefix,
                                int randomLength)

Factory method to create a new VolumeName with a random name.

Parameters:

prefix - the prefix to use with the random name

randomLength - the number of chars in the random part of the name

Returns:

a randomly volume reference

basedOn

public static <S> VolumeName basedOn(S source,
                                     java.lang.String prefix,
                                     java.lang.String suffix,
                                     int digestLength)

Factory method to create a new VolumeName based on an object. The resulting name will be based off a SHA-256 digest of the given object's toString() method.

Type Parameters:

S - the source object type

Parameters:

source - the source object

prefix - the prefix to use with the volume name

suffix - the suffix to use with the volume name

digestLength - the number of chars in the digest part of the name

Returns:

a name based off the image reference

basedOn

public static <S> VolumeName basedOn(S source,
                                     java.util.function.Function<S,java.lang.String> nameExtractor,
                                     java.lang.String prefix,
                                     java.lang.String suffix,
                                     int digestLength)

Factory method to create a new VolumeName based on an object. The resulting name will be based off a SHA-256 digest of the given object's name.

Type Parameters:

S - the source object type

Parameters:

source - the source object

nameExtractor - a method to extract the name of the object

prefix - the prefix to use with the volume name

suffix - the suffix to use with the volume name

digestLength - the number of chars in the digest part of the name

Returns:

a name based off the image reference

of

public static VolumeName of(java.lang.String value)

Factory method to create a VolumeName with a specific value.

Parameters:

value - the volume reference value

Returns:

a new VolumeName instance