Package net.blakez.bppmq.core

Record Class Error

java.lang.Object
java.lang.Record
net.blakez.bppmq.core.Error
Record Components:
errorType - A string identifying the category of the error.
errorMsg - A descriptive message detailing the error.
public record Error(String errorType, String errorMsg) extends Record
Represents an error with a type and message.
Author:
Peter Blakeley : @pblakez pb@blakez.org

  • Constructor Summary

    Constructors
    Constructor
    Description
    Error(String errorType, String errorMsg)
    Creates an instance of a Error record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    errorMsg()
    Returns the value of the errorMsg record component.
    String
    errorType()
    Returns the value of the errorType record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    is(String errorType)
    Checks if the error type matches the provided string.
    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

    • Error

      public Error(String errorType, String errorMsg)
      Creates an instance of a Error record class.
      Parameters:
      errorType - the value for the errorType record component
      errorMsg - the value for the errorMsg record component

  • Method Details

    • is

      public boolean is(String errorType)
      Checks if the error type matches the provided string.
      Parameters:
      errorType - The error type string to compare against.
      Returns:
      true if the error types match, false otherwise.

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

    • errorType

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

    • errorMsg

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