Enum Class MazeOperations.RemovalMode

java.lang.Object

java.lang.Enum<MazeOperations.RemovalMode>

dev.despical.mazeengine.api.MazeOperations.RemovalMode

All Implemented Interfaces:

Serializable, Comparable<MazeOperations.RemovalMode>, Constable

Enclosing interface:

MazeOperations

public static enum MazeOperations.RemovalMode
extends Enum<MazeOperations.RemovalMode>

Determines what happens to the maze's block volume during removal.

The policy affects terrain handling only. Successful removal also deletes the saved maze metadata and releases its identifier.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	Restores original terrain when the maze has a recorded snapshot.
CLEAR	Clears the entire bounded volume to air.
RESTORE	Requires restoration of the complete original terrain snapshot.

Method Summary

Modifier and Type	Method	Description
static MazeOperations.RemovalMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MazeOperations.RemovalMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTO

public static final MazeOperations.RemovalMode AUTO

Restores original terrain when the maze has a recorded snapshot.

If no snapshot was recorded, removal clears the volume to air. A recorded but missing snapshot is a restore error and does not fall back to clearing.

RESTORE

public static final MazeOperations.RemovalMode RESTORE

Requires restoration of the complete original terrain snapshot.

WorldEdit or FAWE and the saved snapshot file must be available. A maze without a complete snapshot is rejected before removal is submitted.

CLEAR

public static final MazeOperations.RemovalMode CLEAR

Clears the entire bounded volume to air.

This policy clears terrain even when an original snapshot exists. It does not require WorldEdit or FAWE for snapshot restoration.

Method Details

values

public static MazeOperations.RemovalMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MazeOperations.RemovalMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null