org.testcontainers.utility

Class ImageNameSubstitutor

java.lang.Object

org.testcontainers.utility.ImageNameSubstitutor

All Implemented Interfaces:

java.util.function.Function<DockerImageName,DockerImageName>

@UnstableAPI
public abstract class ImageNameSubstitutor
extends java.lang.Object
implements java.util.function.Function<DockerImageName,DockerImageName>

An image name substitutor converts a Docker image name, as may be specified in code, to an alternative name. This is intended to provide a way to override image names, for example to enforce pulling of images from a private registry.

This is marked as @UnstableAPI as this API is new. While we do not think major changes will be required, we will react to feedback if necessary.

Constructor Summary

Constructors

Constructor and Description
ImageNameSubstitutor()

Method Summary

Modifier and Type	Method and Description
abstract DockerImageName	apply(DockerImageName original) Substitute a DockerImageName for another, for example to replace a generic Docker Hub image name with a private registry copy of the image.
protected abstract java.lang.String	getDescription()
static ImageNameSubstitutor	instance()
static ImageNameSubstitutor	noop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

ImageNameSubstitutor

public ImageNameSubstitutor()

Method Detail

instance

public static ImageNameSubstitutor instance()

noop

public static ImageNameSubstitutor noop()

apply

public abstract DockerImageName apply(DockerImageName original)

Substitute a DockerImageName for another, for example to replace a generic Docker Hub image name with a private registry copy of the image.

Specified by:

apply in interface java.util.function.Function<DockerImageName,DockerImageName>

Parameters:

original - original name to be replaced

Returns:

a replacement name, or the original, as appropriate

getDescription

protected abstract java.lang.String getDescription()

Returns:

a human-readable description of the substitutor