org.pepsoft.worldpainter.plugins

Interface CustomObjectProvider

All Superinterfaces:

Plugin, Provider<java.lang.String>

All Known Implementing Classes:

DefaultCustomObjectProvider

public interface CustomObjectProvider
extends Provider<java.lang.String>

A plugin which can import and export custom objects of some specific type(s).

Created by Pepijn on 9-3-2017.

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.util.List<java.lang.String>	getSupportedExtensions() Get the list of filename extensions of the custom object formats supported by this plugin.
WPObject	loadObject(java.io.File file) Load a custom object from a specific file.

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

getSupportedExtensions

java.util.List<java.lang.String> getSupportedExtensions()

Get the list of filename extensions of the custom object formats supported by this plugin.

Returns:

The list of filename extensions of the custom object formats supported by this plugin.

loadObject

WPObject loadObject(java.io.File file)
             throws java.io.IOException

Load a custom object from a specific file.

Parameters:

file - The file from which to load the custom object.

Returns:

The custom object contained in the specified file.

Throws:

java.io.IOException - If an I/O error occurs while reading the file.