Package nl.pim16aap2.animatedarchitecture.spigot.core.animation.recovery

Interface IAnimatedBlockRecoveryData

All Known Implementing Classes:

IAnimatedBlockRecoveryData.AnimatedBlockRecoveryData, IAnimatedBlockRecoveryData.EmptyRecoveryData

public sealed interface IAnimatedBlockRecoveryData
permits IAnimatedBlockRecoveryData.AnimatedBlockRecoveryData, IAnimatedBlockRecoveryData.EmptyRecoveryData

Represents an object that stores recovery data for an animated block.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	IAnimatedBlockRecoveryData.AnimatedBlockRecoveryData	Represents an object that stores recovery data for an animated block.
static final record	IAnimatedBlockRecoveryData.EmptyRecoveryData	Represents an empty recovery data object.

Field Summary

Fields

Modifier and Type	Field	Description
static final IAnimatedBlockRecoveryData	EMPTY	An empty recovery data object.

Method Summary

Modifier and Type	Method	Description
boolean	recover()	Attempts recovery of the animated block display.

Field Details

EMPTY

static final IAnimatedBlockRecoveryData EMPTY

An empty recovery data object.

See Also:

• IAnimatedBlockRecoveryData.EmptyRecoveryData

Method Details

recover

@CheckReturnValue
boolean recover()
         throws RecoveryFailureException

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.

Returns:

True if a recovery action was performed, false otherwise.

Throws:

RecoveryFailureException - If something prevented the recovery action from being successful.