Index (plugin 0.35.2 API)

A B C E F I J M N O P R T V W
All Classes and Interfaces|All Packages|Serialized Form

A

all() - Static method in interface io.deephaven.plugin.js.Paths: Includes all paths.

B

build() - Method in interface io.deephaven.plugin.js.JsPlugin.Builder
builder() - Static method in class io.deephaven.plugin.js.JsPlugin

C

clazz() - Method in class io.deephaven.plugin.type.ObjectTypeClassBase
clientConnection(Object, ObjectType.MessageStream) - Method in interface io.deephaven.plugin.type.ObjectType: Signals creation of a client stream to the provided object.
clientConnection(Object, ObjectType.MessageStream) - Method in class io.deephaven.plugin.type.ObjectTypeBase
clientConnectionImpl(T, ObjectType.MessageStream) - Method in class io.deephaven.plugin.type.ObjectTypeClassBase
clientConnectionImpl(T, ObjectType.MessageStream) - Method in class io.deephaven.plugin.type.ObjectTypeClassBase.FetchOnly
compatibleClientConnection(Object, ObjectType.MessageStream) - Method in class io.deephaven.plugin.type.ObjectTypeBase: Signals creation of a client stream to the provided object.
compatibleClientConnection(Object, ObjectType.MessageStream) - Method in class io.deephaven.plugin.type.ObjectTypeBase.FetchOnly
compatibleClientConnection(Object, ObjectType.MessageStream) - Method in class io.deephaven.plugin.type.ObjectTypeClassBase

E

Exporter - Class in io.deephaven.plugin.type: Utility to export objects while writing a payload to send to the client.
Exporter() - Constructor for class io.deephaven.plugin.type.Exporter
Exporter.Reference - Interface in io.deephaven.plugin.type: A reference.

F

FetchOnly() - Constructor for class io.deephaven.plugin.type.ObjectTypeBase.FetchOnly
FetchOnly(String, Class<T>) - Constructor for class io.deephaven.plugin.type.ObjectTypeClassBase.FetchOnly
findObjectType(Object) - Method in interface io.deephaven.plugin.type.ObjectTypeLookup: Find the ObjectType compatible with object.
findObjectType(Object) - Method in enum class io.deephaven.plugin.type.ObjectTypeLookup.NoOp

I

index() - Method in interface io.deephaven.plugin.type.Exporter.Reference: The index, which is defined by the order in which references are created.
INSTANCE - Enum constant in enum class io.deephaven.plugin.type.ObjectTypeLookup.NoOp
io.deephaven.plugin - package io.deephaven.plugin
io.deephaven.plugin.js - package io.deephaven.plugin.js: The Deephaven server supports JS plugins which allow custom javascript (and related content) to be served under the HTTP path "js-plugins/".
io.deephaven.plugin.type - package io.deephaven.plugin.type
isType(Object) - Method in interface io.deephaven.plugin.type.ObjectType: Returns true if, and only if, the object is compatible with this object type.
isType(Object) - Method in class io.deephaven.plugin.type.ObjectTypeClassBase

J

JsPlugin - Class in io.deephaven.plugin.js: A JS plugin is a Plugin that allows for custom javascript and related content to be served, see io.deephaven.plugin.js.
JsPlugin() - Constructor for class io.deephaven.plugin.js.JsPlugin
JsPlugin.Builder - Interface in io.deephaven.plugin.js
JsPluginRegistration - Interface in io.deephaven.plugin.js: Observes registration of JsPlugin instances.

M

main() - Method in class io.deephaven.plugin.js.JsPlugin: The main JS file path, specified relative to JsPlugin.path().
main(Path) - Method in interface io.deephaven.plugin.js.JsPlugin.Builder

N

name() - Method in class io.deephaven.plugin.js.JsPlugin: The JS plugin name.
name() - Method in interface io.deephaven.plugin.type.ObjectType: The name of the object type.
name() - Method in class io.deephaven.plugin.type.ObjectTypeClassBase
name(String) - Method in interface io.deephaven.plugin.js.JsPlugin.Builder
NOOP - Static variable in interface io.deephaven.plugin.type.ObjectType.MessageStream: Simple stream that does no handling on data or close.

O

ObjectCommunicationException - Exception in io.deephaven.plugin.type: Thrown when errors occur when communicating with the client.
ObjectCommunicationException() - Constructor for exception io.deephaven.plugin.type.ObjectCommunicationException
ObjectCommunicationException(String) - Constructor for exception io.deephaven.plugin.type.ObjectCommunicationException
ObjectCommunicationException(String, Throwable) - Constructor for exception io.deephaven.plugin.type.ObjectCommunicationException
ObjectCommunicationException(Throwable) - Constructor for exception io.deephaven.plugin.type.ObjectCommunicationException
ObjectType - Interface in io.deephaven.plugin.type: An "object type" plugin.
ObjectType.MessageStream - Interface in io.deephaven.plugin.type: A stream of messages, either sent from the server to the client, or client to the server.
ObjectTypeBase - Class in io.deephaven.plugin.type: Abstract base class for object type plugins, providing some simple implementation details.
ObjectTypeBase() - Constructor for class io.deephaven.plugin.type.ObjectTypeBase
ObjectTypeBase.FetchOnly - Class in io.deephaven.plugin.type: Abstract base class for object type plugins that can only be fetched (and will not have later responses or accept later requests).
ObjectTypeClassBase<T> - Class in io.deephaven.plugin.type: An implementation that uses strict Class equality for the ObjectTypeClassBase.isType(Object) check.
ObjectTypeClassBase(String, Class<T>) - Constructor for class io.deephaven.plugin.type.ObjectTypeClassBase
ObjectTypeClassBase.FetchOnly<T> - Class in io.deephaven.plugin.type: Abstract base class for object type plugins that can only be fetched (and will not have later responses or accept later requests).
ObjectTypeLookup - Interface in io.deephaven.plugin.type: The object type lookup.
ObjectTypeLookup.NoOp - Enum Class in io.deephaven.plugin.type
ObjectTypeRegistration - Interface in io.deephaven.plugin.type: The ObjectType specific registration.
ofPrefixes(Iterable<? extends Path>) - Static method in interface io.deephaven.plugin.js.Paths: Includes only the paths that are prefixed by one of prefixes.
ofPrefixes(Path) - Static method in interface io.deephaven.plugin.js.Paths: Includes only the paths that are prefixed by prefix.
ofPrefixes(Path...) - Static method in interface io.deephaven.plugin.js.Paths: Includes only the paths that are prefixed by one of prefixes.
onClose() - Method in interface io.deephaven.plugin.type.ObjectType.MessageStream: Closes the stream on both ends.
onData(ByteBuffer, Object...) - Method in interface io.deephaven.plugin.type.ObjectType.MessageStream: Transmits/receives data to/from the remote end of the stream.
outputStream() - Method in class io.deephaven.plugin.type.Exporter

P

path() - Method in class io.deephaven.plugin.js.JsPlugin: The directory path of the resources to serve.
path(Path) - Method in interface io.deephaven.plugin.js.JsPlugin.Builder
paths() - Method in class io.deephaven.plugin.js.JsPlugin: The subset of resources from JsPlugin.path() to serve.
paths(Paths) - Method in interface io.deephaven.plugin.js.JsPlugin.Builder
Paths - Interface in io.deephaven.plugin.js: The subset of paths to serve, see JsPlugin.paths().
payload() - Method in class io.deephaven.plugin.type.Exporter
Plugin - Interface in io.deephaven.plugin: A plugin is a structured extension point for user-definable behavior.
Plugin.Visitor<T> - Interface in io.deephaven.plugin
PluginBase - Class in io.deephaven.plugin
PluginBase() - Constructor for class io.deephaven.plugin.PluginBase

R

reference(Object) - Method in class io.deephaven.plugin.type.Exporter: Creates a new reference for the provided object.
reference(Object, boolean, boolean) - Method in class io.deephaven.plugin.type.Exporter: Deprecated.
Please use Exporter.reference(Object) instead - as of 0.27.0, the parameters allowUnknownType and forceNew can only be set to true going forward.
reference(Object, boolean, boolean, BiPredicate<Object, Object>) - Method in class io.deephaven.plugin.type.Exporter: Deprecated.
Please use Exporter.reference(Object) instead - as of 0.27.0, the parameters allowUnknownType and forceNew can only be set to true going forward.
references() - Method in class io.deephaven.plugin.type.Exporter
register(JsPlugin) - Method in interface io.deephaven.plugin.js.JsPluginRegistration: Handles registration of a JsPlugin instance.
register(Plugin) - Method in interface io.deephaven.plugin.Registration.Callback: Registers plugin.
register(ObjectType) - Method in interface io.deephaven.plugin.type.ObjectTypeRegistration: Register objectType.
registerInto(Registration.Callback) - Method in interface io.deephaven.plugin.Plugin: Registers this plugin into the callback.
registerInto(Registration.Callback) - Method in class io.deephaven.plugin.PluginBase
registerInto(Registration.Callback) - Method in interface io.deephaven.plugin.Registration: The registration entrypoint.
Registration - Interface in io.deephaven.plugin: The registration interface for plugins.
Registration.Callback - Interface in io.deephaven.plugin

T

toString() - Method in class io.deephaven.plugin.type.ObjectTypeClassBase
type() - Method in interface io.deephaven.plugin.type.Exporter.Reference: Deprecated.
As of 0.27.0, this will always return empty.

V

valueOf(String) - Static method in enum class io.deephaven.plugin.type.ObjectTypeLookup.NoOp: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.deephaven.plugin.type.ObjectTypeLookup.NoOp: Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in class io.deephaven.plugin.js.JsPlugin: The JS plugin version.
version(String) - Method in interface io.deephaven.plugin.js.JsPlugin.Builder
visit(JsPlugin) - Method in interface io.deephaven.plugin.Plugin.Visitor
visit(ObjectType) - Method in interface io.deephaven.plugin.Plugin.Visitor

W

walk(V) - Method in class io.deephaven.plugin.js.JsPlugin
walk(V) - Method in interface io.deephaven.plugin.Plugin
walk(V) - Method in class io.deephaven.plugin.type.ObjectTypeBase
writeCompatibleObjectTo(Exporter, Object, OutputStream) - Method in class io.deephaven.plugin.type.ObjectTypeBase.FetchOnly: Serializes object as bytes to out.
writeToImpl(Exporter, T, OutputStream) - Method in class io.deephaven.plugin.type.ObjectTypeClassBase.FetchOnly: Serializes object as bytes to out.

A B C E F I J M N O P R T V W
All Classes and Interfaces|All Packages|Serialized Form