Package io.github.pgatzka.docker.dsl.waitable

Record Class TcpPort

java.lang.Object
java.lang.Record
io.github.pgatzka.docker.dsl.waitable.TcpPort
Record Components:
port - container-side TCP port number to probe
All Implemented Interfaces:
Waitable, Serializable
public record TcpPort(int port) extends Record implements Waitable
Readiness strategy that waits until the given TCP port (inside the container) accepts a connection. Use Waitable.tcpPort(int) to obtain an instance.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    TcpPort(int port)
    Creates an instance of a TcpPort record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    port()
    Returns the value of the port record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TcpPort

      public TcpPort(int port)
      Creates an instance of a TcpPort record class.
      Parameters:
      port - the value for the port 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. All components in this record class 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.

    • port

      public int port()
      Returns the value of the port record component.
      Returns:
      the value of the port record component