org.apache.tinkerpop.gremlin.driver.remote

Class DriverRemoteTraversalSideEffects

java.lang.Object

org.apache.tinkerpop.gremlin.process.remote.traversal.AbstractRemoteTraversalSideEffects

org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTraversalSideEffects

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, RemoteTraversalSideEffects, TraversalSideEffects

public class DriverRemoteTraversalSideEffects
extends AbstractRemoteTraversalSideEffects

Java driver implementation of TraversalSideEffects. This class is not thread safe.

Author:

Stephen Mallette (http://stephen.genoprime.com)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.TraversalSideEffects

TraversalSideEffects.Exceptions

Constructor Summary

Constructors

Constructor and Description
DriverRemoteTraversalSideEffects(Client client, ResultSet rs)
DriverRemoteTraversalSideEffects(Client client, UUID serverSideEffect, Host host, CompletableFuture<Void> ready) Deprecated. As of release 3.4.0, replaced by DriverRemoteTraversalSideEffects(Client, ResultSet)

Method Summary

Modifier and Type	Method and Description
void	close() If the "remote" that actually executed the traversal maintained resources that can be released, when the user is done with the side-effects, then this method can be used to trigger that release.
<V> V	get(String key) Get the sideEffect associated with the provided key.
Set<String>	keys() The keys of the sideEffect which includes registered Supplier keys.
Map<String,Object>	statusAttributes() Gets the status attributes from the response from the server.
String	toString()

Methods inherited from class org.apache.tinkerpop.gremlin.process.remote.traversal.AbstractRemoteTraversalSideEffects

add, clone, getReducer, getSackInitialValue, getSackMerger, getSackSplitter, getSupplier, mergeInto, register, registerIfAbsent, remove, set, setSack

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.TraversalSideEffects

exists, forEach, isEmpty

Constructor Detail

DriverRemoteTraversalSideEffects

@Deprecated
public DriverRemoteTraversalSideEffects(Client client,
                                                    UUID serverSideEffect,
                                                    Host host,
                                                    CompletableFuture<Void> ready)

Deprecated. As of release 3.4.0, replaced by DriverRemoteTraversalSideEffects(Client, ResultSet)

DriverRemoteTraversalSideEffects

public DriverRemoteTraversalSideEffects(Client client,
                                        ResultSet rs)

Method Detail

statusAttributes

public Map<String,Object> statusAttributes()

Gets the status attributes from the response from the server. This method will block until all results have been retrieved.

get

public <V> V get(String key)
          throws IllegalArgumentException

Description copied from interface: TraversalSideEffects

Get the sideEffect associated with the provided key. If the sideEffect contains an object for the key, return it. Else if the sideEffect has a registered Supplier for that key, generate the object, store the object in the sideEffects, and return it.

Type Parameters:

V - the type of the value to retrieve

Parameters:

key - the key to get the value for

Returns:

the value associated with key

Throws:

IllegalArgumentException - if the key does not reference an object or a registered supplier.

keys

public Set<String> keys()

Description copied from interface: TraversalSideEffects

The keys of the sideEffect which includes registered Supplier keys. In essence, that which is possible to get().

Returns:

the keys of the sideEffect

close

public void close()
           throws Exception

Description copied from interface: RemoteTraversalSideEffects

If the "remote" that actually executed the traversal maintained resources that can be released, when the user is done with the side-effects, then this method can be used to trigger that release.

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object