org.testcontainers.images.builder

Class ImageFromDockerfile

java.lang.Object

org.testcontainers.utility.LazyFuture<java.lang.String>

org.testcontainers.images.builder.ImageFromDockerfile

All Implemented Interfaces:

java.util.concurrent.Future<java.lang.String>, BuildContextBuilderTrait<ImageFromDockerfile>, ClasspathTrait<ImageFromDockerfile>, DockerfileTrait<ImageFromDockerfile>, FilesTrait<ImageFromDockerfile>, StringsTrait<ImageFromDockerfile>

public class ImageFromDockerfile
extends LazyFuture<java.lang.String>
implements BuildContextBuilderTrait<ImageFromDockerfile>, ClasspathTrait<ImageFromDockerfile>, FilesTrait<ImageFromDockerfile>, StringsTrait<ImageFromDockerfile>, DockerfileTrait<ImageFromDockerfile>

Constructor Summary

Constructors

Constructor and Description
ImageFromDockerfile()
ImageFromDockerfile(java.lang.String dockerImageName)
ImageFromDockerfile(java.lang.String dockerImageName, boolean deleteOnExit)

Method Summary

Modifier and Type	Method and Description
protected void	configure(com.github.dockerjava.api.command.BuildImageCmd buildImageCmd)
java.util.Map<java.lang.String,java.lang.String>	getBuildArgs()
java.util.Optional<java.nio.file.Path>	getDockerfile()
java.util.Optional<java.lang.String>	getDockerFilePath()
java.lang.String	getDockerImageName()
java.util.Map<java.lang.String,Transferable>	getTransferables()
boolean	isDeleteOnExit()
protected java.lang.String	resolve()
ImageFromDockerfile	withBuildArg(java.lang.String key, java.lang.String value)
ImageFromDockerfile	withBuildArgs(java.util.Map<java.lang.String,java.lang.String> args)
ImageFromDockerfile	withDockerfile(java.nio.file.Path dockerfile) Sets the Dockerfile to be used for this image.
ImageFromDockerfile	withDockerfilePath(java.lang.String relativePathFromBuildRoot) Deprecated. It is recommended to use withDockerfile(java.nio.file.Path) instead because it honors .dockerignore files and therefore will be more efficient
ImageFromDockerfile	withFileFromTransferable(java.lang.String path, Transferable transferable)

Methods inherited from class org.testcontainers.utility.LazyFuture

cancel, get, get, isCancelled, isDone

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.testcontainers.images.builder.traits.ClasspathTrait

withFileFromClasspath

Methods inherited from interface org.testcontainers.images.builder.traits.FilesTrait

withFileFromFile, withFileFromFile, withFileFromPath, withFileFromPath

Methods inherited from interface org.testcontainers.images.builder.traits.StringsTrait

withFileFromString

Methods inherited from interface org.testcontainers.images.builder.traits.DockerfileTrait

withDockerfileFromBuilder

Constructor Detail

ImageFromDockerfile

public ImageFromDockerfile()

ImageFromDockerfile

public ImageFromDockerfile(java.lang.String dockerImageName)

ImageFromDockerfile

public ImageFromDockerfile(java.lang.String dockerImageName,
                           boolean deleteOnExit)

Method Detail

withFileFromTransferable

public ImageFromDockerfile withFileFromTransferable(java.lang.String path,
                                                    Transferable transferable)

Specified by:

withFileFromTransferable in interface BuildContextBuilderTrait<ImageFromDockerfile>

resolve

protected final java.lang.String resolve()

Specified by:

resolve in class LazyFuture<java.lang.String>

configure

protected void configure(com.github.dockerjava.api.command.BuildImageCmd buildImageCmd)

withBuildArg

public ImageFromDockerfile withBuildArg(java.lang.String key,
                                        java.lang.String value)

withBuildArgs

public ImageFromDockerfile withBuildArgs(java.util.Map<java.lang.String,java.lang.String> args)

withDockerfilePath

@Deprecated
public ImageFromDockerfile withDockerfilePath(java.lang.String relativePathFromBuildRoot)

Deprecated. It is recommended to use withDockerfile(java.nio.file.Path) instead because it honors .dockerignore files and therefore will be more efficient

Sets the Dockerfile to be used for this image.

Parameters:

relativePathFromBuildRoot -

withDockerfile

public ImageFromDockerfile withDockerfile(java.nio.file.Path dockerfile)

Sets the Dockerfile to be used for this image.

Parameters:

dockerfile -

getDockerImageName

public java.lang.String getDockerImageName()

isDeleteOnExit

public boolean isDeleteOnExit()

getTransferables

public java.util.Map<java.lang.String,Transferable> getTransferables()

getBuildArgs

public java.util.Map<java.lang.String,java.lang.String> getBuildArgs()

getDockerFilePath

public java.util.Optional<java.lang.String> getDockerFilePath()

getDockerfile

public java.util.Optional<java.nio.file.Path> getDockerfile()