com.arangodb.util

Interface ArangoSerializer

All Known Subinterfaces:

ArangoSerialization

All Known Implementing Classes:

ArangoSerializerImpl, ArangoUtilImpl

public interface ArangoSerializer

Author:

Mark Vollmary

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ArangoSerializer.Options

Method Summary

Modifier and Type	Method and Description
com.arangodb.velocypack.VPackSlice	serialize(Object entity) Serialize a given Object to VelocyPack
com.arangodb.velocypack.VPackSlice	serialize(Object entity, ArangoSerializer.Options options) Serialize a given Object to VelocyPack
com.arangodb.velocypack.VPackSlice	serialize(Object entity, boolean serializeNullValues) Deprecated. use serialize(Object, Options) instead
com.arangodb.velocypack.VPackSlice	serialize(Object entity, boolean serializeNullValues, boolean stringAsJson) Deprecated. use serialize(Object, Options) instead
com.arangodb.velocypack.VPackSlice	serialize(Object entity, Type type) Deprecated. use serialize(Object, Options) instead
com.arangodb.velocypack.VPackSlice	serialize(Object entity, Type type, boolean serializeNullValues) Deprecated. use serialize(Object, Options) instead
com.arangodb.velocypack.VPackSlice	serialize(Object entity, Type type, Map<String,Object> additionalFields) Deprecated. use serialize(Object, Options) instead

Method Detail

serialize

com.arangodb.velocypack.VPackSlice serialize(Object entity)
                                      throws ArangoDBException

Serialize a given Object to VelocyPack

Parameters:

entity - The Object to serialize. If it is from type String, it will be handled as a Json.

Returns:

The serialized VelocyPack

Throws:

ArangoDBException

serialize

com.arangodb.velocypack.VPackSlice serialize(Object entity,
                                             ArangoSerializer.Options options)
                                      throws ArangoDBException

Serialize a given Object to VelocyPack

Parameters:

entity - The Object to serialize. If it is from type String, it will be handled as a Json.

options - Additional options

Returns:

the serialized VelocyPack

Throws:

ArangoDBException

serialize

@Deprecated
com.arangodb.velocypack.VPackSlice serialize(Object entity,
                                                          boolean serializeNullValues)
                                                   throws ArangoDBException

Deprecated. use serialize(Object, Options) instead

Serialize a given Object to VelocyPack

Parameters:

entity - The Object to serialize. If it is from type String, it will be handled as a Json.

serializeNullValues - Whether or not null values should be excluded from serialization.

Returns:

the serialized VelocyPack

Throws:

ArangoDBException

serialize

@Deprecated
com.arangodb.velocypack.VPackSlice serialize(Object entity,
                                                          boolean serializeNullValues,
                                                          boolean stringAsJson)
                                                   throws ArangoDBException

Deprecated. use serialize(Object, Options) instead

Serialize a given Object to VelocyPack. If the Object is from type Iterable the String will be interpreted as Json

Parameters:

entity - The Object to serialize. If it is from type String, it will be handled as a Json.

serializeNullValues - Whether or not null values should be excluded from serialization.

stringAsJson -

Returns:

the serialized VelocyPack

Throws:

ArangoDBException

serialize

@Deprecated
com.arangodb.velocypack.VPackSlice serialize(Object entity,
                                                          Type type)
                                                   throws ArangoDBException

Deprecated. use serialize(Object, Options) instead

Serialize a given Object to VelocyPack. This method is for serialization of types with generic parameter like Collection, List, Map.

Parameters:

entity - The Object to serialize

type - The source type of the Object.

Returns:

the serialized VelocyPack

Throws:

ArangoDBException

serialize

@Deprecated
com.arangodb.velocypack.VPackSlice serialize(Object entity,
                                                          Type type,
                                                          boolean serializeNullValues)
                                                   throws ArangoDBException

Deprecated. use serialize(Object, Options) instead

Serialize a given Object to VelocyPack. This method is for serialization of types with generic parameter like Collection, List, Map.

Parameters:

entity - The Object to serialize

type - The source type of the Object.

serializeNullValues - Whether or not null values should be excluded from serialization.

Returns:

the serialized VelocyPack

Throws:

ArangoDBException

serialize

@Deprecated
com.arangodb.velocypack.VPackSlice serialize(Object entity,
                                                          Type type,
                                                          Map<String,Object> additionalFields)
                                                   throws ArangoDBException

Deprecated. use serialize(Object, Options) instead

Serialize a given Object to VelocyPack. This method is for serialization of types with generic parameter like Collection, List, Map.

Parameters:

entity - The Object to serialize

type - The source type of the Object.

serializeNullValues - Whether or not null values should be excluded from serialization.

additionalFields - Additional Key/Value pairs to include in the created VelocyPack

Returns:

the serialized VelocyPack

Throws:

ArangoDBException