org.apache.tinkerpop.gremlin.structure.io.gryo

## Class GryoWriter

- java.lang.Object
- - org.apache.tinkerpop.gremlin.structure.io.gryo.GryoWriter

- All Implemented Interfaces:
    GraphWriter

      public final class GryoWriter
      extends Object
      implements GraphWriter

  The `GraphWriter` for the Gremlin Structure serialization format based on Kryo. The format is meant to be non-lossy in terms of Gremlin Structure to Gremlin Structure migrations (assuming both structure implementations support the same graph features).

  This implementation is not thread-safe. Have one `GraphWriter` instance per thread.
  Author:
    Stephen Mallette (http://stephen.genoprime.com)

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `GryoWriter.Builder`

    - ### Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.io.GraphWriter

      `GraphWriter.WriterBuilder<T extends GraphWriter>`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static GryoWriter.Builder` | `build()`
    `void` | `writeEdge(OutputStream outputStream, Edge e)` Write an edge to a stream.
    `void` | `writeGraph(OutputStream outputStream, Graph g)` Write the entire graph to a stream.
    `void` | `writeObject(OutputStream outputStream, Object object)` Writes an arbitrary object to the stream.
    `void` | `writeProperty(OutputStream outputStream, Property p)` Write a property to a stream.
    `void` | `writeVertex(OutputStream outputStream, Vertex v)` Write a vertex to a stream without writing its edges.
    `void` | `writeVertex(OutputStream outputStream, Vertex v, Direction direction)` Write a vertex to a stream with its associated edges.
    `void` | `writeVertexProperty(OutputStream outputStream, VertexProperty vp)` Write a vertex property to a stream.
    `void` | `writeVertices(OutputStream outputStream, Iterator<Vertex> vertexIterator)` Write a vertex to a stream without writing its edges.
    `void` | `writeVertices(OutputStream outputStream, Iterator<Vertex> vertexIterator, Direction direction)` Write a list of vertices from a `Traversal` to a stream with its associated edges.

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

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

- - ### Method Detail

    - #### writeGraph

          public void writeGraph(OutputStream outputStream,
                                 Graph g)
                          throws IOException

      Write the entire graph to a stream.
      Specified by:
        `writeGraph` in interface `GraphWriter`
      Parameters:
        `outputStream` - the stream to write to.
        `g` - the graph to write to stream.
      Throws:
        `IOException`

    - #### writeVertices

          public void writeVertices(OutputStream outputStream,
                                    Iterator<Vertex> vertexIterator,
                                    Direction direction)
                             throws IOException

      Write a list of vertices from a `Traversal` to a stream with its associated edges. Only write edges as defined by the requested direction.
      Specified by:
        `writeVertices` in interface `GraphWriter`
      Parameters:
        `outputStream` - the stream to write to.
        `vertexIterator` - a traversal that returns a list of vertices.
        `direction` - the direction of edges to write or null if no edges are to be written.
      Throws:
        `IOException`

    - #### writeVertices

          public void writeVertices(OutputStream outputStream,
                                    Iterator<Vertex> vertexIterator)
                             throws IOException

      Write a vertex to a stream without writing its edges.
      Specified by:
        `writeVertices` in interface `GraphWriter`
      Parameters:
        `outputStream` - the stream to write to.
        `vertexIterator` - a iterator that returns a list of vertices.
      Throws:
        `IOException`

    - #### writeVertex

          public void writeVertex(OutputStream outputStream,
                                  Vertex v,
                                  Direction direction)
                           throws IOException

      Write a vertex to a stream with its associated edges. Only write edges as defined by the requested direction.
      Specified by:
        `writeVertex` in interface `GraphWriter`
      Parameters:
        `outputStream` - the stream to write to.
        `v` - the vertex to write.
        `direction` - the direction of edges to write or null if no edges are to be written.
      Throws:
        `IOException`

    - #### writeVertex

          public void writeVertex(OutputStream outputStream,
                                  Vertex v)
                           throws IOException

      Write a vertex to a stream without writing its edges.
      Specified by:
        `writeVertex` in interface `GraphWriter`
      Parameters:
        `outputStream` - the stream to write to.
        `v` - the vertex to write.
      Throws:
        `IOException`

    - #### writeEdge

          public void writeEdge(OutputStream outputStream,
                                Edge e)
                         throws IOException

      Write an edge to a stream.
      Specified by:
        `writeEdge` in interface `GraphWriter`
      Parameters:
        `outputStream` - the stream to write to.
        `e` - the edge to write.
      Throws:
        `IOException`

    - #### writeVertexProperty

          public void writeVertexProperty(OutputStream outputStream,
                                          VertexProperty vp)
                                   throws IOException

      Write a vertex property to a stream.
      Specified by:
        `writeVertexProperty` in interface `GraphWriter`
      Parameters:
        `outputStream` - the stream to write to.
        `vp` - the vertex property to write.
      Throws:
        `IOException`

    - #### writeProperty

          public void writeProperty(OutputStream outputStream,
                                    Property p)
                             throws IOException

      Write a property to a stream.
      Specified by:
        `writeProperty` in interface `GraphWriter`
      Parameters:
        `outputStream` - the stream to write to.
        `p` - the property to write.
      Throws:
        `IOException`

    - #### writeObject

          public void writeObject(OutputStream outputStream,
                                  Object object)

      Writes an arbitrary object to the stream.
      Specified by:
        `writeObject` in interface `GraphWriter`
      Parameters:
        `outputStream` - the stream to write to.
        `object` - the object to write which will use the standard serializer set.

    - #### build

          public static GryoWriter.Builder build()

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