com.azure.core.util.serializer

Interface SerializerAdapter

All Known Implementing Classes:

JacksonAdapter

public interface SerializerAdapter

An interface defining the behaviors of a serializer.

Method Summary

Modifier and Type	Method and Description
<U> U	deserialize(HttpHeaders headers, Type type) Deserialize the provided headers returned from a REST API to an entity instance declared as the model to hold 'Matching' headers.
<U> U	deserialize(String value, Type type, SerializerEncoding encoding) Deserializes a string into a U object.
String	serialize(Object object, SerializerEncoding encoding) Serializes an object into a string.
String	serializeList(List<?> list, CollectionFormat format) Serializes a list into a string with the delimiter specified with the Swagger collection format joining each individual serialized items in the list.
String	serializeRaw(Object object) Serializes an object into a raw string.

Method Detail

serialize

String serialize(Object object,
                 SerializerEncoding encoding)
          throws IOException

Serializes an object into a string.

Parameters:

object - the object to serialize

encoding - the encoding to use for serialization

Returns:

the serialized string. Null if the object to serialize is null

Throws:

IOException - exception from serialization

serializeRaw

String serializeRaw(Object object)

Serializes an object into a raw string. The leading and trailing quotes will be trimmed.

Parameters:

object - the object to serialize

Returns:

the serialized string. Null if the object to serialize is null

serializeList

String serializeList(List<?> list,
                     CollectionFormat format)

Serializes a list into a string with the delimiter specified with the Swagger collection format joining each individual serialized items in the list.

Parameters:

list - the list to serialize

format - the Swagger collection format

Returns:

the serialized string

deserialize

<U> U deserialize(String value,
                  Type type,
                  SerializerEncoding encoding)
           throws IOException

Deserializes a string into a U object.

Type Parameters:

U - the type of the deserialized object

Parameters:

value - the string value to deserialize

type - the type to deserialize

encoding - the encoding used in the serialized value

Returns:

the deserialized object

Throws:

IOException - exception from deserialization

deserialize

<U> U deserialize(HttpHeaders headers,
                  Type type)
           throws IOException

Deserialize the provided headers returned from a REST API to an entity instance declared as the model to hold 'Matching' headers. 'Matching' headers are the REST API returned headers those with:

1. header names same as name of a properties in the entity.
2. header names start with value of HeaderCollection annotation applied to the properties in the entity.

When needed, the 'header entity' types must be declared as first generic argument of ResponseBase returned by java proxy method corresponding to the REST API. e.g. Mono<RestResponseBase<FooMetadataHeaders, Void>> getMetadata(args); class FooMetadataHeaders { String name; {@literal @}HeaderCollection("header-collection-prefix-") Map<String,String> headerCollection; } in the case of above example, this method produces an instance of FooMetadataHeaders from provided headers.

Type Parameters:

U - the type of the deserialized object

Parameters:

headers - the REST API returned headers

type - the type to deserialize

Returns:

instance of header entity type created based on provided headers, if header entity model does not exists then return null

Throws:

IOException - If an I/O error occurs