Interface PluginContext

public interface PluginContext

Method Summary

Modifier and Type	Method	Description
Path	dataFolder()
EventBus	events()
ComponentLogger	logger()
PluginMeta	meta()
@Nullable InputStream	resource(String path)	Opens a resource bundled inside this plugin's jar, relative to the jar root.
Server	server()
ServiceRegistry	services()

Method Details

meta

PluginMeta meta()

server

Server server()

events

EventBus events()

services

ServiceRegistry services()

logger

ComponentLogger logger()

dataFolder

Path dataFolder()

resource

@Nullable InputStream resource(String path)

Opens a resource bundled inside this plugin's jar, relative to the jar root.

Parameters:

path - path to the resource, relative to the jar root

Returns:

an input stream for the resource, or null if no entry exists at that path

Since:

0.1.0

API Note:

The caller owns the returned stream and is responsible for closing it, typically via try-with-resources