Index (plugin-spi 0.4.0 API)

B C D E F G H I J K L M N O P R S T V
All Classes and Interfaces|All Packages|Serialized Form

B

BASE_DIRECTORY - Static variable in class org.spongepowered.plugin.blackboard.Keys
blackboard() - Method in class org.spongepowered.plugin.builtin.StandardEnvironment
blackboard() - Method in interface org.spongepowered.plugin.Environment
Blackboard - Interface in org.spongepowered.plugin.blackboard: An entity that stores various properties for an environment

C

ClasspathPluginResourceLocatorService - Class in org.spongepowered.plugin.builtin.jvm.locator
ClasspathPluginResourceLocatorService() - Constructor for class org.spongepowered.plugin.builtin.jvm.locator.ClasspathPluginResourceLocatorService
clazz() - Method in class org.spongepowered.plugin.blackboard.Key
compareTo(Key<V>) - Method in class org.spongepowered.plugin.blackboard.Key
create(String, Path[]) - Method in interface org.spongepowered.plugin.builtin.jvm.JVMPluginResource.Factory
create(Environment, String, Path...) - Static method in interface org.spongepowered.plugin.builtin.jvm.JVMPluginResource: Creates a JVMPluginResource from an array of paths.
createPluginCandidates(Environment, PluginResource) - Method in class org.spongepowered.plugin.builtin.StandardPluginLanguageService
createPluginCandidates(Environment, PluginResource) - Method in interface org.spongepowered.plugin.PluginLanguageService: Asks the service if the provided resource can become candidates.

D

DEVELOPMENT - Static variable in class org.spongepowered.plugin.blackboard.Keys: Indicates whether the target environment is a development environment.
DirectoryPluginResourceLocatorService - Class in org.spongepowered.plugin.builtin.jvm.locator
DirectoryPluginResourceLocatorService() - Constructor for class org.spongepowered.plugin.builtin.jvm.locator.DirectoryPluginResourceLocatorService

E

Environment - Interface in org.spongepowered.plugin: Represents the context under which this specification is running under.
ENVIRONMENT_LOCATOR_VARIABLE_NAME - Static variable in class org.spongepowered.plugin.builtin.jvm.JVMKeys
EnvironmentPluginResourceLocatorService - Class in org.spongepowered.plugin.builtin.jvm.locator
EnvironmentPluginResourceLocatorService() - Constructor for class org.spongepowered.plugin.builtin.jvm.locator.EnvironmentPluginResourceLocatorService
equals(Object) - Method in class org.spongepowered.plugin.blackboard.Key
equals(Object) - Method in record class org.spongepowered.plugin.builtin.StandardPluginCandidate: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.spongepowered.plugin.builtin.StandardPluginContainer

F

find(Key<V>) - Method in interface org.spongepowered.plugin.blackboard.Blackboard
find(Key<V>) - Method in class org.spongepowered.plugin.builtin.StandardBlackboard

G

get(Key<V>) - Method in interface org.spongepowered.plugin.blackboard.Blackboard
get(Key<V>) - Method in class org.spongepowered.plugin.builtin.StandardBlackboard

H

hashCode() - Method in class org.spongepowered.plugin.blackboard.Key
hashCode() - Method in record class org.spongepowered.plugin.builtin.StandardPluginCandidate: Returns a hash code value for this object.
hashCode() - Method in class org.spongepowered.plugin.builtin.StandardPluginContainer

I

initialize(Environment) - Method in class org.spongepowered.plugin.builtin.StandardPluginLanguageService
initialize(Environment) - Method in interface org.spongepowered.plugin.PluginLanguageService: Callback so that implementors can perform any necessary initialization of the service.
initializeInstance(Object) - Method in class org.spongepowered.plugin.builtin.StandardPluginContainer
instance() - Method in class org.spongepowered.plugin.builtin.StandardPluginContainer
instance() - Method in interface org.spongepowered.plugin.PluginContainer
InvalidPluginException - Exception Class in org.spongepowered.plugin: Thrown when a plugin cannot be constructed and should be considered invalid.
InvalidPluginException(String) - Constructor for exception class org.spongepowered.plugin.InvalidPluginException
InvalidPluginException(String, Throwable) - Constructor for exception class org.spongepowered.plugin.InvalidPluginException
InvalidPluginException(Throwable) - Constructor for exception class org.spongepowered.plugin.InvalidPluginException
isValidContainer(Environment, Container) - Method in class org.spongepowered.plugin.builtin.StandardPluginLanguageService
isValidMetadata(Environment, PluginMetadata) - Method in class org.spongepowered.plugin.builtin.StandardPluginLanguageService

J

JVM_PLUGIN_RESOURCE_FACTORY - Static variable in class org.spongepowered.plugin.builtin.jvm.JVMKeys
JVMKeys - Class in org.spongepowered.plugin.builtin.jvm
JVMPluginResource - Interface in org.spongepowered.plugin.builtin.jvm
JVMPluginResource.Factory - Interface in org.spongepowered.plugin.builtin.jvm
JVMPluginResourceLocatorService - Interface in org.spongepowered.plugin.builtin.jvm.locator

K

Key<V> - Class in org.spongepowered.plugin.blackboard
Keys - Class in org.spongepowered.plugin.blackboard

L

loadMetadataContainer(Environment, InputStream) - Method in class org.spongepowered.plugin.builtin.StandardPluginLanguageService
loadPlugin(Environment, PluginCandidate, ClassLoader) - Method in interface org.spongepowered.plugin.PluginLoader: Instructs the loader to load the candidate as a container into the target classloader.
locatePluginResources(Environment) - Method in class org.spongepowered.plugin.builtin.jvm.locator.ClasspathPluginResourceLocatorService
locatePluginResources(Environment) - Method in class org.spongepowered.plugin.builtin.jvm.locator.DirectoryPluginResourceLocatorService
locatePluginResources(Environment) - Method in class org.spongepowered.plugin.builtin.jvm.locator.EnvironmentPluginResourceLocatorService
locatePluginResources(Environment) - Method in interface org.spongepowered.plugin.PluginResourceLocatorService
locateResource(String) - Method in interface org.spongepowered.plugin.builtin.jvm.JVMPluginResource
locateResource(String) - Method in class org.spongepowered.plugin.builtin.StandardPluginContainer
locateResource(String) - Method in interface org.spongepowered.plugin.ResourceQueryable: Resolves the location of a bundled resource, given a relative path.
locator() - Method in interface org.spongepowered.plugin.PluginResource
logger - Variable in class org.spongepowered.plugin.builtin.StandardPluginLanguageService
logger() - Method in class org.spongepowered.plugin.builtin.StandardEnvironment
logger() - Method in class org.spongepowered.plugin.builtin.StandardPluginContainer
logger() - Method in interface org.spongepowered.plugin.Environment
logger() - Method in interface org.spongepowered.plugin.PluginContainer

M

manifest() - Method in interface org.spongepowered.plugin.builtin.jvm.JVMPluginResource
metadata() - Method in record class org.spongepowered.plugin.builtin.StandardPluginCandidate: Returns the value of the metadata record component.
metadata() - Method in class org.spongepowered.plugin.builtin.StandardPluginContainer
metadata() - Method in interface org.spongepowered.plugin.PluginCandidate
metadata() - Method in interface org.spongepowered.plugin.PluginContainer
METADATA_FILE_PATH - Static variable in class org.spongepowered.plugin.blackboard.Keys

N

name() - Method in class org.spongepowered.plugin.blackboard.Key
name() - Method in class org.spongepowered.plugin.builtin.jvm.locator.ClasspathPluginResourceLocatorService
name() - Method in class org.spongepowered.plugin.builtin.jvm.locator.DirectoryPluginResourceLocatorService
name() - Method in class org.spongepowered.plugin.builtin.jvm.locator.EnvironmentPluginResourceLocatorService
name() - Method in interface org.spongepowered.plugin.PluginLanguageService
name() - Method in interface org.spongepowered.plugin.PluginResourceLocatorService

O

of(String, Class<? super V>) - Static method in class org.spongepowered.plugin.blackboard.Key
openResource(String) - Method in interface org.spongepowered.plugin.ResourceQueryable: Opens an InputStream of the location of a bundled resource, given a relative path.
org.spongepowered.plugin - package org.spongepowered.plugin
org.spongepowered.plugin.blackboard - package org.spongepowered.plugin.blackboard
org.spongepowered.plugin.builtin - package org.spongepowered.plugin.builtin
org.spongepowered.plugin.builtin.jvm - package org.spongepowered.plugin.builtin.jvm
org.spongepowered.plugin.builtin.jvm.locator - package org.spongepowered.plugin.builtin.jvm.locator
org.spongepowered.plugin.spi - module org.spongepowered.plugin.spi

P

path() - Method in interface org.spongepowered.plugin.PluginResource
Plugin - Annotation Interface in org.spongepowered.plugin.builtin.jvm: An annotation used to mark a plugin.
PLUGIN_DIRECTORIES - Static variable in class org.spongepowered.plugin.blackboard.Keys
PluginCandidate - Interface in org.spongepowered.plugin: Represents the combination of a metadata and resource that will be a candidate for a container.
PluginContainer - Interface in org.spongepowered.plugin: Represents the combination of a metadata with its instance.
PluginLanguageService - Interface in org.spongepowered.plugin: A service that processes resources and triggers loading of containers via a specified loader.
pluginLoader() - Method in interface org.spongepowered.plugin.PluginLanguageService
PluginLoader<P> - Interface in org.spongepowered.plugin: A loader used to create and load plugins.
PluginResource - Interface in org.spongepowered.plugin: Represents a resource provided by a locator.
PluginResourceLocatorService<P> - Interface in org.spongepowered.plugin: A service used to find resources to be processed by language services or other implementation constructs.
property(String) - Method in interface org.spongepowered.plugin.builtin.jvm.JVMPluginResource
property(String) - Method in interface org.spongepowered.plugin.PluginResource: Retrieve a property of this resource by key.

R

resource() - Method in record class org.spongepowered.plugin.builtin.StandardPluginCandidate: Returns the value of the resource record component.
resource() - Method in interface org.spongepowered.plugin.PluginCandidate
ResourceQueryable - Interface in org.spongepowered.plugin: Represents an entity that can be queried for resources.
resourcesRoot() - Method in interface org.spongepowered.plugin.builtin.jvm.JVMPluginResource: Retrieves the root path containing all the resources.

S

set(Key<V>, V) - Method in interface org.spongepowered.plugin.blackboard.Blackboard: Sets a value by key.
set(Key<V>, V) - Method in class org.spongepowered.plugin.builtin.StandardBlackboard
StandardBlackboard - Class in org.spongepowered.plugin.builtin
StandardBlackboard() - Constructor for class org.spongepowered.plugin.builtin.StandardBlackboard
StandardEnvironment - Class in org.spongepowered.plugin.builtin
StandardEnvironment() - Constructor for class org.spongepowered.plugin.builtin.StandardEnvironment
StandardEnvironment(Logger) - Constructor for class org.spongepowered.plugin.builtin.StandardEnvironment
StandardPluginCandidate - Record Class in org.spongepowered.plugin.builtin
StandardPluginCandidate(PluginMetadata, PluginResource) - Constructor for record class org.spongepowered.plugin.builtin.StandardPluginCandidate: Creates an instance of a StandardPluginCandidate record class.
StandardPluginContainer - Class in org.spongepowered.plugin.builtin
StandardPluginContainer(PluginCandidate) - Constructor for class org.spongepowered.plugin.builtin.StandardPluginContainer
StandardPluginContainer(PluginCandidate, Logger) - Constructor for class org.spongepowered.plugin.builtin.StandardPluginContainer
StandardPluginLanguageService - Class in org.spongepowered.plugin.builtin
StandardPluginLanguageService() - Constructor for class org.spongepowered.plugin.builtin.StandardPluginLanguageService

T

toString() - Method in record class org.spongepowered.plugin.builtin.StandardPluginCandidate: Returns a string representation of this record class.
toString() - Method in class org.spongepowered.plugin.builtin.StandardPluginContainer
toStringJoiner() - Method in class org.spongepowered.plugin.builtin.StandardPluginContainer

V

value() - Element in annotation interface org.spongepowered.plugin.builtin.jvm.Plugin: An ID that uniquely identifies this plugin.
version() - Method in interface org.spongepowered.plugin.PluginLoader
VERSION - Static variable in class org.spongepowered.plugin.blackboard.Keys

B C D E F G H I J K L M N O P R S T V
All Classes and Interfaces|All Packages|Serialized Form