com.arangodb.util

Interface ArangoSerializer

All Known Subinterfaces:

ArangoUtil

All Known Implementing Classes:

ArangoSerializerImpl, ArangoUtilImpl

public interface ArangoSerializer

Author:

Mark - mark at arangodb.com

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, boolean serializeNullValues) Serialize a given Object to VelocyPack
com.arangodb.velocypack.VPackSlice	serialize(Object entity, boolean serializeNullValues, boolean stringAsJson) Serialize a given Object to VelocyPack.
com.arangodb.velocypack.VPackSlice	serialize(Object entity, Type type) Serialize a given Object to VelocyPack.
com.arangodb.velocypack.VPackSlice	serialize(Object entity, Type type, boolean serializeNullValues) Serialize a given Object to VelocyPack.
com.arangodb.velocypack.VPackSlice	serialize(Object entity, Type type, Map<String,Object> additionalFields) Serialize a given Object to VelocyPack.

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,
                                             boolean serializeNullValues)
                                      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.

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

Returns:

the serialized VelocyPack

Throws:

ArangoDBException

serialize

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

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

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

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

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

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

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

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