Package org.openrewrite.docker.tree

Interface Docker

All Superinterfaces:
org.openrewrite.Tree
All Known Subinterfaces:
Docker.ArgumentContent, Docker.CommandForm, Docker.CopyAddForm, Docker.Instruction
All Known Implementing Classes:
Docker.Add, Docker.Arg, Docker.Argument, Docker.Cmd, Docker.Copy, Docker.CopyShellForm, Docker.Entrypoint, Docker.Env, Docker.EnvironmentVariable, Docker.ExecForm, Docker.Expose, Docker.File, Docker.Flag, Docker.From, Docker.Healthcheck, Docker.HeredocBody, Docker.HeredocForm, Docker.Label, Docker.Literal, Docker.Maintainer, Docker.Onbuild, Docker.Port, Docker.Run, Docker.Shell, Docker.ShellForm, Docker.Stage, Docker.Stopsignal, Docker.User, Docker.Volume, Docker.Workdir
public interface Docker extends org.openrewrite.Tree

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    Docker.Add
    ADD instruction - adds files from source to destination (can extract archives and fetch URLs)
    static class 
    Docker.Arg
    ARG instruction - defines a build argument
    static class 
    Docker.Argument
    An argument which can be plain text, quoted string, or environment variable
    static interface 
    Docker.ArgumentContent
    Content within an argument (text, quoted string, or variable reference)
    static class 
    Docker.Cmd
    CMD instruction - provides defaults for executing container
    static interface 
    Docker.CommandForm
    Base for command forms (used by RUN, CMD, ENTRYPOINT)
    static class 
    Docker.Copy
    COPY instruction - copies files from source to destination
    static interface 
    Docker.CopyAddForm
    Base for COPY/ADD forms (shell form, exec form, or heredoc)
    static class 
    Docker.CopyShellForm
    Shell form for COPY/ADD instructions: sources followed by destination.
    static class 
    Docker.Entrypoint
    ENTRYPOINT instruction - configures container to run as executable
    static class 
    Docker.Env
    ENV instruction - sets environment variables
    static class 
    Docker.EnvironmentVariable
    Environment variable reference like $VAR or ${VAR}
    static class 
    Docker.ExecForm
    Exec form: CMD ["executable", "param1", "param2"] Also used for COPY/ADD JSON array form.
    static class 
    Docker.Expose
    EXPOSE instruction - documents ports that the container listens on
    static class 
    Docker.File
    Root node representing a complete Dockerfile or Containerfile
    static class 
    Docker.Flag
    A flag like --platform=linux/amd64
    static class 
    Docker.From
    FROM instruction - sets the base image
    static class 
    Docker.Healthcheck
    HEALTHCHECK instruction - tells Docker how to test container health
    static class 
    Docker.HeredocBody
    Represents a single heredoc body within a heredoc command.
    static class 
    Docker.HeredocForm
    Unified heredoc form supporting both single and multiple heredocs.
    static interface 
    Docker.Instruction
    Base interface for all Dockerfile instructions
    static class 
    Docker.Label
    LABEL instruction - adds metadata to an image
    static class 
    Docker.Literal
    A literal text value, either plain (unquoted) or quoted (single/double quotes).
    static class 
    Docker.Maintainer
    MAINTAINER instruction - sets the author field (deprecated but still supported)
    static class 
    Docker.Onbuild
    ONBUILD instruction - prefixes another instruction to be executed later
    static class 
    Docker.Port
    A port specification in an EXPOSE instruction.
    static class 
    Docker.Run
    RUN instruction - executes commands
    static class 
    Docker.Shell
    SHELL instruction - sets the default shell
    static class 
    Docker.ShellForm
    Shell form: CMD command param1 param2
    static class 
    Docker.Stage
    A build stage in a multi-stage Dockerfile.
    static class 
    Docker.Stopsignal
    STOPSIGNAL instruction - sets the signal to stop the container
    static class 
    Docker.User
    USER instruction - sets the user and optionally group
    static class 
    Docker.Volume
    VOLUME instruction - creates a mount point
    static class 
    Docker.Workdir
    WORKDIR instruction - sets the working directory

  • Method Summary

    Modifier and Type
    Method
    Description
    default <R extends org.openrewrite.Tree, P>
    R
    accept(org.openrewrite.TreeVisitor<R,P> v, P p)
     
    default <P> @Nullable Docker
    acceptDocker(DockerVisitor<P> v, P p)
     
    Space
    getPrefix()
     
    default <P> boolean
    isAcceptable(org.openrewrite.TreeVisitor<?,P> v, P p)
     
    <D extends Docker>
    D
    withPrefix(Space prefix)
     

    Methods inherited from interface org.openrewrite.Tree

    cast, getId, getMarkers, isScope, print, print, print, printer, printTrimmed, printTrimmed, printTrimmed, withId, withMarkers

  • Method Details

    • accept

      default <R extends org.openrewrite.Tree, P> R accept(org.openrewrite.TreeVisitor<R,P> v, P p)
      Specified by:
      accept in interface org.openrewrite.Tree

    • acceptDocker

      default <P> @Nullable Docker acceptDocker(DockerVisitor<P> v, P p)

    • isAcceptable

      default <P> boolean isAcceptable(org.openrewrite.TreeVisitor<?,P> v, P p)
      Specified by:
      isAcceptable in interface org.openrewrite.Tree

    • getPrefix

      Space getPrefix()

    • withPrefix

      <D extends Docker> D withPrefix(Space prefix)