org.pepsoft.worldpainter

Class WorldIO

java.lang.Object

org.pepsoft.worldpainter.WorldIO

public class WorldIO
extends java.lang.Object

A utility class for saving and loading WorldPainter worlds in the WorldPainter binary file format, with support for metadata and for loading and migrating legacy formats.

Created by Pepijn Schmitz on 02-07-15.

Constructor Summary

Constructors

Constructor and Description
WorldIO()
WorldIO(World2 world)

Method Summary

Modifier and Type	Method and Description
World2	getWorld()
void	load(java.io.InputStream in) Load a world from a binary stream to which it was previously saved by save(OutputStream), or by a previous version of WorldPainter.
void	save(java.io.OutputStream out) Save the world to a binary stream, such that it can later be loaded using load(InputStream).
void	saveCompartmentalised(java.io.OutputStream out) Save the world to a binary stream, such that it can later be loaded using load(InputStream).
void	setWorld(World2 world)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorldIO

public WorldIO()

WorldIO

public WorldIO(World2 world)

Method Detail

getWorld

public World2 getWorld()

setWorld

public void setWorld(World2 world)

save

public void save(java.io.OutputStream out)
          throws java.io.IOException

Save the world to a binary stream, such that it can later be loaded using load(InputStream). The stream is closed before returning.

Parameters:

out - The stream to which to save the world.

Throws:

java.io.IOException - If an I/O error occurred saving the world.

saveCompartmentalised

public void saveCompartmentalised(java.io.OutputStream out)
                           throws java.io.IOException

Save the world to a binary stream, such that it can later be loaded using load(InputStream). The stream is closed before returning.

This version uses a format that compresses every region separately, for faster access to individual regions without having to load the entire world.

Parameters:

out - The stream to which to save the world.

Throws:

java.io.IOException - If an I/O error occurred saving the world.

load

public void load(java.io.InputStream in)
          throws java.io.IOException,
                 UnloadableWorldException

Load a world from a binary stream to which it was previously saved by save(OutputStream), or by a previous version of WorldPainter. The stream is closed before returning.

Parameters:

in - The stream from which to load the world.

Throws:

java.io.IOException - If an I/O error occurred loading the world.

UnloadableWorldException - If some other error occurred loading the world. If metadata was present and could be loaded it will be stored in the exception.