Record Class DockerComposeOrigin

java.lang.Object
java.lang.Record
org.springframework.boot.docker.compose.core.DockerComposeOrigin
Record Components:
composeFile - the Docker Compose file
serviceName - name of the Docker Compose service
All Implemented Interfaces:
org.springframework.boot.origin.Origin
public record DockerComposeOrigin(@Nullable DockerComposeFile composeFile, String serviceName) extends Record implements org.springframework.boot.origin.Origin
An origin which points to a service defined in Docker Compose.
Since:
3.1.0

  • Constructor Details

    • DockerComposeOrigin

      public DockerComposeOrigin(@Nullable DockerComposeFile composeFile, String serviceName)
      Creates an instance of a DockerComposeOrigin record class.
      Parameters:
      composeFile - the value for the composeFile record component
      serviceName - the value for the serviceName record component

  • Method Details

    • toString

      public 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • composeFile

      public @Nullable DockerComposeFile composeFile()
      Returns the value of the composeFile record component.
      Returns:
      the value of the composeFile record component

    • serviceName

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