ResourceConverter (JSONAPI Converter 0.8 API)

java.lang.Object
- com.github.jasminb.jsonapi.ResourceConverter

```
public class ResourceConverter
extends Object
```
JSON API data converter.
Provides methods for conversion between JSON API resources to java POJOs and vice versa.

Author:

jbegic

Constructor Summary

Constructors
Constructor and Description
`ResourceConverter(Class<?>... classes)` Creates new ResourceConverter.
`ResourceConverter(com.fasterxml.jackson.databind.ObjectMapper mapper, Class<?>... classes)`
`ResourceConverter(com.fasterxml.jackson.databind.ObjectMapper mapper, String baseURL, Class<?>... classes)` Creates new ResourceConverter.
`ResourceConverter(String baseURL, Class<?>... classes)` Creates new ResourceConverter.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`disableDeserializationOption(DeserializationFeature option)` Removes (disables) existing deserialization option.
`void`	`disableSerializationOption(SerializationFeature option)` Removes (disables) existing serialization option.
`void`	`enableDeserializationOption(DeserializationFeature option)` Adds (enables) new deserialization option.
`void`	`enableSerializationOption(SerializationFeature option)` Adds (enables) new serialization option.
`boolean`	`isRegisteredType(Class<?> type)` Checks if provided type is registered with this converter instance.
`<T> JSONAPIDocument<T>`	`readDocument(byte[] data, Class<T> clazz)` Reads JSON API spec document and converts it into target type.
`<T> JSONAPIDocument<T>`	`readDocument(InputStream dataStream, Class<T> clazz)` Reads JSON API spec document and converts it into target type.
`<T> JSONAPIDocument<List<T>>`	`readDocumentCollection(byte[] data, Class<T> clazz)` Reads JSON API spec document and converts it into collection of target type objects.
`<T> JSONAPIDocument<List<T>>`	`readDocumentCollection(InputStream dataStream, Class<T> clazz)` Reads JSON API spec document and converts it into collection of target type objects.
`<T> T`	`readObject(byte[] data, Class<T> clazz)` Deprecated.
`<T> List<T>`	`readObjectCollection(byte[] data, Class<T> clazz)` Deprecated.
`boolean`	`registerType(Class<?> type)` Registers new type to be used with this converter instance.
`void`	`setGlobalResolver(RelationshipResolver resolver)` Registers global relationship resolver.
`void`	`setTypeResolver(RelationshipResolver resolver, Class<?> type)` Registers relationship resolver for given type.
`byte[]`	`writeDocument(JSONAPIDocument<?> document)` Serializes provided `JSONAPIDocument` into JSON API Spec compatible byte representation.
`byte[]`	`writeDocument(JSONAPIDocument<?> document, SerializationSettings settings)` Serializes provided `JSONAPIDocument` into JSON API Spec compatible byte representation.
`byte[]`	`writeDocumentCollection(JSONAPIDocument<? extends Iterable<?>> documentCollection)` Serializes provided `JSONAPIDocument` into JSON API Spec compatible byte representation.
`byte[]`	`writeDocumentCollection(JSONAPIDocument<? extends Iterable<?>> documentCollection, SerializationSettings serializationSettings)` Serializes provided `JSONAPIDocument` into JSON API Spec compatible byte representation.
`byte[]`	`writeObject(Object object)` Deprecated.
`<T> byte[]`	`writeObjectCollection(Iterable<T> objects)` Deprecated. use writeDocumentCollection instead

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

- Constructor Detail
  - ResourceConverter
```
public ResourceConverter(Class<?>... classes)
```
    Creates new ResourceConverter.
    All classes that should be handled by instance of ResourceConverter must be registered when creating a new instance of it.
    
    Parameters:
    
    classes - Class array of classes to be handled by this resource converter instance
  - ResourceConverter
```
public ResourceConverter(String baseURL,
                         Class<?>... classes)
```
    Creates new ResourceConverter.
    All classes that should be handled by instance of ResourceConverter must be registered when creating a new instance of it.
    
    Parameters:
    
    baseURL - String base URL, eg. https://api.mysite.com
    
    classes - Class array of classes to be handled by this resource converter instance
  - ResourceConverter
```
public ResourceConverter(com.fasterxml.jackson.databind.ObjectMapper mapper,
                         Class<?>... classes)
```
  - ResourceConverter
```
public ResourceConverter(com.fasterxml.jackson.databind.ObjectMapper mapper,
                         String baseURL,
                         Class<?>... classes)
```
    Creates new ResourceConverter.
    
    Parameters:
    
    mapper - ObjectMapper custom mapper to be used for resource parsing
    
    baseURL - String base URL, eg. https://api.mysite.com
    
    classes - Class array of classes to be handled by this resource converter instance
- Method Detail
  - setGlobalResolver
```
public void setGlobalResolver(RelationshipResolver resolver)
```
    Registers global relationship resolver. This resolver will be used in case relationship is present in the API response but not provided in the included section and relationship resolving is enabled trough relationship annotation.
    In case type resolver is registered it will be used instead.
    
    Parameters:
    
    resolver - resolver instance
  - setTypeResolver
```
public void setTypeResolver(RelationshipResolver resolver,
                            Class<?> type)
```
    Registers relationship resolver for given type. Resolver will be used if relationship resolution is enabled trough relationship annotation.
    
    Parameters:
    
    resolver - resolver instance
    
    type - type
  - readObject
```
@Deprecated
public <T> T readObject(byte[] data,
                                    Class<T> clazz)
```
    Deprecated.
    
    Converts raw data input into requested target type.
    
    Type Parameters:
    
    T - type
    
    Parameters:
    
    data - raw data
    
    clazz - target object
    
    Returns:
    
    converted object
    
    Throws:
    
    RuntimeException - in case conversion fails
  - readObjectCollection
```
@Deprecated
public <T> List<T> readObjectCollection(byte[] data,
                                                    Class<T> clazz)
```
    Deprecated.
    
    Converts rawdata input into a collection of requested output objects.
    
    Type Parameters:
    
    T - type
    
    Parameters:
    
    data - raw data input
    
    clazz - target type
    
    Returns:
    
    collection of converted elements
    
    Throws:
    
    RuntimeException - in case conversion fails
  - readDocument
```
public <T> JSONAPIDocument<T> readDocument(byte[] data,
                                           Class<T> clazz)
```
    Reads JSON API spec document and converts it into target type.
    
    Type Parameters:
    
    T - type
    
    Parameters:
    
    data - byte raw data (server response)
    
    clazz - Class target type
    
    Returns:
    
    JSONAPIDocument
  - readDocument
```
public <T> JSONAPIDocument<T> readDocument(InputStream dataStream,
                                           Class<T> clazz)
```
    Reads JSON API spec document and converts it into target type.
    
    Type Parameters:
    
    T - type
    
    Parameters:
    
    dataStream - byte raw dataStream (server response)
    
    clazz - Class target type
    
    Returns:
    
    JSONAPIDocument
  - readDocumentCollection
```
public <T> JSONAPIDocument<List<T>> readDocumentCollection(byte[] data,
                                                           Class<T> clazz)
```
    Reads JSON API spec document and converts it into collection of target type objects.
    
    Type Parameters:
    
    T - type
    
    Parameters:
    
    data - byte raw data (server response)
    
    clazz - Class target type
    
    Returns:
    
    JSONAPIDocument
  - readDocumentCollection
```
public <T> JSONAPIDocument<List<T>> readDocumentCollection(InputStream dataStream,
                                                           Class<T> clazz)
```
    Reads JSON API spec document and converts it into collection of target type objects.
    
    Type Parameters:
    
    T - type
    
    Parameters:
    
    dataStream - InputStream input stream
    
    clazz - Class target type
    
    Returns:
    
    JSONAPIDocument
  - writeObject
```
@Deprecated
public byte[] writeObject(Object object)
                               throws com.fasterxml.jackson.core.JsonProcessingException,
                                      IllegalAccessException
```
    Deprecated.
    
    Converts input object to byte array.
    
    Parameters:
    
    object - input object
    
    Returns:
    
    raw bytes
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException
    
    IllegalAccessException
  - writeDocument
```
public byte[] writeDocument(JSONAPIDocument<?> document)
                     throws DocumentSerializationException
```
    Serializes provided JSONAPIDocument into JSON API Spec compatible byte representation.
    
    Parameters:
    
    document - JSONAPIDocument document to serialize
    
    Returns:
    
    serialized content in bytes
    
    Throws:
    
    DocumentSerializationException - thrown in case serialization fails
  - writeDocument
```
public byte[] writeDocument(JSONAPIDocument<?> document,
                            SerializationSettings settings)
                     throws DocumentSerializationException
```
    Serializes provided JSONAPIDocument into JSON API Spec compatible byte representation.
    
    Parameters:
    
    document - JSONAPIDocument document to serialize
    
    settings - SerializationSettings settings that override global serialization settings
    
    Returns:
    
    serialized content in bytes
    
    Throws:
    
    DocumentSerializationException - thrown in case serialization fails
  - writeDocumentCollection
```
public byte[] writeDocumentCollection(JSONAPIDocument<? extends Iterable<?>> documentCollection)
                               throws DocumentSerializationException
```
    Serializes provided JSONAPIDocument into JSON API Spec compatible byte representation.
    
    Parameters:
    
    documentCollection - JSONAPIDocument document collection to serialize
    
    Returns:
    
    serialized content in bytes
    
    Throws:
    
    DocumentSerializationException - thrown in case serialization fails
  - writeDocumentCollection
```
public byte[] writeDocumentCollection(JSONAPIDocument<? extends Iterable<?>> documentCollection,
                                      SerializationSettings serializationSettings)
                               throws DocumentSerializationException
```
    Serializes provided JSONAPIDocument into JSON API Spec compatible byte representation.
    
    Parameters:
    
    documentCollection - JSONAPIDocument document collection to serialize
    
    serializationSettings - SerializationSettings settings that override global serialization settings
    
    Returns:
    
    serialized content in bytes
    
    Throws:
    
    DocumentSerializationException - thrown in case serialization fails
  - writeObjectCollection
```
@Deprecated
public <T> byte[] writeObjectCollection(Iterable<T> objects)
                                             throws com.fasterxml.jackson.core.JsonProcessingException,
                                                    IllegalAccessException
```
    Deprecated. use writeDocumentCollection instead
    
    Converts input object to byte array.
    
    Parameters:
    
    objects - List of input objects
    
    Returns:
    
    raw bytes
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException
    
    IllegalAccessException
  - isRegisteredType
```
public boolean isRegisteredType(Class<?> type)
```
    Checks if provided type is registered with this converter instance.
    
    Parameters:
    
    type - class to check
    
    Returns:
    
    returns true if type is registered, else false
  - registerType
```
public boolean registerType(Class<?> type)
```
    Registers new type to be used with this converter instance.
    
    Parameters:
    
    type - Class type to register
    
    Returns:
    
    true if type was registed, else false (in case type was registered already or type is not eligible for registering ie. missing required annotations)
  - enableDeserializationOption
```
public void enableDeserializationOption(DeserializationFeature option)
```
    Adds (enables) new deserialization option.
    
    Parameters:
    
    option - DeserializationFeature option
  - disableDeserializationOption
```
public void disableDeserializationOption(DeserializationFeature option)
```
    Removes (disables) existing deserialization option.
    
    Parameters:
    
    option - DeserializationFeature feature to disable
  - enableSerializationOption
```
public void enableSerializationOption(SerializationFeature option)
```
    Adds (enables) new serialization option.
    
    Parameters:
    
    option - SerializationFeature option
  - disableSerializationOption
```
public void disableSerializationOption(SerializationFeature option)
```
    Removes (disables) existing serialization option.
    
    Parameters:
    
    option - SerializationFeature feature to disable

Class ResourceConverter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResourceConverter

ResourceConverter

ResourceConverter

ResourceConverter

Method Detail

setGlobalResolver

setTypeResolver

readObject

readObjectCollection

readDocument

readDocument

readDocumentCollection

readDocumentCollection

writeObject

writeDocument

writeDocument

writeDocumentCollection

writeDocumentCollection

writeObjectCollection

isRegisteredType

registerType

enableDeserializationOption

disableDeserializationOption

enableSerializationOption

disableSerializationOption