Record Class ProcessLockOrException

java.lang.Object
java.lang.Record
com.kingsrook.qqq.backend.core.processes.locks.ProcessLockOrException
public record ProcessLockOrException(ProcessLock processLock, UnableToObtainProcessLockException unableToObtainProcessLockException) extends Record
Record to hold either a processLock, or an unableToObtainProcessLockException. Used as return value from bulk-methods in ProcessLockUtils (where some requested keys may succeed and return a lock, and others may fail and return the exception).

  • Constructor Details

    • ProcessLockOrException

      public ProcessLockOrException(ProcessLock processLock)
      Constructor

    • ProcessLockOrException

      public ProcessLockOrException(UnableToObtainProcessLockException unableToObtainProcessLockException)
      Constructor

    • ProcessLockOrException

      public ProcessLockOrException(ProcessLock processLock, UnableToObtainProcessLockException unableToObtainProcessLockException)
      Creates an instance of a ProcessLockOrException record class.
      Parameters:
      processLock - the value for the processLock record component
      unableToObtainProcessLockException - the value for the unableToObtainProcessLockException 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 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.

    • processLock

      public ProcessLock processLock()
      Returns the value of the processLock record component.
      Returns:
      the value of the processLock record component

    • unableToObtainProcessLockException

      public UnableToObtainProcessLockException unableToObtainProcessLockException()
      Returns the value of the unableToObtainProcessLockException record component.
      Returns:
      the value of the unableToObtainProcessLockException record component