Package io.deephaven.plugin.type

Class ObjectTypeClassBase.FetchOnly<T>

java.lang.Object

io.deephaven.plugin.PluginBase

io.deephaven.plugin.type.ObjectTypeBase

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

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

Type Parameters:

T - the class type

All Implemented Interfaces:

Plugin, Registration, ObjectType

Enclosing class:

ObjectTypeClassBase<T>

public abstract static class ObjectTypeClassBase.FetchOnly<T>
extends ObjectTypeClassBase<T>

Abstract base class for object type plugins that can only be fetched (and will not have later responses or accept later requests). For bidirectional messages, see ObjectTypeClassBase.

Nested Class Summary

Nested classes/interfaces inherited from class io.deephaven.plugin.type.ObjectTypeClassBase

ObjectTypeClassBase.FetchOnly<T>

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
FetchOnly(String name, Class<T> clazz)

Method Summary

Modifier and Type	Method	Description
final ObjectType.MessageStream	clientConnectionImpl(T object, ObjectType.MessageStream connection)
abstract void	writeToImpl(Exporter exporter, T object, OutputStream out)	Serializes object as bytes to out.

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

clazz, compatibleClientConnection, isType, name, 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

FetchOnly

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

Method Details

clientConnectionImpl

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

Specified by:

clientConnectionImpl in class ObjectTypeClassBase<T>

Throws:

ObjectCommunicationException

writeToImpl

public abstract void writeToImpl(Exporter exporter,
 T object,
 OutputStream out)
                          throws IOException

Serializes object as bytes to out. Must only be called with a compatible object. Server-side objects that should be sent as references to the client (but not themselves serialized in this payload) can be exported using the exporter - each returned Exporter.Reference will have an index, denoting its position on the array of exported objects to be received by the client.

Parameters:

exporter - the exporter

object - the compatible object

out - the output stream

Throws:

IOException - if output stream operations failed, the export will then fail, and the client will get a generic error