org.apache.tinkerpop.gremlin.process.traversal

## Class AnonymousTraversalSource<T extends TraversalSource>

- java.lang.Object
- - org.apache.tinkerpop.gremlin.process.traversal.AnonymousTraversalSource<T>

-     public class AnonymousTraversalSource<T extends TraversalSource>
      extends Object

  Provides a unified way to construct a `TraversalSource` from the perspective of the traversal. In this syntax the user is creating the source and binding it to a reference which is either an existing `Graph` instance or a `RemoteConnection`.
  Author:
    Stephen Mallette (http://stephen.genoprime.com)

- - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `static AnonymousTraversalSource<GraphTraversalSource>` | `traversal()` Constructs an `AnonymousTraversalSource` which will then be configured to spawn a `GraphTraversalSource`.
    `static <T extends TraversalSource> AnonymousTraversalSource<T>` | `traversal(Class<T> traversalSourceClass)` Constructs an `AnonymousTraversalSource` which will then be configured to spawn the specified `TraversalSource`.
    `T` | `withEmbedded(Graph graph)` Creates the specified `TraversalSource` binding an embedded `Graph` as its reference such that traversals spawned from it will execute over that reference.
    `T` | `withGraph(Graph graph)` Deprecated. As of release 3.4.9, replaced by `withEmbedded(Graph)`
    `T` | `withRemote(org.apache.commons.configuration2.Configuration conf)` Creates a `TraversalSource` binding a `RemoteConnection` to a remote `Graph` instances as its reference so that traversals spawned from it will execute over that reference.
    `T` | `withRemote(RemoteConnection remoteConnection)` Creates a `TraversalSource` binding a `RemoteConnection` to a remote `Graph` instances as its reference so that traversals spawned from it will execute over that reference.
    `T` | `withRemote(String configFile)` Creates a `TraversalSource` binding a `RemoteConnection` to a remote `Graph` instances as its reference so that traversals spawned from it will execute over that reference.

    - ### Methods inherited from class java.lang.Object

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

- - ### Method Detail

    - #### traversal

          public static AnonymousTraversalSource<GraphTraversalSource> traversal()

      Constructs an `AnonymousTraversalSource` which will then be configured to spawn a `GraphTraversalSource`.

    - #### traversal

          public static <T extends TraversalSource> AnonymousTraversalSource<T> traversal(Class<T> traversalSourceClass)

      Constructs an `AnonymousTraversalSource` which will then be configured to spawn the specified `TraversalSource`.

    - #### withRemote

          public T withRemote(String configFile)
                       throws Exception

      Creates a `TraversalSource` binding a `RemoteConnection` to a remote `Graph` instances as its reference so that traversals spawned from it will execute over that reference.
      Parameters:
        `configFile` - a path to a file that would normally be provided to configure a `RemoteConnection`
      Throws:
        `Exception`

    - #### withRemote

          public T withRemote(org.apache.commons.configuration2.Configuration conf)

      Creates a `TraversalSource` binding a `RemoteConnection` to a remote `Graph` instances as its reference so that traversals spawned from it will execute over that reference.
      Parameters:
        `conf` - a `Configuration` object that would normally be provided to configure a `RemoteConnection`

    - #### withRemote

          public T withRemote(RemoteConnection remoteConnection)

      Creates a `TraversalSource` binding a `RemoteConnection` to a remote `Graph` instances as its reference so that traversals spawned from it will execute over that reference.

    - #### withGraph

          @Deprecated
          public T withGraph(Graph graph)

      Deprecated. As of release 3.4.9, replaced by `withEmbedded(Graph)`
      Creates the specified `TraversalSource` binding an embedded `Graph` as its reference such that traversals spawned from it will execute over that reference.

    - #### withEmbedded

          public T withEmbedded(Graph graph)

      Creates the specified `TraversalSource` binding an embedded `Graph` as its reference such that traversals spawned from it will execute over that reference.

Copyright © 2013–2022 Apache Software Foundation. All rights reserved.