org.pepsoft.worldpainter.platforms

Class JavaPlatformProvider

java.lang.Object

org.pepsoft.worldpainter.plugins.AbstractPlugin

org.pepsoft.worldpainter.platforms.AbstractPlatformProvider

org.pepsoft.worldpainter.platforms.JavaPlatformProvider

All Implemented Interfaces:

MapExplorerSupport, BlockBasedPlatformProvider, MapImporterProvider, PlatformProvider, Plugin, Provider<Platform>

public final class JavaPlatformProvider
extends AbstractPlatformProvider
implements BlockBasedPlatformProvider, MapExplorerSupport, MapImporterProvider

A platform provider for Minecraft Java Edition chunk-based platforms.

Created by Pepijn on 9-3-2017.

Nested Class Summary

Nested classes/interfaces inherited from interface org.pepsoft.worldpainter.plugins.PlatformProvider

PlatformProvider.MapInfo

Field Summary

Fields

Modifier and Type	Field and Description
static javax.swing.Icon	ICON

Fields inherited from interface org.pepsoft.worldpainter.plugins.Plugin

PROPERTY_MINIMUM_WORLDPAINTER_VERSION, PROPERTY_NAME, PROPERTY_UUIDS, PROPERTY_VERSION

Constructor Summary

Constructors

Constructor and Description
JavaPlatformProvider()

Method Summary

Modifier and Type	Method and Description
Chunk	createChunk(Platform platform, int x, int z, int minHeight, int maxHeight) Create a new, empty chunk for a platform supported by this provider.
NBTChunk	createChunk(Platform platform, java.util.Map<DataType,org.jnbt.Tag> tags, int minHeight, int maxHeight)
NBTChunk	createChunk(Platform platform, java.util.Map<DataType,org.jnbt.Tag> tags, int minHeight, int maxHeight, boolean readOnly)
JavaChunkStore	getChunkStore(Platform platform, java.io.File worldDir, int dimension) Obtain a ChunkStore which will save chunks in the format of the platform, for a platform supported by this provider and for a specific map base directory and dimension number.
java.util.Set<DataType>	getDataTypes(Platform platform)
java.io.File	getDefaultExportDir(Platform platform) Get the default directory to select on the Export screen for a platform supported by this provider.
ExportSettings	getDefaultExportSettings(Platform platform) Get the default ExportSettings for a supported platform, or null if the platform has no export settings.
int[]	getDimensions(Platform platform, java.io.File worldDir) Determine which dimensions are present in the map specified by a particular Platform and directory.
WorldExporter	getExporter(World2 world, WorldExportSettings exportSettings) Obtain a WorldExporter for the platform currently configured in the specified world.
ExportSettingsEditor	getExportSettingsEditor(Platform platform) Get an instance of an ExportSettingsEditor suitable for editing an ExportSettings object as returned by PlatformProvider.getDefaultExportSettings(Platform).
MapImporter	getImporter(java.io.File dir, TileFactory tileFactory, java.util.Set<MinecraftCoords> chunksToSkip, MapImporter.ReadOnlyOption readOnlyOption, java.util.Set<java.lang.Integer> dimensionsToImport) Get a MapImporter configured for the specified map and settings.
Node	getMapNode(java.io.File mapDir)
PostProcessor	getPostProcessor(Platform platform) Obtain a PostProcessor for a platform supported by this provider.
RegionFile	getRegionFile(Platform platform, java.io.File regionDir, DataType dataType, java.awt.Point coords, boolean readOnly) Get a region file.
RegionFile	getRegionFileIfExists(Platform platform, java.io.File regionDir, DataType dataType, java.awt.Point coords, boolean readOnly) Get a region file, if it exists.
java.io.File[]	getRegionFiles(Platform platform, java.io.File regionDir, DataType dataType)
PlatformProvider.MapInfo	identifyMap(java.io.File dir) Identify the map in the specified directory, if it is a map supported by the plugin to which this provider belongs, and provide some identifying information if so.
java.lang.String	isCompatible(Platform platform, World2 world) Determines whether a world could be retargeted to a platform supported by this provider without requiring any changes or edits.
java.io.File	selectBackupDir(java.io.File exportDir) Indicate into which directory the existing map, if any, would be backed up if it were being exported into exportDir, but do not create it if it does not exist.

Methods inherited from class org.pepsoft.worldpainter.platforms.AbstractPlatformProvider

ensurePlatformSupported, getKeys

Methods inherited from class org.pepsoft.worldpainter.plugins.AbstractPlugin

getName, getProperties, getUUIDs, getVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepsoft.worldpainter.plugins.PlatformProvider

getMapRecognizer

Methods inherited from interface org.pepsoft.worldpainter.plugins.Provider

getKeys

Methods inherited from interface org.pepsoft.worldpainter.plugins.Plugin

getMinimumWorldPainterVersion, getName, getProperties, getUUIDs, getVersion, init

Field Detail

ICON

public static final javax.swing.Icon ICON

Constructor Detail

JavaPlatformProvider

public JavaPlatformProvider()

Method Detail

getDataTypes

public java.util.Set<DataType> getDataTypes(Platform platform)

createChunk

public NBTChunk createChunk(Platform platform,
                            java.util.Map<DataType,org.jnbt.Tag> tags,
                            int minHeight,
                            int maxHeight)

createChunk

public NBTChunk createChunk(Platform platform,
                            java.util.Map<DataType,org.jnbt.Tag> tags,
                            int minHeight,
                            int maxHeight,
                            boolean readOnly)

getRegionFiles

public java.io.File[] getRegionFiles(Platform platform,
                                     java.io.File regionDir,
                                     DataType dataType)

getRegionFile

public RegionFile getRegionFile(Platform platform,
                                java.io.File regionDir,
                                DataType dataType,
                                java.awt.Point coords,
                                boolean readOnly)
                         throws java.io.IOException

Get a region file. If readOnly is false, a region file will be created if it does not exist. Otherwise, null will be returned if the region file does not exist.

Throws:

java.io.IOException

getRegionFileIfExists

public RegionFile getRegionFileIfExists(Platform platform,
                                        java.io.File regionDir,
                                        DataType dataType,
                                        java.awt.Point coords,
                                        boolean readOnly)
                                 throws java.io.IOException

Get a region file, if it exists. Otherwise, null will be returned.

Throws:

java.io.IOException

getDimensions

public int[] getDimensions(Platform platform,
                           java.io.File worldDir)

Description copied from interface: BlockBasedPlatformProvider

Determine which dimensions are present in the map specified by a particular Platform and directory.

Specified by:

getDimensions in interface BlockBasedPlatformProvider

Parameters:

platform - The platform for which to determine the dimensions.

worldDir - The map base directory for which to determine the dimensions.

Returns:

An array of dimension numbers corresponding to the constants Constants.DIM_NORMAL, Constants.DIM_NETHER and Constants.DIM_END for dimensions which correspond to vanilla Minecraft dimensions.

createChunk

public Chunk createChunk(Platform platform,
                         int x,
                         int z,
                         int minHeight,
                         int maxHeight)

Description copied from interface: BlockBasedPlatformProvider

Create a new, empty chunk for a platform supported by this provider.

The default implementation delegates to #createChunk(Platform, int, int, int) if minHeight is zero, or throws an IllegalArgumentException otherwise.

Implementations MUST implement at least on of BlockBasedPlatformProvider.createChunk(Platform, int, int, int, int) or #createChunk(Platform, int, int, int).

Specified by:

createChunk in interface BlockBasedPlatformProvider

Parameters:

platform - The platform for which to create a chunk.

x - The X coordinate (in chunks) of the chunk to create.

z - The Z coordinate (in chunks) of the chunk to create.

minHeight - The depth (in blocks) ot the chunk to create.

maxHeight - The height (in blocks) of the chunk to create.

Returns:

The newly created chunk.

getChunkStore

public JavaChunkStore getChunkStore(Platform platform,
                                    java.io.File worldDir,
                                    int dimension)

Description copied from interface: BlockBasedPlatformProvider

Obtain a ChunkStore which will save chunks in the format of the platform, for a platform supported by this provider and for a specific map base directory and dimension number.

Specified by:

getChunkStore in interface BlockBasedPlatformProvider

Parameters:

platform - The platform for which to provide a chunk store.

worldDir - The map base directory for which to provide a chunk store.

dimension - The dimension number for which to provide a chunk store.

Returns:

A chunk store which will write chunks in the appropriate format for the specified dimension under the specified base directory.

getPostProcessor

public PostProcessor getPostProcessor(Platform platform)

Description copied from interface: BlockBasedPlatformProvider

Obtain a PostProcessor for a platform supported by this provider.

Specified by:

getPostProcessor in interface BlockBasedPlatformProvider

Parameters:

platform - The platform for which to provide a post processor.

Returns:

A post processor for the specified platform.

getExporter

public WorldExporter getExporter(World2 world,
                                 WorldExportSettings exportSettings)

Description copied from interface: PlatformProvider

Obtain a WorldExporter for the platform currently configured in the specified world.

Specified by:

getExporter in interface PlatformProvider

Parameters:

world - The world to export.

exportSettings - The export settings to use for this export. If this is null then the export settings stored on the world object will be used, if any.

Returns:

A world exporter which will export the specified world with the specified settings.

getDefaultExportDir

public java.io.File getDefaultExportDir(Platform platform)

Description copied from interface: PlatformProvider

Get the default directory to select on the Export screen for a platform supported by this provider.

Specified by:

getDefaultExportDir in interface PlatformProvider

Parameters:

platform - The platform for which to provide the default export directory.

Returns:

The default export directory for the specified platform.

selectBackupDir

public java.io.File selectBackupDir(java.io.File exportDir)

Description copied from interface: PlatformProvider

Indicate into which directory the existing map, if any, would be backed up if it were being exported into exportDir, but do not create it if it does not exist.

Specified by:

selectBackupDir in interface PlatformProvider

Parameters:

exportDir - The directory into which the world would be going to be exported.

Returns:

The directory to which the existing map at that location, if any, should be backed up, or null if this is not supported or it cannot be determined.

identifyMap

public PlatformProvider.MapInfo identifyMap(java.io.File dir)

Description copied from interface: PlatformProvider

Identify the map in the specified directory, if it is a map supported by the plugin to which this provider belongs, and provide some identifying information if so.

The default implementation returns null. This will make it harder to select maps of the type(s) supported by this platform provider for users when they wish to Import a map. If the platform provider does not support Importing this is not relevant.

Specified by:

identifyMap in interface PlatformProvider

Parameters:

dir - The directory to identify.

Returns:

Identifying information of the specified map if this class could identify it, or null if it was not recognised.

getMapNode

public Node getMapNode(java.io.File mapDir)

Specified by:

getMapNode in interface MapExplorerSupport

getImporter

public MapImporter getImporter(java.io.File dir,
                               TileFactory tileFactory,
                               java.util.Set<MinecraftCoords> chunksToSkip,
                               MapImporter.ReadOnlyOption readOnlyOption,
                               java.util.Set<java.lang.Integer> dimensionsToImport)

Description copied from interface: MapImporterProvider

Get a MapImporter configured for the specified map and settings.

Specified by:

getImporter in interface MapImporterProvider

Parameters:

dir - The directory of the map to import.

tileFactory - The TileFactory to use, optionally, for creating the tiles into which the map will be imported.

chunksToSkip - A set of coordinates of chunks to skip. The importer should act as if these chunks do not exist in the map.

readOnlyOption - Whether and how to apply the ReadOnly layer to the imported world.

dimensionsToImport - The set of dimensions (specified as a set of Constants.DIM_NORMAL, Constants.DIM_NETHER and/or Constants.DIM_END) to import.

Returns:

A map importer configured as specified.

getDefaultExportSettings

public ExportSettings getDefaultExportSettings(Platform platform)

Description copied from interface: PlatformProvider

Get the default ExportSettings for a supported platform, or null if the platform has no export settings.

The default implementation returns null.

Specified by:

getDefaultExportSettings in interface PlatformProvider

Parameters:

platform - The platform for which to provide the default export settings.

Returns:

The default ExportSettings for the specified platform, or null if the platform has no export settings.

getExportSettingsEditor

public ExportSettingsEditor getExportSettingsEditor(Platform platform)

Description copied from interface: PlatformProvider

Get an instance of an ExportSettingsEditor suitable for editing an ExportSettings object as returned by PlatformProvider.getDefaultExportSettings(Platform). Will only be invoked if PlatformProvider.getDefaultExportSettings(Platform) does not return null.

The default implementation throws an UnsupportedOperationException.

Specified by:

getExportSettingsEditor in interface PlatformProvider

Parameters:

platform - The platform for which to provide the export settings editor.

Returns:

An instance of an ExportSettingsEditor.

isCompatible

public java.lang.String isCompatible(Platform platform,
                                     World2 world)

Description copied from interface: PlatformProvider

Determines whether a world could be retargeted to a platform supported by this provider without requiring any changes or edits.

The default implementation just returns platform.isCompatible(world).

Specified by:

isCompatible in interface PlatformProvider

Parameters:

platform - The platform with which to check compatibility.

world - The world to check for compatibility.

Returns:

null if the world could be trivially retargeted to the specified platform, or a short description of the reason if it cannot.