org.pepsoft.worldpainter.plugins

Interface PlatformProvider

All Superinterfaces:

Plugin, Provider<Platform>

All Known Subinterfaces:

BlockBasedPlatformProvider, MapExplorerSupport

All Known Implementing Classes:

AbstractPlatformProvider, JavaPlatformProvider

public interface PlatformProvider
extends Provider<Platform>

A support provider for a WorldPainter Platform. Created by Pepijn on 12-2-2017.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PlatformProvider.MapInfo

Field Summary

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

PROPERTY_MINIMUM_WORLDPAINTER_VERSION, PROPERTY_NAME, PROPERTY_UUIDS, PROPERTY_VERSION

Method Summary

Modifier and Type	Method and Description
java.io.File	getDefaultExportDir(Platform platform) Get the default directory to select on the Export screen for a platform supported by this provider.
default ExportSettings	getDefaultExportSettings(Platform platform) Get the default ExportSettings for a supported platform, or null if the platform has no export settings.
WorldExporter	getExporter(World2 world, WorldExportSettings exportSettings) Obtain a WorldExporter for the platform currently configured in the specified world.
default ExportSettingsEditor	getExportSettingsEditor(Platform platform) Get an instance of an ExportSettingsEditor suitable for editing an ExportSettings object as returned by getDefaultExportSettings(Platform).
default MapRecognizer	getMapRecognizer() Deprecated. Will never be called. Do not implement. The default implementation throws an UnsupportedOperationException.
default 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.
default 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.
default 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 interface org.pepsoft.worldpainter.plugins.Provider

getKeys

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

getMinimumWorldPainterVersion, getName, getProperties, getUUIDs, getVersion, init

Method Detail

getExporter

WorldExporter getExporter(World2 world,
                          WorldExportSettings exportSettings)

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

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

java.io.File getDefaultExportDir(Platform platform)

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

Parameters:

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

Returns:

The default export directory for the specified platform.

selectBackupDir

default java.io.File selectBackupDir(java.io.File exportDir)
                              throws java.io.IOException

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.

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.

Throws:

java.io.IOException - If an I/O error occurs while determining the backup directory.

getMapRecognizer

@Deprecated
default MapRecognizer getMapRecognizer()

Deprecated. Will never be called. Do not implement. The default implementation throws an UnsupportedOperationException.

identifyMap

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

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.

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.

getDefaultExportSettings

default ExportSettings getDefaultExportSettings(Platform platform)

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

The default implementation returns null.

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

default ExportSettingsEditor getExportSettingsEditor(Platform platform)

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

The default implementation throws an UnsupportedOperationException.

Parameters:

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

Returns:

An instance of an ExportSettingsEditor.

isCompatible

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

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

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.