Package io.deephaven.plugin.type

Class ObjectTypeClassBase<T>

java.lang.Object

io.deephaven.plugin.PluginBase

io.deephaven.plugin.type.ObjectTypeBase

io.deephaven.plugin.type.ObjectTypeClassBase<T>

Type Parameters:

T - the class type

All Implemented Interfaces:

Plugin, Registration, ObjectType

Direct Known Subclasses:

ObjectTypeClassBase.FetchOnly

public abstract class ObjectTypeClassBase<T>
extends ObjectTypeBase

An implementation that uses strict Class equality for the isType(Object) check.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectTypeClassBase.FetchOnly<T>	Abstract base class for object type plugins that can only be fetched (and will not have later responses or accept later requests).

Nested classes/interfaces inherited from interface io.deephaven.plugin.type.ObjectType

ObjectType.MessageStream

Nested classes/interfaces inherited from interface io.deephaven.plugin.Plugin

Plugin.Visitor<T>

Nested classes/interfaces inherited from interface io.deephaven.plugin.Registration

Registration.Callback

Constructor Summary

Constructors

Constructor	Description
ObjectTypeClassBase(String name, Class<T> clazz)

Method Summary

Modifier and Type	Method	Description
final Class<T>	clazz()
abstract ObjectType.MessageStream	clientConnectionImpl(T object, ObjectType.MessageStream connection)
final ObjectType.MessageStream	compatibleClientConnection(Object object, ObjectType.MessageStream connection)	Signals creation of a client stream to the provided object.
final boolean	isType(Object object)	Returns true if, and only if, the object is compatible with this object type.
final String	name()	The name of the object type.
String	toString()

Methods inherited from class io.deephaven.plugin.type.ObjectTypeBase

clientConnection, walk

Methods inherited from class io.deephaven.plugin.PluginBase

registerInto

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.plugin.Plugin

registerInto

Constructor Details

ObjectTypeClassBase

public ObjectTypeClassBase(String name,
 Class<T> clazz)

Method Details

clazz

public final Class<T> clazz()

name

public final String name()

Description copied from interface: ObjectType

The name of the object type.

Returns:

the name

isType

public final boolean isType(Object object)

Description copied from interface: ObjectType

Returns true if, and only if, the object is compatible with this object type.

Parameters:

object - the object

Returns:

true if the object is compatible

compatibleClientConnection

public final ObjectType.MessageStream compatibleClientConnection(Object object,
 ObjectType.MessageStream connection)
                                                          throws ObjectCommunicationException

Description copied from class: ObjectTypeBase

Signals creation of a client stream to the provided object. The returned MessageStream implementation will be called with each received message from the client, and can call the provided connection instance to send messages as needed to the client.

Specified by:

compatibleClientConnection in class ObjectTypeBase

Parameters:

object - the object to create a connection for

connection - a stream to send objects to the client

Returns:

a stream to receive objects from the client

Throws:

ObjectCommunicationException - may throw an exception received from ObjectType.MessageStream.onData(ByteBuffer, Object...) calls

clientConnectionImpl

public abstract ObjectType.MessageStream clientConnectionImpl(T object,
 ObjectType.MessageStream connection)
                                                       throws ObjectCommunicationException

Throws:

ObjectCommunicationException

toString

public String toString()

Overrides:

toString in class Object