com.sk89q.worldedit.extent.clipboard.io

Enum ClipboardFormat

java.lang.Object

java.lang.Enum<ClipboardFormat>

com.sk89q.worldedit.extent.clipboard.io.ClipboardFormat

All Implemented Interfaces:

Serializable, Comparable<ClipboardFormat>

public enum ClipboardFormat
extends Enum<ClipboardFormat>

A collection of supported clipboard formats.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SCHEMATIC The Schematic format used by many software.

Method Summary

Modifier and Type	Method and Description
static ClipboardFormat	findByAlias(String alias) Find the clipboard format named by the given alias.
static ClipboardFormat	findByFile(File file) Detect the format given a file.
Set<String>	getAliases() Get a set of aliases.
abstract ClipboardReader	getReader(InputStream inputStream) Create a reader.
abstract ClipboardWriter	getWriter(OutputStream outputStream) Create a writer.
abstract boolean	isFormat(File file) Return whether the given file is of this format.
static ClipboardFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClipboardFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SCHEMATIC

public static final ClipboardFormat SCHEMATIC

The Schematic format used by many software.

Method Detail

values

public static ClipboardFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClipboardFormat c : ClipboardFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClipboardFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getAliases

public Set<String> getAliases()

Get a set of aliases.

Returns:

a set of aliases

getReader

public abstract ClipboardReader getReader(InputStream inputStream)
                                   throws IOException

Create a reader.

Parameters:

inputStream - the input stream

Returns:

a reader

Throws:

IOException - thrown on I/O error

getWriter

public abstract ClipboardWriter getWriter(OutputStream outputStream)
                                   throws IOException

Create a writer.

Parameters:

outputStream - the output stream

Returns:

a writer

Throws:

IOException - thrown on I/O error

isFormat

public abstract boolean isFormat(File file)

Return whether the given file is of this format.

Parameters:

file - the file

Returns:

true if the given file is of this format

findByAlias

@Nullable
public static ClipboardFormat findByAlias(String alias)

Find the clipboard format named by the given alias.

Parameters:

alias - the alias

Returns:

the format, otherwise null if none is matched

findByFile

@Nullable
public static ClipboardFormat findByFile(File file)

Detect the format given a file.

Parameters:

file - the file

Returns:

the format, otherwise null if one cannot be detected