dev.jeka.core.api.tooling.docker

Class JkDockerBuild.DockerfileTemplate

java.lang.Object

dev.jeka.core.api.tooling.docker.JkDockerBuild.DockerfileTemplate

Enclosing class:

JkDockerBuild

public class JkDockerBuild.DockerfileTemplate
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
JkDockerBuild.DockerfileTemplate	add(java.lang.String step) Appends the specified step at the end of step container.
JkDockerBuild.DockerfileTemplate	addCopy(java.nio.file.Path fileOrDirToCopy, java.lang.String containerPath)
JkDockerBuild.DockerfileTemplate	addCopy(java.nio.file.Path fileOrDirToCopy, java.lang.String containerPath, boolean chownNonroot)
JkDockerBuild.DockerfileTemplate	addCopy(java.nio.file.Path fileOrDirToCopy, java.lang.String containerPath, boolean chownNonroot, boolean optional) A convenient method to add a COPY step for a file or directory located outside the Docker build context.
JkDockerBuild.DockerfileTemplate	addEntrypoint(java.lang.String... args) Adds an entrypoint build step
JkDockerBuild.DockerfileTemplate	addNonRootMkDirs(java.lang.String dirPath, java.lang.String... extraDirs) Adds a Dockerfile step that creates a directory, belonging to the 'nonroot' user if such a user exists.
JkDockerBuild.DockerfileTemplate	moveCursorBefore(java.lang.String prefix) Positions the cursor just before the first build step that begins with the specified prefix.
JkDockerBuild.DockerfileTemplate	moveCursorBeforeUserNonRoot() Moves the cursor just before ${switchNonRootUser} token.
JkDockerBuild.DockerfileTemplate	moveCursorNext()
JkDockerBuild.DockerfileTemplate	remove() Removes the build step currently at cursor position.
java.lang.String	render(JkDockerBuild jkDockerBuild) Renders the Dockerfile template, with tokens still present.

Methods inherited from class java.lang.Object

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

Method Detail

add

public final JkDockerBuild.DockerfileTemplate add(java.lang.String step)

Appends the specified step at the end of step container.

remove

public final JkDockerBuild.DockerfileTemplate remove()

Removes the build step currently at cursor position.

addCopy

public final JkDockerBuild.DockerfileTemplate addCopy(java.nio.file.Path fileOrDirToCopy,
                                                      java.lang.String containerPath,
                                                      boolean chownNonroot,
                                                      boolean optional)

A convenient method to add a COPY step for a file or directory located outside the Docker build context.

The specified file or directory will be copied into the Docker build context, and a corresponding COPY step will be added to the Dockerfile.

Parameters:

chownNonroot - if true, includes the '--chown=nonroot:nonrootg' option in the COPY statement.

optional - if false, an error is thrown if the specified file or directory does not exist.

addCopy

public JkDockerBuild.DockerfileTemplate addCopy(java.nio.file.Path fileOrDirToCopy,
                                                java.lang.String containerPath,
                                                boolean chownNonroot)

See Also:

addCopy(Path, String, boolean, boolean)

addCopy

public JkDockerBuild.DockerfileTemplate addCopy(java.nio.file.Path fileOrDirToCopy,
                                                java.lang.String containerPath)

See Also:

addCopy(Path, String, boolean, boolean)

addNonRootMkDirs

public JkDockerBuild.DockerfileTemplate addNonRootMkDirs(java.lang.String dirPath,
                                                         java.lang.String... extraDirs)

Adds a Dockerfile step that creates a directory, belonging to the 'nonroot' user if such a user exists.

addEntrypoint

public JkDockerBuild.DockerfileTemplate addEntrypoint(java.lang.String... args)

Adds an entrypoint build step

moveCursorBefore

public JkDockerBuild.DockerfileTemplate moveCursorBefore(java.lang.String prefix)

Positions the cursor just before the first build step that begins with the specified prefix.

Any subsequent build steps added will be appended starting from this position.

Parameters:

prefix - the prefix of the build step to locate

Returns:

the updated builder or context for chaining

moveCursorNext

public JkDockerBuild.DockerfileTemplate moveCursorNext()

moveCursorBeforeUserNonRoot

public JkDockerBuild.DockerfileTemplate moveCursorBeforeUserNonRoot()

Moves the cursor just before ${switchNonRootUser} token.

See Also:

moveCursorBefore(String)

render

public java.lang.String render(JkDockerBuild jkDockerBuild)

Renders the Dockerfile template, with tokens still present.

Parameters:

jkDockerBuild -