Module org.spongepowered.plugin.spi

Package org.spongepowered.plugin.builtin

Class StandardPluginLanguageService

java.lang.Object

org.spongepowered.plugin.builtin.StandardPluginLanguageService

All Implemented Interfaces:

PluginLanguageService

public abstract class StandardPluginLanguageService
extends Object
implements PluginLanguageService

Field Summary

Fields

Modifier and Type	Field	Description
protected final Logger	logger

Constructor Summary

Constructors

Constructor	Description
StandardPluginLanguageService()

Method Summary

Modifier and Type	Method	Description
List<PluginCandidate>	createPluginCandidates(Environment environment, PluginResource resource)	Asks the service if the provided resource can become candidates.
void	initialize(Environment environment)	Callback so that implementors can perform any necessary initialization of the service.
protected boolean	isValidContainer(Environment environment, Container container)
protected boolean	isValidMetadata(Environment environment, PluginMetadata metadata)
protected Container	loadMetadataContainer(Environment environment, InputStream stream)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.plugin.PluginLanguageService

name, pluginLoader

Field Details

logger

protected final Logger logger

Constructor Details

StandardPluginLanguageService

public StandardPluginLanguageService()

Method Details

initialize

public void initialize(Environment environment)

Description copied from interface: PluginLanguageService

Callback so that implementors can perform any necessary initialization of the service.

Specified by:

initialize in interface PluginLanguageService

Parameters:

environment - The environment the service is running under

createPluginCandidates

public List<PluginCandidate> createPluginCandidates(Environment environment,
 PluginResource resource)
                                             throws Exception

Description copied from interface: PluginLanguageService

Asks the service if the provided resource can become candidates.

It is left up to implementors on when to throw exceptions (typically from parsing the resource) or to simply return lists that are empty. Therefore it should be known that an empty list returned is not an error and should be discarded by callers of this method.

Specified by:

createPluginCandidates in interface PluginLanguageService

Parameters:

environment - The environment

resource - The resource

Returns:

The candidates

Throws:

Exception

loadMetadataContainer

protected Container loadMetadataContainer(Environment environment,
 InputStream stream)
                                   throws Exception

Throws:

Exception

isValidContainer

protected boolean isValidContainer(Environment environment,
 Container container)

isValidMetadata

protected boolean isValidMetadata(Environment environment,
 PluginMetadata metadata)