com.sk89q.worldedit.schematic

Class SchematicFormat

java.lang.Object

com.sk89q.worldedit.schematic.SchematicFormat

Direct Known Subclasses:

MCEditSchematicFormat

public abstract class SchematicFormat
extends Object

Represents a format that a schematic can be stored as

Author:

zml2008

Field Summary

Fields

Modifier and Type	Field and Description
static SchematicFormat	MCEDIT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SchematicFormat(String name, String... lookupNames)

Method Summary

Methods

Modifier and Type	Method and Description
BaseBlock	getBlockForId(int id, short data)
static SchematicFormat	getFormat(File file)
static SchematicFormat	getFormat(String lookupName)
static Set<SchematicFormat>	getFormats()
String[]	getLookupNames()
String	getName() Gets the official/display name for this schematic format
abstract boolean	isOfFormat(File file)
abstract CuboidClipboard	load(File file) Loads a schematic from the given file into a CuboidClipboard
abstract void	save(CuboidClipboard clipboard, File file) Saves the data from the specified CuboidClipboard to the given file, overwriting any existing data in the file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MCEDIT

public static final SchematicFormat MCEDIT

Constructor Detail

SchematicFormat

protected SchematicFormat(String name,
               String... lookupNames)

Method Detail

getFormats

public static Set<SchematicFormat> getFormats()

getFormat

public static SchematicFormat getFormat(String lookupName)

getFormat

public static SchematicFormat getFormat(File file)

getName

public String getName()

Gets the official/display name for this schematic format

Returns:

The display name for this schematic format

getLookupNames

public String[] getLookupNames()

getBlockForId

public BaseBlock getBlockForId(int id,
                      short data)

load

public abstract CuboidClipboard load(File file)
                              throws IOException,
                                     DataException

Loads a schematic from the given file into a CuboidClipboard

Parameters:

file - The file to load from

Returns:

The CuboidClipboard containing the contents of this schematic

Throws:

IOException - If an error occurs while reading data

DataException - if data is not in the correct format

save

public abstract void save(CuboidClipboard clipboard,
        File file)
                   throws IOException,
                          DataException

Saves the data from the specified CuboidClipboard to the given file, overwriting any existing data in the file

Parameters:

clipboard - The clipboard to get data from

file - The file to save to

Throws:

IOException - If an error occurs while writing data

DataException - If the clipboard has data which cannot be stored

isOfFormat

public abstract boolean isOfFormat(File file)