Package org.openrewrite.docker.trait

Class DockerCopyFrom

java.lang.Object

org.openrewrite.docker.trait.DockerCopyFrom

All Implemented Interfaces:

DockerImageReference<Docker.Instruction>, org.openrewrite.trait.Trait<Docker.Instruction>

public class DockerCopyFrom
extends Object
implements DockerImageReference<Docker.Instruction>

A trait representing the image reference carried by the --from flag of a COPY or ADD instruction. Provides the same semantic access to image name, tag, and digest as DockerFrom, while distinguishing an external image reference (e.g. COPY --from=nginx:latest) from a reference to an earlier build stage (e.g. COPY --from=builder or COPY --from=0). When the value refers to a build stage the image accessors return null; use isStageReference() to disambiguate.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DockerCopyFrom.Matcher	Matcher for DockerCopyFrom traits with builder-style configuration.

Nested classes/interfaces inherited from interface org.openrewrite.docker.trait.DockerImageReference

DockerImageReference.UnpinnedReason

Constructor Summary

Constructors

Constructor	Description
DockerCopyFrom()

Method Summary

Modifier and Type	Method	Description
boolean	digestMatches(String pattern)	Checks if the digest matches the given glob pattern; false for stage references or when absent.
Optional<String>	getDigest()	Returns the digest, or empty if no digest is specified or this is a stage reference.
Optional<String>	getFromValue()	Returns the raw --from value with environment variable references preserved, or empty if there is no --from flag.
Optional<String>	getImageName()	Returns the image name (without tag or digest), or empty if this is a stage reference or there is no --from flag.
Optional<String>	getTag()	Returns the tag, or empty if no tag is specified or this is a stage reference.
Optional<DockerImageReference.UnpinnedReason>	getUnpinnedReason()	Returns the reason the referenced external image is unpinned, or empty if it's pinned or this is a stage reference.
boolean	imageNameMatches(String pattern)	Checks if the image name matches the given glob pattern; always false for stage references.
boolean	isDigestPinned()	Returns true if the referenced external image is pinned by digest.
boolean	isStageReference()	Returns true if the --from value refers to an earlier build stage (by name or numeric index) rather than an external image.
boolean	isUnpinned()	Returns true if the referenced external image is unpinned (no tag or an explicit "latest" tag).
boolean	tagMatches(String pattern)	Checks if the tag matches the given glob pattern; false for stage references or when absent.
Docker.Instruction	withImageReference(String reference)	Returns the instruction with its --from value replaced by reference (e.g.
Docker.Instruction	withTag(String tag)	Returns the instruction with the tag of its external image reference replaced by tag, preserving the image name and any digest.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openrewrite.trait.Trait

getCursor, getTree

Constructor Details

DockerCopyFrom

public DockerCopyFrom()

Method Details

getFromValue

public Optional<String> getFromValue()

Returns the raw --from value with environment variable references preserved, or empty if there is no --from flag.

isStageReference

public boolean isStageReference()

Returns true if the --from value refers to an earlier build stage (by name or numeric index) rather than an external image.

getImageName

public Optional<String> getImageName()

Returns the image name (without tag or digest), or empty if this is a stage reference or there is no --from flag.

Specified by:

getImageName in interface DockerImageReference<Docker.Instruction>

getTag

public Optional<String> getTag()

Returns the tag, or empty if no tag is specified or this is a stage reference.

Specified by:

getTag in interface DockerImageReference<Docker.Instruction>

getDigest

public Optional<String> getDigest()

Returns the digest, or empty if no digest is specified or this is a stage reference.

Specified by:

getDigest in interface DockerImageReference<Docker.Instruction>

isDigestPinned

public boolean isDigestPinned()

Returns true if the referenced external image is pinned by digest.

Specified by:

isDigestPinned in interface DockerImageReference<Docker.Instruction>

isUnpinned

public boolean isUnpinned()

Returns true if the referenced external image is unpinned (no tag or an explicit "latest" tag). Stage references and digest-pinned images are considered pinned.

Specified by:

isUnpinned in interface DockerImageReference<Docker.Instruction>

getUnpinnedReason

public Optional<DockerImageReference.UnpinnedReason> getUnpinnedReason()

Returns the reason the referenced external image is unpinned, or empty if it's pinned or this is a stage reference.

Specified by:

getUnpinnedReason in interface DockerImageReference<Docker.Instruction>

withImageReference

public Docker.Instruction withImageReference(String reference)

Returns the instruction with its --from value replaced by reference (e.g. "nginx:1.25"), or unchanged if there is no --from flag.

Specified by:

withImageReference in interface DockerImageReference<Docker.Instruction>

withTag

public Docker.Instruction withTag(String tag)

Returns the instruction with the tag of its external image reference replaced by tag, preserving the image name and any digest. Unchanged for stage references.

Specified by:

withTag in interface DockerImageReference<Docker.Instruction>

imageNameMatches

public boolean imageNameMatches(String pattern)

Checks if the image name matches the given glob pattern; always false for stage references.

Specified by:

imageNameMatches in interface DockerImageReference<Docker.Instruction>

tagMatches

public boolean tagMatches(String pattern)

Checks if the tag matches the given glob pattern; false for stage references or when absent.

Specified by:

tagMatches in interface DockerImageReference<Docker.Instruction>

digestMatches

public boolean digestMatches(String pattern)

Checks if the digest matches the given glob pattern; false for stage references or when absent.

Specified by:

digestMatches in interface DockerImageReference<Docker.Instruction>