## Uses of Interface
org.apache.tinkerpop.gremlin.structure.util.Attachable

- Packages that use Attachable
  Package | Description
  --- | ---
  org.apache.tinkerpop.gremlin.process.remote.traversal |
  org.apache.tinkerpop.gremlin.process.traversal |
  org.apache.tinkerpop.gremlin.process.traversal.traverser |
  org.apache.tinkerpop.gremlin.process.traversal.traverser.util |
  org.apache.tinkerpop.gremlin.structure.io |
  org.apache.tinkerpop.gremlin.structure.io.graphml |
  org.apache.tinkerpop.gremlin.structure.io.graphson |
  org.apache.tinkerpop.gremlin.structure.io.gryo |
  org.apache.tinkerpop.gremlin.structure.util |
  org.apache.tinkerpop.gremlin.structure.util.detached |
  org.apache.tinkerpop.gremlin.structure.util.reference |
  org.apache.tinkerpop.gremlin.structure.util.star |

- - ### Uses of Attachable in org.apache.tinkerpop.gremlin.process.remote.traversal

    Subinterfaces of Attachable in org.apache.tinkerpop.gremlin.process.remote.traversal
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `RemoteTraverser<T>`

    Classes in org.apache.tinkerpop.gremlin.process.remote.traversal that implement Attachable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractRemoteTraverser<T>`
    `class` | `DefaultRemoteTraverser<T>`

  - ### Uses of Attachable in org.apache.tinkerpop.gremlin.process.traversal

    Subinterfaces of Attachable in org.apache.tinkerpop.gremlin.process.traversal
    Modifier and Type | Interface and Description
    --- | ---
    `static interface` | `Traverser.Admin<T>` The methods in System.Traverser are useful to underlying Step and Traversal implementations.

    Method parameters in org.apache.tinkerpop.gremlin.process.traversal with type arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `T` | Traverser.Admin.`attach(Function<Attachable<T>,T> method)` Regenerate the detached traverser given its location at a particular vertex.

  - ### Uses of Attachable in org.apache.tinkerpop.gremlin.process.traversal.traverser

    Classes in org.apache.tinkerpop.gremlin.process.traversal.traverser that implement Attachable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `B_LP_NL_O_P_S_SE_SL_Traverser<T>`
    `class` | `B_LP_NL_O_S_SE_SL_Traverser<T>`
    `class` | `B_LP_O_P_S_SE_SL_Traverser<T>`
    `class` | `B_LP_O_S_SE_SL_Traverser<T>`
    `class` | `B_NL_O_S_SE_SL_Traverser<T>`
    `class` | `B_O_S_SE_SL_Traverser<T>`
    `class` | `B_O_Traverser<T>`
    `class` | `LP_NL_O_OB_P_S_SE_SL_Traverser<T>`
    `class` | `LP_NL_O_OB_S_SE_SL_Traverser<T>`
    `class` | `LP_O_OB_P_S_SE_SL_Traverser<T>`
    `class` | `LP_O_OB_S_SE_SL_Traverser<T>`
    `class` | `NL_O_OB_S_SE_SL_Traverser<T>`
    `class` | `O_OB_S_SE_SL_Traverser<T>`
    `class` | `O_Traverser<T>`
    `class` | `ProjectedTraverser<T,P>`

    Method parameters in org.apache.tinkerpop.gremlin.process.traversal.traverser with type arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `T` | ProjectedTraverser.`attach(Function<Attachable<T>,T> method)`

  - ### Uses of Attachable in org.apache.tinkerpop.gremlin.process.traversal.traverser.util

    Classes in org.apache.tinkerpop.gremlin.process.traversal.traverser.util that implement Attachable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractTraverser<T>`
    `class` | `EmptyTraverser<T>` A `Traverser` with no bulk which effectively means that it will no longer be propagated through a `Traversal`.

    Method parameters in org.apache.tinkerpop.gremlin.process.traversal.traverser.util with type arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `T` | EmptyTraverser.`attach(Function<Attachable<T>,T> method)`
    `T` | AbstractTraverser.`attach(Function<Attachable<T>,T> method)`

  - ### Uses of Attachable in org.apache.tinkerpop.gremlin.structure.io

    Method parameters in org.apache.tinkerpop.gremlin.structure.io with type arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GraphReader.`readEdge(InputStream inputStream, Function<Attachable<Edge>,Edge> edgeAttachMethod)` Reads a single edge from an `InputStream`.
    `Property` | GraphReader.`readProperty(InputStream inputStream, Function<Attachable<Property>,Property> propertyAttachMethod)` Reads a single property from an `InputStream`.
    `Vertex` | GraphReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod)` Reads a single vertex from an `InputStream`.
    `Vertex` | GraphReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Reads a single vertex from an `InputStream`.
    `Vertex` | GraphReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Reads a single vertex from an `InputStream`.
    `VertexProperty` | GraphReader.`readVertexProperty(InputStream inputStream, Function<Attachable<VertexProperty>,VertexProperty> vertexPropertyAttachMethod)` Reads a single vertex property from an `InputStream`.
    `Iterator<Vertex>` | GraphReader.`readVertices(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Reads a set of one or more vertices from an `InputStream` which were written by `GraphWriter.writeVertices(OutputStream, Iterator)`.
    `Iterator<Vertex>` | GraphReader.`readVertices(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Reads a set of one or more vertices from an `InputStream` which were written by `GraphWriter.writeVertices(OutputStream, Iterator)`.

  - ### Uses of Attachable in org.apache.tinkerpop.gremlin.structure.io.graphml

    Method parameters in org.apache.tinkerpop.gremlin.structure.io.graphml with type arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GraphMLReader.`readEdge(InputStream inputStream, Function<Attachable<Edge>,Edge> edgeAttachMethod)` This method is not supported for this reader.
    `Property` | GraphMLReader.`readProperty(InputStream inputStream, Function<Attachable<Property>,Property> propertyAttachMethod)` This method is not supported for this reader.
    `Vertex` | GraphMLReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod)` This method is not supported for this reader.
    `Vertex` | GraphMLReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.
    `Vertex` | GraphMLReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.
    `VertexProperty` | GraphMLReader.`readVertexProperty(InputStream inputStream, Function<Attachable<VertexProperty>,VertexProperty> vertexPropertyAttachMethod)` This method is not supported for this reader.
    `Iterator<Vertex>` | GraphMLReader.`readVertices(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.
    `Iterator<Vertex>` | GraphMLReader.`readVertices(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.

  - ### Uses of Attachable in org.apache.tinkerpop.gremlin.structure.io.graphson

    Method parameters in org.apache.tinkerpop.gremlin.structure.io.graphson with type arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GraphSONReader.`readEdge(InputStream inputStream, Function<Attachable<Edge>,Edge> edgeAttachMethod)` Read an `Edge` from output generated by `GraphSONWriter.writeEdge(OutputStream, Edge)` or via an `Edge` passed to `GraphSONWriter.writeObject(OutputStream, Object)`.
    `Edge` | LegacyGraphSONReader.`readEdge(InputStream inputStream, Function<Attachable<Edge>,Edge> edgeAttachMethod)` This method is not supported for this reader.
    `Property` | GraphSONReader.`readProperty(InputStream inputStream, Function<Attachable<Property>,Property> propertyAttachMethod)` Read a `Property` from output generated by `GraphSONWriter.writeProperty(OutputStream, Property)` or via an `Property` passed to `GraphSONWriter.writeObject(OutputStream, Object)`.
    `Property` | LegacyGraphSONReader.`readProperty(InputStream inputStream, Function<Attachable<Property>,Property> propertyAttachMethod)` This method is not supported for this reader.
    `Vertex` | GraphSONReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod)` Read a `Vertex` from output generated by any of the `GraphSONWriter` `writeVertex` or `writeVertices` methods or by `GraphSONWriter.writeGraph(OutputStream, Graph)`.
    `Vertex` | LegacyGraphSONReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod)` This method is not supported for this reader.
    `Vertex` | GraphSONReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read a `Vertex` from output generated by any of the `GraphSONWriter` `writeVertex` or `writeVertices` methods or by `GraphSONWriter.writeGraph(OutputStream, Graph)`.
    `Vertex` | GraphSONReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read a `Vertex` from output generated by any of the `GraphSONWriter` `writeVertex` or `writeVertices` methods or by `GraphSONWriter.writeGraph(OutputStream, Graph)`.
    `Vertex` | LegacyGraphSONReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.
    `Vertex` | LegacyGraphSONReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.
    `VertexProperty` | GraphSONReader.`readVertexProperty(InputStream inputStream, Function<Attachable<VertexProperty>,VertexProperty> vertexPropertyAttachMethod)` Read a `VertexProperty` from output generated by `GraphSONWriter.writeVertexProperty(OutputStream, VertexProperty)` or via an `VertexProperty` passed to `GraphSONWriter.writeObject(OutputStream, Object)`.
    `VertexProperty` | LegacyGraphSONReader.`readVertexProperty(InputStream inputStream, Function<Attachable<VertexProperty>,VertexProperty> vertexPropertyAttachMethod)` This method is not supported for this reader.
    `Iterator<Vertex>` | GraphSONReader.`readVertices(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read `Vertex` objects from output generated by any of the `GraphSONWriter` `writeVertex` or `writeVertices` methods or by `GraphSONWriter.writeGraph(OutputStream, Graph)`.
    `Iterator<Vertex>` | GraphSONReader.`readVertices(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read `Vertex` objects from output generated by any of the `GraphSONWriter` `writeVertex` or `writeVertices` methods or by `GraphSONWriter.writeGraph(OutputStream, Graph)`.
    `Iterator<Vertex>` | LegacyGraphSONReader.`readVertices(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.
    `Iterator<Vertex>` | LegacyGraphSONReader.`readVertices(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.

  - ### Uses of Attachable in org.apache.tinkerpop.gremlin.structure.io.gryo

    Method parameters in org.apache.tinkerpop.gremlin.structure.io.gryo with type arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GryoReader.`readEdge(InputStream inputStream, Function<Attachable<Edge>,Edge> edgeAttachMethod)` Read an `Edge` from output generated by `GryoWriter.writeEdge(OutputStream, Edge)` or via an `Edge` passed to `GryoWriter.writeObject(OutputStream, Object)`.
    `Property` | GryoReader.`readProperty(InputStream inputStream, Function<Attachable<Property>,Property> propertyAttachMethod)` Read a `Property` from output generated by `GryoWriter.writeProperty(OutputStream, Property)` or via an `Property` passed to `GryoWriter.writeObject(OutputStream, Object)`.
    `Vertex` | GryoReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod)` Read a `Vertex` from output generated by any of the `GryoWriter` `writeVertex` or `writeVertices` methods or by `GryoWriter.writeGraph(OutputStream, Graph)`.
    `Vertex` | GryoReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read a `Vertex` from output generated by any of the `GryoWriter` `writeVertex` or `writeVertices` methods or by `GryoWriter.writeGraph(OutputStream, Graph)`.
    `Vertex` | GryoReader.`readVertex(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read a `Vertex` from output generated by any of the `GryoWriter` `writeVertex` or `writeVertices` methods or by `GryoWriter.writeGraph(OutputStream, Graph)`.
    `VertexProperty` | GryoReader.`readVertexProperty(InputStream inputStream, Function<Attachable<VertexProperty>,VertexProperty> vertexPropertyAttachMethod)` Read a `VertexProperty` from output generated by `GryoWriter.writeVertexProperty(OutputStream, VertexProperty)` or via an `VertexProperty` passed to `GryoWriter.writeObject(OutputStream, Object)`.
    `Iterator<Vertex>` | GryoReader.`readVertices(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read `Vertex` objects from output generated by any of the `GryoWriter` `writeVertex` or `writeVertices` methods or by `GryoWriter.writeGraph(OutputStream, Graph)`.
    `Iterator<Vertex>` | GryoReader.`readVertices(InputStream inputStream, Function<Attachable<Vertex>,Vertex> vertexAttachMethod, Function<Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read `Vertex` objects from output generated by any of the `GryoWriter` `writeVertex` or `writeVertices` methods or by `GryoWriter.writeGraph(OutputStream, Graph)`.

  - ### Uses of Attachable in org.apache.tinkerpop.gremlin.structure.util

    Methods in org.apache.tinkerpop.gremlin.structure.util that return types with arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `static <V> Function<Attachable<V>,V>` | Attachable.Method.`create(Host hostVertexOrGraph)`
    `static <V> Function<Attachable<V>,V>` | Attachable.Method.`get(Host hostVertexOrGraph)`
    `static <V> Function<Attachable<V>,V>` | Attachable.Method.`getOrCreate(Host hostVertexOrGraph)`

    Methods in org.apache.tinkerpop.gremlin.structure.util with parameters of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `static IllegalStateException` | Attachable.Exceptions.`canNotGetAttachableFromHostGraph(Attachable<?> attachable, Graph hostGraph)`
    `static IllegalStateException` | Attachable.Exceptions.`canNotGetAttachableFromHostVertex(Attachable<?> attachable, Vertex hostVertex)`
    `static Edge` | Attachable.Method.`createEdge(Attachable<Edge> attachableEdge, Graph hostGraph)`
    `static Edge` | Attachable.Method.`createEdge(Attachable<Edge> attachableEdge, Vertex hostVertex)`
    `static Property` | Attachable.Method.`createProperty(Attachable<Property> attachableProperty, Graph hostGraph)`
    `static Property` | Attachable.Method.`createProperty(Attachable<Property> attachableProperty, Vertex hostVertex)`
    `static Vertex` | Attachable.Method.`createVertex(Attachable<Vertex> attachableVertex, Graph hostGraph)`
    `static Vertex` | Attachable.Method.`createVertex(Attachable<Vertex> attachableVertex, Vertex hostVertex)`
    `static VertexProperty` | Attachable.Method.`createVertexProperty(Attachable<VertexProperty> attachableVertexProperty, Graph hostGraph)`
    `static VertexProperty` | Attachable.Method.`createVertexProperty(Attachable<VertexProperty> attachableVertexProperty, Vertex hostVertex)`
    `static Optional<Edge>` | Attachable.Method.`getEdge(Attachable<Edge> attachableEdge, Graph hostGraph)`
    `static Optional<Edge>` | Attachable.Method.`getEdge(Attachable<Edge> attachableEdge, Vertex hostVertex)`
    `static Optional<Property>` | Attachable.Method.`getProperty(Attachable<Property> attachableProperty, Graph hostGraph)`
    `static Optional<Property>` | Attachable.Method.`getProperty(Attachable<Property> attachableProperty, Vertex hostVertex)`
    `static Optional<Vertex>` | Attachable.Method.`getVertex(Attachable<Vertex> attachableVertex, Graph hostGraph)`
    `static Optional<Vertex>` | Attachable.Method.`getVertex(Attachable<Vertex> attachableVertex, Vertex hostVertex)`
    `static Optional<VertexProperty>` | Attachable.Method.`getVertexProperty(Attachable<VertexProperty> attachableVertexProperty, Graph hostGraph)`
    `static Optional<VertexProperty>` | Attachable.Method.`getVertexProperty(Attachable<VertexProperty> attachableVertexProperty, Vertex hostVertex)`
    `static IllegalArgumentException` | Attachable.Exceptions.`providedAttachableMustContainAGraphObject(Attachable<?> attachable)`

    Method parameters in org.apache.tinkerpop.gremlin.structure.util with type arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `default V` | Attachable.`attach(Function<Attachable<V>,V> method)` Provide a way to attach an `Attachable` implementation to a host.

  - ### Uses of Attachable in org.apache.tinkerpop.gremlin.structure.util.detached

    Classes in org.apache.tinkerpop.gremlin.structure.util.detached that implement Attachable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DetachedEdge` Represents an `Edge` that is disconnected from a `Graph`.
    `class` | `DetachedElement<E>`
    `class` | `DetachedPath`
    `class` | `DetachedProperty<V>`
    `class` | `DetachedVertex` Represents a `Vertex` that is disconnected from a `Graph`.
    `class` | `DetachedVertexProperty<V>`

    Method parameters in org.apache.tinkerpop.gremlin.structure.util.detached with type arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `Path` | DetachedPath.`attach(Function<Attachable<Path>,Path> method)`

  - ### Uses of Attachable in org.apache.tinkerpop.gremlin.structure.util.reference

    Classes in org.apache.tinkerpop.gremlin.structure.util.reference that implement Attachable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ReferenceEdge`
    `class` | `ReferenceElement<E extends Element>`
    `class` | `ReferencePath`
    `class` | `ReferenceProperty<V>`
    `class` | `ReferenceVertex`
    `class` | `ReferenceVertexProperty<V>`

    Method parameters in org.apache.tinkerpop.gremlin.structure.util.reference with type arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `Path` | ReferencePath.`attach(Function<Attachable<Path>,Path> method)`

  - ### Uses of Attachable in org.apache.tinkerpop.gremlin.structure.util.star

    Classes in org.apache.tinkerpop.gremlin.structure.util.star that implement Attachable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `StarGraph.StarEdge`
    `class` | `StarGraph.StarElement<E extends Element>`
    `class` | `StarGraph.StarInEdge`
    `class` | `StarGraph.StarOutEdge`
    `class` | `StarGraph.StarProperty<V>`
    `class` | `StarGraph.StarVertex`
    `class` | `StarGraph.StarVertexProperty<V>`

    Method parameters in org.apache.tinkerpop.gremlin.structure.util.star with type arguments of type Attachable
    Modifier and Type | Method and Description
    --- | ---
    `static void` | StarGraphGraphSONDeserializer.`readStarGraphEdges(Function<Attachable<Edge>,Edge> edgeMaker, StarGraph starGraph, Map<String,Object> vertexData, String direction)` A helper function for reading vertex edges from a serialized `StarGraph` (i.e.

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