Record Class TransportState

java.lang.Object
java.lang.Record
com.iizix.server.push.engine.transport.TransportState
Record Components:
configured - true when a send can be attempted.
reason - Why not, when configured is false; null otherwise.
public record TransportState(boolean configured, String reason) extends Record
Whether a transport can send for an application, and when not, why.

There is one "cannot" state. A held transport (APNS) and an application with no key material both report configured=false; only the reason string differs (ruling 1, 2026-09-06).

Author:
Christopher Mindus

  • Field Details

    • CONFIGURED

      public static final TransportState CONFIGURED
      The configured state.

  • Constructor Details

    • TransportState

      public TransportState(boolean configured, String reason)
      Creates an instance of a TransportState record class.
      Parameters:
      configured - the value for the configured record component
      reason - the value for the reason record component

  • Method Details

    • notConfigured

      public static TransportState notConfigured(String reason)
      Creates a not-configured state.
      Parameters:
      reason - The reason, never null.
      Returns:
      The state.

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • configured

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

    • reason

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