org.pepsoft.worldpainter.importing

Class MapImporter

java.lang.Object

org.pepsoft.worldpainter.importing.MapImporter

Direct Known Subclasses:

JavaMapImporter

public abstract class MapImporter
extends java.lang.Object

An importer of maps to WorldPainter worlds.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapImporter.ReadOnlyOption An indication of how the ReadOnly layer should be applied to the imported world.

Constructor Summary

Constructors

Constructor and Description
MapImporter()

Method Summary

Modifier and Type	Method and Description
World2	doImport() Import the map, returning it as a World2 object.
abstract World2	doImport(org.pepsoft.util.ProgressReceiver progressReceiver) Import the map (optionally reporting progress to the specified progress receiver) and returning it as a World2 object.
abstract java.lang.String	getWarnings() Get the warnings generated by the import, or null if there were none.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapImporter

public MapImporter()

Method Detail

doImport

public World2 doImport()
                throws java.io.IOException

Import the map, returning it as a World2 object. The default implementation delegates to doImport(ProgressReceiver) without specifying a progress receiver.

Returns:

The imported map as a World2 object.

Throws:

java.io.IOException - If an I/O error occurred importing the map.

doImport

public abstract World2 doImport(org.pepsoft.util.ProgressReceiver progressReceiver)
                         throws java.io.IOException,
                                org.pepsoft.util.ProgressReceiver.OperationCancelled

Import the map (optionally reporting progress to the specified progress receiver) and returning it as a World2 object.

Parameters:

progressReceiver - The progress receiver to which to report progress. May be null, indicating that no progress need be reported.

Returns:

The imported map as a World2 object.

Throws:

java.io.IOException - If an I/O error occurred importing the map.

ProgressReceiver.OperationCancelled - If the progress receiver threw an ProgressReceiver.OperationCancelled exception.

getWarnings

public abstract java.lang.String getWarnings()

Get the warnings generated by the import, or null if there were none. Multiple warnings should be on separate lines separated by line separators (\n).

Returns:

The warnings generated by the import, or null if there were none.