org.pepsoft.worldpainter.importing

Class JavaMapImporter

java.lang.Object

org.pepsoft.worldpainter.importing.MapImporter

org.pepsoft.worldpainter.importing.JavaMapImporter

public class JavaMapImporter
extends MapImporter

An importer of Minecraft-like maps (with Minecraft-compatible level.dat files and based on BlockBasedPlatformProviders.

Nested Class Summary

Nested classes/interfaces inherited from class org.pepsoft.worldpainter.importing.MapImporter

MapImporter.ReadOnlyOption

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,Terrain>	TERRAIN_MAPPING

Constructor Summary

Constructors

Constructor and Description
JavaMapImporter(Platform platform, TileFactory tileFactory, java.io.File levelDatFile, java.util.Set<MinecraftCoords> chunksToSkip, MapImporter.ReadOnlyOption readOnlyOption, java.util.Set<java.lang.Integer> dimensionsToImport)

Method Summary

Modifier and Type	Method and Description
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.
java.lang.String	getWarnings() Get the warnings generated by the import, or null if there were none.
protected World2	importWorld(JavaLevel level)

Methods inherited from class org.pepsoft.worldpainter.importing.MapImporter

doImport

Methods inherited from class java.lang.Object

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

Field Detail

TERRAIN_MAPPING

public static final java.util.Map<java.lang.String,Terrain> TERRAIN_MAPPING

Constructor Detail

JavaMapImporter

public JavaMapImporter(Platform platform,
                       TileFactory tileFactory,
                       java.io.File levelDatFile,
                       java.util.Set<MinecraftCoords> chunksToSkip,
                       MapImporter.ReadOnlyOption readOnlyOption,
                       java.util.Set<java.lang.Integer> dimensionsToImport)

Method Detail

doImport

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

Description copied from class: MapImporter

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

Specified by:

doImport in class MapImporter

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.

importWorld

protected World2 importWorld(JavaLevel level)

getWarnings

public java.lang.String getWarnings()

Description copied from class: MapImporter

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).

Specified by:

getWarnings in class MapImporter

Returns:

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