org.pepsoft.worldpainter

Class DefaultCustomObjectProvider

java.lang.Object

org.pepsoft.worldpainter.plugins.AbstractPlugin

org.pepsoft.worldpainter.DefaultCustomObjectProvider

All Implemented Interfaces:

CustomObjectProvider, Plugin, Provider<java.lang.String>

public class DefaultCustomObjectProvider
extends AbstractPlugin
implements CustomObjectProvider

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

Constructor Summary

Constructors

Constructor and Description
DefaultCustomObjectProvider()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getKeys() Get the keys supported by this provider.
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 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.Plugin

getMinimumWorldPainterVersion, getName, getProperties, getUUIDs, getVersion, init

Constructor Detail

DefaultCustomObjectProvider

public DefaultCustomObjectProvider()

Method Detail

getKeys

public java.util.List<java.lang.String> getKeys()

Description copied from interface: Provider

Get the keys supported by this provider.

Specified by:

getKeys in interface Provider<java.lang.String>

Returns:

The keys supported by this provider.

getSupportedExtensions

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

Description copied from interface: CustomObjectProvider

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

Specified by:

getSupportedExtensions in interface CustomObjectProvider

Returns:

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

loadObject

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

Description copied from interface: CustomObjectProvider

Load a custom object from a specific file.

Specified by:

loadObject in interface CustomObjectProvider

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.