Package io.deephaven.plugin.type
Class Exporter
java.lang.Object
io.deephaven.plugin.type.Exporter
Utility to export objects while writing a payload to send to the client.
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionpayload()
Creates a new reference for the provided object.Deprecated.reference
(Object object, boolean allowUnknownType, boolean forceNew, BiPredicate<Object, Object> equals) Deprecated.Please usereference(Object)
instead - as of 0.27.0, the parameters allowUnknownType and forceNew can only be set to true going forward.Object[]
-
Constructor Details
-
Exporter
public Exporter()
-
-
Method Details
-
reference
@Deprecated(since="0.27.0") public Optional<Exporter.Reference> reference(Object object, boolean allowUnknownType, boolean forceNew) Deprecated.Please usereference(Object)
instead - as of 0.27.0, the parameters allowUnknownType and forceNew can only be set to true going forward.Gets the reference forobject
if it has already been created andforceNew
isfalse
, otherwise creates a new one. IfallowUnknownType
isfalse
, and no type can be found, no reference will be created. Uses reference-based equality.- Parameters:
object
- the objectallowUnknownType
- if an unknown-typed reference can be createdforceNew
- if a new reference should be created- Returns:
- the reference
-
reference
@Deprecated(since="0.27.0") public Optional<Exporter.Reference> reference(Object object, boolean allowUnknownType, boolean forceNew, BiPredicate<Object, Object> equals) Deprecated.Please usereference(Object)
instead - as of 0.27.0, the parameters allowUnknownType and forceNew can only be set to true going forward.Gets the reference forobject
if it has already been created andforceNew
isfalse
, otherwise creates a new one. IfallowUnknownType
isfalse
, and no type can be found, no reference will be created.- Parameters:
object
- the objectallowUnknownType
- if an unknown-typed reference can be createdforceNew
- if a new reference should be createdequals
- the equals logic - unused.- Returns:
- the reference
-
outputStream
-
payload
-
references
-
reference
Creates a new reference for the provided object. A reference will be created and the object exported even if the object has no corresponding plugin provided, granting the client the ability to reference the object on later calls, and requiring that they release it when no longer needed.- Parameters:
object
- the object- Returns:
- the reference
-
reference(Object)
instead - as of 0.27.0, the parameters allowUnknownType and forceNew can only be set to true going forward.