JacksonAdapter (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.core.util.serializer.JacksonAdapter

All Implemented Interfaces:

SerializerAdapter
```
public class JacksonAdapter
extends Object
implements SerializerAdapter
```
Implementation of SerializerAdapter for Jackson.

Constructor Summary

Constructors
Constructor and Description

JacksonAdapter()
Creates a new JacksonAdapter instance with default mapper settings.

Constructors
Constructor and Description
`JacksonAdapter()` Creates a new JacksonAdapter instance with default mapper settings.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SerializerAdapter`	`createDefaultSerializerAdapter()` maintain singleton instance of the default serializer adapter.
`<T> T`	`deserialize(HttpHeaders headers, Type deserializedHeadersType)` Deserialize the provided headers returned from a REST API to an entity instance declared as the model to hold 'Matching' headers.
`<T> T`	`deserialize(InputStream inputStream, Type type, SerializerEncoding encoding)` Deserializes a byte[] into a `T` object.
`<T> T`	`deserialize(String value, Type type, SerializerEncoding encoding)` Deserializes a string into a `T` object.
`String`	`serialize(Object object, SerializerEncoding encoding)` Serializes an object into a string.
`void`	`serialize(Object object, SerializerEncoding encoding, OutputStream outputStream)` Serializes an object and writes its output into an `OutputStream`.
`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.
`com.fasterxml.jackson.databind.ObjectMapper`	`serializer()`
`String`	`serializeRaw(Object object)` Serializes an object into a raw string.
`protected com.fasterxml.jackson.databind.ObjectMapper`	`simpleMapper()` Gets a static instance of `ObjectMapper` that doesn't handle flattening.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JacksonAdapter
```
public JacksonAdapter()
```
    Creates a new JacksonAdapter instance with default mapper settings.
- Method Detail
  - simpleMapper
```
protected com.fasterxml.jackson.databind.ObjectMapper simpleMapper()
```
    Gets a static instance of ObjectMapper that doesn't handle flattening.
    
    Returns:
    
    an instance of ObjectMapper.
  - createDefaultSerializerAdapter
```
public static SerializerAdapter createDefaultSerializerAdapter()
```
    maintain singleton instance of the default serializer adapter.
    
    Returns:
    
    the default serializer
  - serializer
```
public com.fasterxml.jackson.databind.ObjectMapper serializer()
```
    Returns:
    
    the original serializer type
  - serialize
```
public String serialize(Object object,
                        SerializerEncoding encoding)
                 throws IOException
```
    Description copied from interface: SerializerAdapter
    
    Serializes an object into a string.
    
    Specified by:
    
    serialize in interface SerializerAdapter
    
    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
  - serialize
```
public void serialize(Object object,
                      SerializerEncoding encoding,
                      OutputStream outputStream)
               throws IOException
```
    Description copied from interface: SerializerAdapter
    
    Serializes an object and writes its output into an OutputStream.
    
    Specified by:
    
    serialize in interface SerializerAdapter
    
    Parameters:
    
    object - The object to serialize.
    
    encoding - The encoding to use for serialization.
    
    outputStream - The OutputStream where the serialized object will be written.
    
    Throws:
    
    IOException - exception from serialization
  - serializeRaw
```
public String serializeRaw(Object object)
```
    Description copied from interface: SerializerAdapter
    
    Serializes an object into a raw string. The leading and trailing quotes will be trimmed.
    
    Specified by:
    
    serializeRaw in interface SerializerAdapter
    
    Parameters:
    
    object - the object to serialize
    
    Returns:
    
    the serialized string. Null if the object to serialize is null
  - serializeList
```
public String serializeList(List<?> list,
                            CollectionFormat format)
```
    Description copied from interface: SerializerAdapter
    
    Serializes a list into a string with the delimiter specified with the Swagger collection format joining each individual serialized items in the list.
    
    Specified by:
    
    serializeList in interface SerializerAdapter
    
    Parameters:
    
    list - the list to serialize
    
    format - the Swagger collection format
    
    Returns:
    
    the serialized string
  - deserialize
```
public <T> T deserialize(String value,
                         Type type,
                         SerializerEncoding encoding)
                  throws IOException
```
    Description copied from interface: SerializerAdapter
    
    Deserializes a string into a T object.
    
    Specified by:
    
    deserialize in interface SerializerAdapter
    
    Type Parameters:
    
    T - 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
```
public <T> T deserialize(InputStream inputStream,
                         Type type,
                         SerializerEncoding encoding)
                  throws IOException
```
    Description copied from interface: SerializerAdapter
    
    Deserializes a byte[] into a T object.
    
    Specified by:
    
    deserialize in interface SerializerAdapter
    
    Type Parameters:
    
    T - The type of the deserialized object.
    
    Parameters:
    
    inputStream - The InputStream containing the serialized object data to deserialize.
    
    type - The type to deserialize.
    
    encoding - The encoding used to serialize value.
    
    Returns:
    
    The deserialized object, or null if it cannot be deserialized.
    
    Throws:
    
    IOException - exception from deserialization
  - deserialize
```
public <T> T deserialize(HttpHeaders headers,
                         Type deserializedHeadersType)
                  throws IOException
```
    Description copied from interface: SerializerAdapter
    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.
    Specified by:
    
    deserialize in interface SerializerAdapter
    
    Type Parameters:
    
    T - the type of the deserialized object
    
    Parameters:
    
    headers - the REST API returned headers
    
    deserializedHeadersType - the type to deserialize
    
    Returns:
    
    instance of header entity type created based on provided headers, if header entity model does not not exists then return null
    
    Throws:
    
    IOException - If an I/O error occurs

Class JacksonAdapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JacksonAdapter

Method Detail

simpleMapper

createDefaultSerializerAdapter

serializer

serialize

serialize

serializeRaw

serializeList

deserialize

deserialize

deserialize