Enum Class BuiltInClipboardFormat

java.lang.Object

java.lang.Enum<BuiltInClipboardFormat>

com.sk89q.worldedit.extent.clipboard.io.BuiltInClipboardFormat

All Implemented Interfaces:

ClipboardFormat, Serializable, Comparable<BuiltInClipboardFormat>, Constable

public enum BuiltInClipboardFormat
extends Enum<BuiltInClipboardFormat>
implements ClipboardFormat

A collection of supported clipboard formats.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BROKENENTITY
FAST_V2
FAST_V3
MCEDIT_SCHEMATIC	The Schematic format used by MCEdit.
MINECRAFT_STRUCTURE	The structure block format: Structure file - Minecraft Wiki
PNG	Isometric PNG writer.
SPONGE_V1_SCHEMATIC
SPONGE_V2_SCHEMATIC	Deprecated. Slow, resource intensive, but sometimes safer than using the recommended FAST_V2.
SPONGE_V3_SCHEMATIC

Field Summary

Fields

Modifier and Type	Field	Description
static final BuiltInClipboardFormat	FAST	Deprecated. Use FAST_V2 or FAST_V3
static final BuiltInClipboardFormat	SPONGE_SCHEMATIC	Deprecated. Use SPONGE_V2_SCHEMATIC or SPONGE_V3_SCHEMATIC

Method Summary

Modifier and Type	Method	Description
Set<String>	getAliases()	Get a set of aliases.
Set<String>	getFileExtensions()	Get the file extensions this format is commonly known to use.
String	getName()	Returns the name of this format.
static BuiltInClipboardFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BuiltInClipboardFormat[]	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

Methods inherited from interface ClipboardFormat

getExplicitFileExtensions, getPrimaryFileExtension, getReader, getWriter, hold, isFormat, isFormat, load, load, upload, write

Enum Constant Details

FAST_V3

public static final BuiltInClipboardFormat FAST_V3

FAST_V2

public static final BuiltInClipboardFormat FAST_V2

MCEDIT_SCHEMATIC

public static final BuiltInClipboardFormat MCEDIT_SCHEMATIC

The Schematic format used by MCEdit.

SPONGE_V1_SCHEMATIC

public static final BuiltInClipboardFormat SPONGE_V1_SCHEMATIC

SPONGE_V2_SCHEMATIC

@Deprecated
public static final BuiltInClipboardFormat SPONGE_V2_SCHEMATIC

Deprecated.

Slow, resource intensive, but sometimes safer than using the recommended FAST_V2. Avoid using with any large schematics/clipboards for reading/writing.

SPONGE_V3_SCHEMATIC

public static final BuiltInClipboardFormat SPONGE_V3_SCHEMATIC

BROKENENTITY

public static final BuiltInClipboardFormat BROKENENTITY

MINECRAFT_STRUCTURE

public static final BuiltInClipboardFormat MINECRAFT_STRUCTURE

The structure block format: Structure file - Minecraft Wiki

PNG

public static final BuiltInClipboardFormat PNG

Isometric PNG writer. Only supports solid, full-cube blocks and creates a view of the clipboard looking FROM the south east of the clipboard

Field Details

SPONGE_SCHEMATIC

@Deprecated
public static final BuiltInClipboardFormat SPONGE_SCHEMATIC

Deprecated.

Use SPONGE_V2_SCHEMATIC or SPONGE_V3_SCHEMATIC

For backwards compatibility, this points to the Sponge Schematic Specification (Version 2) format. This should not be used going forwards.

FAST

@Deprecated
public static final BuiltInClipboardFormat FAST

Deprecated.

Use FAST_V2 or FAST_V3

For backwards compatibility, this points to the fast implementation of the Sponge Schematic Specification (Version 2) format. This should not be used going forwards.

Method Details

values

public static BuiltInClipboardFormat[] 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 BuiltInClipboardFormat 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

getName

public String getName()

Description copied from interface: ClipboardFormat

Returns the name of this format.

Specified by:

getName in interface ClipboardFormat

Returns:

The name of the format

getAliases

public Set<String> getAliases()

Description copied from interface: ClipboardFormat

Get a set of aliases.

Specified by:

getAliases in interface ClipboardFormat

Returns:

a set of aliases

getFileExtensions

public Set<String> getFileExtensions()

Description copied from interface: ClipboardFormat

Get the file extensions this format is commonly known to use. This should include ClipboardFormat.getPrimaryFileExtension().

Specified by:

getFileExtensions in interface ClipboardFormat

Returns:

The file extensions this format might be known by