Record Class IAnimatedBlockRecoveryData.EmptyRecoveryData

java.lang.Object
java.lang.Record
nl.pim16aap2.animatedarchitecture.spigot.core.animation.recovery.IAnimatedBlockRecoveryData.EmptyRecoveryData
All Implemented Interfaces:
IAnimatedBlockRecoveryData
Enclosing interface:
IAnimatedBlockRecoveryData
public static record IAnimatedBlockRecoveryData.EmptyRecoveryData() extends Record implements IAnimatedBlockRecoveryData
Represents an empty recovery data object.

This object does nothing when recover() is called.

This is useful in situations where no recovery action is needed (e.g. when the block is a preview block and does not alter the world).

See Also:

  • Constructor Details

    • EmptyRecoveryData

      public EmptyRecoveryData()
      Creates an instance of a EmptyRecoveryData record class.

  • Method Details

    • recover

      public boolean recover()
      Description copied from interface: IAnimatedBlockRecoveryData
      Attempts recovery of the animated block display.

      This method gives the animated block the opportunity to recover from a crash or other unexpected event.

      No guarantees are made about the exact behavior of this method, but as long as any kind of recovery action is performed, this method should return true. Only when this method is a no-op should it return false.

      Specified by:
      recover in interface IAnimatedBlockRecoveryData
      Returns:
      True if a recovery action was performed, 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.
      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.