Package org.springframework.boot.docker.compose.core

Class ImageReference

java.lang.Object

org.springframework.boot.docker.compose.core.ImageReference

public final class ImageReference
extends Object

A reference to a Docker image of the form "imagename[:tag|@digest]".

Since:

3.1.0

Author:

Phillip Webb, Scott Frederick

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDigest()	Return the digest from the reference or null.
String	getDomain()	Return the domain for this image name.
String	getName()	Return the name of this image.
String	getTag()	Return the tag from the reference or null.
int	hashCode()
static ImageReference	of(String value)	Create a new ImageReference from the given value.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getDomain

public String getDomain()

Return the domain for this image name.

Returns:

the domain

See Also:

• ImageName.getDomain()

getName

public String getName()

Return the name of this image.

Returns:

the image name

See Also:

• ImageName.getName()

getTag

public String getTag()

Return the tag from the reference or null.

Returns:

the referenced tag

getDigest

public String getDigest()

Return the digest from the reference or null.

Returns:

the referenced digest

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static ImageReference of(String value)

Create a new ImageReference from the given value. The following value forms can be used:

• name (maps to docker.io/library/name)
• domain/name
• domain:port/name
• domain:port/name:tag
• domain:port/name@digest

Parameters:

value - the value to parse

Returns:

an ImageReference instance