Package io.github.pgatzka.docker.dsl.mount

Record Class VolumeMount

java.lang.Object
java.lang.Record
io.github.pgatzka.docker.dsl.mount.VolumeMount
Record Components:
volumeName - name of a volume declared in docker.volumes
containerPath - absolute path inside the container where the volume is mounted
readOnly - true if the mount should be read-only
public record VolumeMount(String volumeName, String containerPath, boolean readOnly) extends Record
Immutable description of a named-volume mount attached to a container.

  • Constructor Details

    • VolumeMount

      public VolumeMount(String volumeName, String containerPath, boolean readOnly)
      Creates an instance of a VolumeMount record class.
      Parameters:
      volumeName - the value for the volumeName record component
      containerPath - the value for the containerPath record component
      readOnly - the value for the readOnly record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • volumeName

      public String volumeName()
      Returns the value of the volumeName record component.
      Returns:
      the value of the volumeName record component

    • containerPath

      public String containerPath()
      Returns the value of the containerPath record component.
      Returns:
      the value of the containerPath record component

    • readOnly

      public boolean readOnly()
      Returns the value of the readOnly record component.
      Returns:
      the value of the readOnly record component