Graph.Io (Gremlin Core: The Primary Components of TinkerPop3 3.0.0.M7 API)

All Known Implementing Classes:

DefaultIo

Enclosing interface:

Graph
```
public static interface Graph.Io
```
Provides access to functions related to reading and writing graph data. Implementers can override these methods to provider mapper configurations to the default GraphReader and GraphWriter implementations (i.e. to register mapper serialization classes).

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default GraphMLReader.Builder`	`graphMLReader()` Creates a `GraphReader` builder for GraphML serializations.
`default GraphMLWriter.Builder`	`graphMLWriter()` Creates a `GraphWriter` builder for GraphML serializations.
`default GraphSONMapper.Builder`	`graphSONMapper()` By default, this method creates an instance of the most current version of `GraphSONMapper.Builder` which is can produce a `Mapper` implementation for GraphSON to serialize data to and from the graph.
`default GraphSONReader.Builder`	`graphSONReader()` Creates a `GraphReader` builder for GraphSON serializations.
`default GraphSONWriter.Builder`	`graphSONWriter()` Creates a `GraphWriter` builder for GraphML serializations.
`default KryoMapper.Builder`	`kryoMapper()` By default, this method creates an instance of the most current version of `KryoMapper` which is used to serialize data to and from the graph.
`default KryoReader.Builder`	`kryoReader()` Creates a `GraphReader` builder for Kryo serializations.
`default KryoWriter.Builder`	`kryoWriter()` Creates a `GraphWriter` builder for Kryo serializations.
`void`	`readGraphML(java.lang.String file)` Read a GraphML file using the default configuration of the `GraphMLReader`.
`void`	`readGraphSON(java.lang.String file)` Read a GraphSON file using the default configuration of the `GraphSONReader`.
`void`	`readKryo(java.lang.String file)` Read a kryo file using the default configuration of the `KryoReader`.
`void`	`writeGraphML(java.lang.String file)` Write a GraphML file using the default configuration of the `GraphMLWriter`.
`void`	`writeGraphSON(java.lang.String file)` Write a GraphSON file using the default configuration of the `GraphSONWriter`.
`void`	`writeKryo(java.lang.String file)` Write a kryo file using the default configuration of the `KryoWriter`.

- Method Detail
  - kryoReader
```
default KryoReader.Builder kryoReader()
```
    Creates a GraphReader builder for Kryo serializations. This method calls the kryoMapper() method to supply to KryoReader.Builder.mapper(com.tinkerpop.gremlin.structure.io.kryo.KryoMapper) which means that implementers should usually just override kryoMapper() to append in their mapper classes.
  - kryoWriter
```
default KryoWriter.Builder kryoWriter()
```
    Creates a GraphWriter builder for Kryo serializations. This method calls the kryoMapper() method to supply to KryoWriter.Builder.mapper(com.tinkerpop.gremlin.structure.io.kryo.KryoMapper) which means that implementers should usually just override kryoMapper() to append in their mapper classes.
  - writeKryo
```
void writeKryo(java.lang.String file)
        throws java.io.IOException
```
    Write a kryo file using the default configuration of the KryoWriter.
    
    Throws:
    
    java.io.IOException
  - readKryo
```
void readKryo(java.lang.String file)
       throws java.io.IOException
```
    Read a kryo file using the default configuration of the KryoReader.
    
    Throws:
    
    java.io.IOException
  - kryoMapper
```
default KryoMapper.Builder kryoMapper()
```
    By default, this method creates an instance of the most current version of KryoMapper which is used to serialize data to and from the graph. Implementers with mapper classes (e.g. a non-primitive class returned from Element.id()) should override this method with those classes automatically registered to the returned KryoMapper.
    Implementers should respect versions. Once a class is registered, the order of its registration should be maintained. Note that registering such classes will reduce the portability of the graph data as data written with KryoMapper will not be readable without this serializer configuration. It is considered good practice to make serialization classes generally available so that users may register these classes themselves if necessary when building up a mapper KryoMapper instance.
    Note that this method is meant to return current versions for serialization operations. Users wishing to use an "older" version should construct this instance as well as their readers and writers manually.
  - graphMLReader
```
default GraphMLReader.Builder graphMLReader()
```
    Creates a GraphReader builder for GraphML serializations. GraphML is the most portable of all the formats, but comes at the price of the least flexibility. Graph implementations that have mapper classes that need to be serialized will not be able to properly use this format effectively.
  - graphMLWriter
```
default GraphMLWriter.Builder graphMLWriter()
```
    Creates a GraphWriter builder for GraphML serializations. GraphML is the most portable of all the formats, but comes at the price of the least flexibility. Graph implementations that have mapper classes that need to be serialized will not be able to properly use this format effectively.
  - writeGraphML
```
void writeGraphML(java.lang.String file)
           throws java.io.IOException
```
    Write a GraphML file using the default configuration of the GraphMLWriter.
    
    Throws:
    
    java.io.IOException
  - readGraphML
```
void readGraphML(java.lang.String file)
          throws java.io.IOException
```
    Read a GraphML file using the default configuration of the GraphMLReader.
    
    Throws:
    
    java.io.IOException
  - graphSONReader
```
default GraphSONReader.Builder graphSONReader()
```
    Creates a GraphReader builder for GraphSON serializations. GraphSON is forgiving for implementers and will typically do a "reasonable" job in serializing most mapper classes. This method by default uses the GraphSONMapper created by graphSONMapper(). That method enables implementers to register mapper serialization modules for classes that do not serialize nicely by the default JSON serializers or completely fail to do so.
  - graphSONWriter
```
default GraphSONWriter.Builder graphSONWriter()
```
    Creates a GraphWriter builder for GraphML serializations. GraphSON is forgiving for implementers and will typically do a "reasonable" job in serializing most mapper classes. This method by default uses the GraphSONMapper created by graphSONMapper(). That method enables implementers to register mapper serialization modules for classes that do not serialize nicely by the default JSON serializers or completely fail to do so.
  - writeGraphSON
```
void writeGraphSON(java.lang.String file)
            throws java.io.IOException
```
    Write a GraphSON file using the default configuration of the GraphSONWriter.
    
    Throws:
    
    java.io.IOException
  - readGraphSON
```
void readGraphSON(java.lang.String file)
           throws java.io.IOException
```
    Read a GraphSON file using the default configuration of the GraphSONReader.
    
    Throws:
    
    java.io.IOException
  - graphSONMapper
```
default GraphSONMapper.Builder graphSONMapper()
```
    By default, this method creates an instance of the most current version of GraphSONMapper.Builder which is can produce a Mapper implementation for GraphSON to serialize data to and from the graph. Implementers with custom classes (e.g. a non-primitive class returned from Element.id()) should override this method with serialization modules added.
    It is considered good practice to make serialization classes generally available so that users may register these classes themselves if necessary when building up a mapper GraphSONMapper instance.
    Note that this method is meant to return a GraphSONMapper.Builder with default configuration for the current Graph. Users can adjust and override such settings by altering the builder settings.

Interface Graph.Io

Method Summary

Method Detail

kryoReader

kryoWriter

writeKryo

readKryo

kryoMapper

graphMLReader

graphMLWriter

writeGraphML

readGraphML

graphSONReader

graphSONWriter

writeGraphSON

readGraphSON

graphSONMapper