org.testcontainers.utility

Class DockerImageName

java.lang.Object

org.testcontainers.utility.DockerImageName

public final class DockerImageName
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DockerImageName(java.lang.String fullImageName) Deprecated. use parse(String) instead
DockerImageName(java.lang.String nameWithoutTag, @NotNull java.lang.String version) Deprecated. use parse(String).withTag(String) instead

Method Summary

Modifier and Type	Method and Description
java.lang.String	asCanonicalNameString()
DockerImageName	asCompatibleSubstituteFor(DockerImageName otherImageName) Declare that this DockerImageName is a compatible substitute for another image - i.e.
DockerImageName	asCompatibleSubstituteFor(java.lang.String otherImageName) Declare that this DockerImageName is a compatible substitute for another image - i.e.
void	assertCompatibleWith(DockerImageName... anyOthers) Behaves as isCompatibleWith(DockerImageName) but throws an exception rather than returning false if a mismatch is detected.
void	assertValid() Is the image name valid?
boolean	equals(java.lang.Object o)
java.lang.String	getRegistry()
java.lang.String	getUnversionedPart()
java.lang.String	getVersionPart()
int	hashCode()
boolean	isCompatibleWith(DockerImageName other) Test whether this DockerImageName has declared compatibility with another image (set using asCompatibleSubstituteFor(String) or asCompatibleSubstituteFor(DockerImageName).
static DockerImageName	parse(java.lang.String fullImageName) Parses a docker image name from a provided string.
java.lang.String	toString()
DockerImageName	withTag(java.lang.String newTag)

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerImageName

@Deprecated
public DockerImageName(java.lang.String fullImageName)

Deprecated. use parse(String) instead

Parses a docker image name from a provided string.

Parameters:

fullImageName - in standard Docker format, e.g. name:tag, some.registry/path/name:tag, some.registry/path/name@sha256:abcdef..., etc.

DockerImageName

@Deprecated
public DockerImageName(java.lang.String nameWithoutTag,
                                   @NotNull
                                   @NotNull java.lang.String version)

Deprecated. use parse(String).withTag(String) instead

Parses a docker image name from a provided string, and uses a separate provided version.

Parameters:

nameWithoutTag - in standard Docker format, e.g. name, some.registry/path/name, some.registry/path/name, etc.

version - a docker image version identifier, either as a tag or sha256 checksum, e.g. tag, sha256:abcdef....

Method Detail

parse

public static DockerImageName parse(java.lang.String fullImageName)

Parses a docker image name from a provided string.

Parameters:

fullImageName - in standard Docker format, e.g. name:tag, some.registry/path/name:tag, some.registry/path/name@sha256:abcdef..., etc.

getUnversionedPart

public java.lang.String getUnversionedPart()

Returns:

the unversioned (non 'tag') part of this name

getVersionPart

public java.lang.String getVersionPart()

Returns:

the versioned part of this name (tag or sha256)

asCanonicalNameString

public java.lang.String asCanonicalNameString()

Returns:

canonical name for the image

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

assertValid

public void assertValid()

Is the image name valid?

Throws:

java.lang.IllegalArgumentException - if not valid

getRegistry

public java.lang.String getRegistry()

withTag

public DockerImageName withTag(java.lang.String newTag)

Parameters:

newTag - version tag for the copy to use

Returns:

an immutable copy of this DockerImageName with the new version tag

asCompatibleSubstituteFor

public DockerImageName asCompatibleSubstituteFor(java.lang.String otherImageName)

Declare that this DockerImageName is a compatible substitute for another image - i.e. that this image behaves as the other does, and is compatible with Testcontainers' assumptions about the other image.

Parameters:

otherImageName - the image name of the other image

Returns:

an immutable copy of this DockerImageName with the compatibility declaration attached.

asCompatibleSubstituteFor

public DockerImageName asCompatibleSubstituteFor(DockerImageName otherImageName)

Declare that this DockerImageName is a compatible substitute for another image - i.e. that this image behaves as the other does, and is compatible with Testcontainers' assumptions about the other image.

Parameters:

otherImageName - the image name of the other image

Returns:

an immutable copy of this DockerImageName with the compatibility declaration attached.

isCompatibleWith

public boolean isCompatibleWith(DockerImageName other)

Test whether this DockerImageName has declared compatibility with another image (set using asCompatibleSubstituteFor(String) or asCompatibleSubstituteFor(DockerImageName).

If a version tag part is present in the other image name, the tags must exactly match, unless it is 'latest'. If a version part is not present in the other image name, the tag contents are ignored.

Parameters:

other - the other image that we are trying to test compatibility with

Returns:

whether this image has declared compatibility.

assertCompatibleWith

public void assertCompatibleWith(DockerImageName... anyOthers)

Behaves as isCompatibleWith(DockerImageName) but throws an exception rather than returning false if a mismatch is detected.

Parameters:

anyOthers - the other image(s) that we are trying to check compatibility with. If more than one is provided, this method will check compatibility with at least one of them.

Throws:

java.lang.IllegalStateException - if isCompatibleWith(DockerImageName) returns false

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object