Package com.zb.mom.ww.mxgateway.client

Record Class MxStatuses.MxStatusView

java.lang.Object
java.lang.Record
com.zb.mom.ww.mxgateway.client.MxStatuses.MxStatusView
Record Components:
raw - the underlying status proxy this view delegates to
Enclosing class:
MxStatuses
public static record MxStatuses.MxStatusView(MxaccessGateway.MxStatusProxy raw) extends Record
Idiomatic-Java accessor view over a raw MxaccessGateway.MxStatusProxy.

  • Constructor Details

    • MxStatusView

      public MxStatusView(MxaccessGateway.MxStatusProxy raw)
      Creates an instance of a MxStatusView record class.
      Parameters:
      raw - the value for the raw record component

  • Method Details

    • success

      public int success()
      Returns the raw success flag (non-zero indicates success).
      Returns:
      the success flag value

    • category

      public MxaccessGateway.MxStatusCategory category()
      Returns the high-level status category.
      Returns:
      the status category enum value

    • detectedBy

      public MxaccessGateway.MxStatusSource detectedBy()
      Returns which subsystem detected the status.
      Returns:
      the detection source enum value

    • detail

      public int detail()
      Returns the detail code accompanying the status.
      Returns:
      the raw detail code

    • rawCategory

      public int rawCategory()
      Returns the raw, unmapped category code from MXAccess.
      Returns:
      the raw category integer

    • rawDetectedBy

      public int rawDetectedBy()
      Returns the raw, unmapped detection-source code from MXAccess.
      Returns:
      the raw detection-source integer

    • diagnosticText

      public String diagnosticText()
      Returns the diagnostic text supplied by MXAccess, if any.
      Returns:
      the diagnostic message, possibly empty

    • 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 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.

    • raw

      public MxaccessGateway.MxStatusProxy raw()
      Returns the value of the raw record component.
      Returns:
      the value of the raw record component