HalParser (edison-hal 2.1.0 API)

java.lang.Object
- de.otto.edison.hal.HalParser

```
public final class HalParser
extends java.lang.Object
```
A parser used to parse application/hal+json representations of REST resources into Java objects.

Simple HAL representations can be parsed using Jackson's ObjectMapper like this:
```
     new ObjectMapper().readValue(json.getBytes(), MyHalRepresentation.class)
 
```
The same can be achieved by using a HalParser:
```
     final MyHalRepresentation result = HalParser.parse(json).as(MyHalRepresentation.class);
 
```
However, if the representation contains embedded items, Jackson is unable to determine the Java type of the embedded items, because the HAL document itself does not contain type information. In this case, Jackson needs some help to identify the concrete types of embedded items. Using the HalParser, this is accomplished like this:
```
     final FooHalRepresentation result = HalParser
             .parse(json)
             .as(FooHalRepresentation.class, withEmbedded("bar", BarHalRepresentation.class));
 
```
Since:

0.1.0

Field Summary

Fields
Modifier and Type	Field and Description
`static com.fasterxml.jackson.databind.ObjectMapper`	`DEFAULT_JSON_MAPPER` The Jackson ObjectMapper that is used to parse application/hal+json documents if not other instance is specified explicitly.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends HalRepresentation> T`	`as(java.lang.Class<T> type)` Specify the type that is used to parse and map the json.
`<T extends HalRepresentation> T`	`as(java.lang.Class<T> type, EmbeddedTypeInfo typeInfo, EmbeddedTypeInfo... moreTypeInfo)` Parse embedded items of a given link-relation type not as HalRepresentation, but as a sub-type of HalRepresentation, so extra attributes of the embedded items can be accessed.
`<T extends HalRepresentation> T`	`as(java.lang.Class<T> type, java.util.List<EmbeddedTypeInfo> typeInfo)` Parse embedded items of a given link-relation type not as HalRepresentation, but as a sub-type of HalRepresentation, so extra attributes of the embedded items can be accessed.
`static HalParser`	`parse(java.lang.String json)` Create a new HalParser for a JSON document.
`static HalParser`	`parse(java.lang.String json, com.fasterxml.jackson.databind.ObjectMapper objectMapper)` Create a new HalParser for a JSON document.

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

- Field Detail
  - DEFAULT_JSON_MAPPER
```
public static final com.fasterxml.jackson.databind.ObjectMapper DEFAULT_JSON_MAPPER
```
    The Jackson ObjectMapper that is used to parse application/hal+json documents if not other instance is specified explicitly.
    The mapper will find and register all available Jackson modules and configure the mapper to accept single values as arrays.
- Method Detail
  - parse
```
public static HalParser parse(java.lang.String json)
```
    Create a new HalParser for a JSON document.
    The DEFAULT_JSON_MAPPER is used to parse documents.
    
    Parameters:
    
    json - the application/hal+json document to be parsed.
    
    Returns:
    
    HalParser instance.
    
    Since:
    
    0.1.0
  - parse
```
public static HalParser parse(java.lang.String json,
                              com.fasterxml.jackson.databind.ObjectMapper objectMapper)
```
    Create a new HalParser for a JSON document.
    The specified objectMapper is used to parse documents. If not already configured appropriately, the objectMapper is copied and configured to accept single values as arrays.
    
    Parameters:
    
    json - the application/hal+json document to be parsed.
    
    objectMapper - the ObjectMapper instance used to parse documents.
    
    Returns:
    
    HalParser instance.
    
    Since:
    
    2.0.0
  - as
```
public <T extends HalRepresentation> T as(java.lang.Class<T> type)
                                   throws java.io.IOException
```
    Specify the type that is used to parse and map the json.
    
    Type Parameters:
    
    T - the type of the class, extending HalRepresentation
    
    Parameters:
    
    type - the java type used to parse the JSON
    
    Returns:
    
    instance of T, containing the data of the parsed HAL document.
    
    Throws:
    
    java.io.IOException - if a low-level I/O problem (unexpected end-of-input, network error) occurs.
    
    com.fasterxml.jackson.core.JsonParseException - if the json document can not be parsed by Jackson's ObjectMapper
    
    com.fasterxml.jackson.databind.JsonMappingException - if the input JSON structure can not be mapped to the specified HalRepresentation type
    
    Since:
    
    0.1.0
  - as
```
public <T extends HalRepresentation> T as(java.lang.Class<T> type,
                                          EmbeddedTypeInfo typeInfo,
                                          EmbeddedTypeInfo... moreTypeInfo)
                                   throws java.io.IOException
```
    Parse embedded items of a given link-relation type not as HalRepresentation, but as a sub-type of HalRepresentation, so extra attributes of the embedded items can be accessed.
    
    Type Parameters:
    
    T - The type used to parse the HAL document
    
    Parameters:
    
    type - the Java class used to map JSON to.
    
    typeInfo - type information of the embedded items.
    
    moreTypeInfo - more type information of embedded items.
    
    Returns:
    
    T
    
    Throws:
    
    java.io.IOException - if a low-level I/O problem (unexpected end-of-input, network error) occurs.
    
    com.fasterxml.jackson.core.JsonParseException - if the json document can not be parsed by Jackson's ObjectMapper
    
    com.fasterxml.jackson.databind.JsonMappingException - if the input JSON structure can not be mapped to the specified HalRepresentation type
    
    Since:
    
    0.1.0
  - as
```
public <T extends HalRepresentation> T as(java.lang.Class<T> type,
                                          java.util.List<EmbeddedTypeInfo> typeInfo)
                                   throws java.io.IOException
```
    Parse embedded items of a given link-relation type not as HalRepresentation, but as a sub-type of HalRepresentation, so extra attributes of the embedded items can be accessed.
    
    Type Parameters:
    
    T - The type used to parse the HAL document
    
    Parameters:
    
    type - the Java class used to map JSON to.
    
    typeInfo - type information of the embedded items.
    
    Returns:
    
    T
    
    Throws:
    
    java.io.IOException - if a low-level I/O problem (unexpected end-of-input, network error) occurs.
    
    com.fasterxml.jackson.core.JsonParseException - if the json document can not be parsed by Jackson's ObjectMapper
    
    com.fasterxml.jackson.databind.JsonMappingException - if the input JSON structure can not be mapped to the specified HalRepresentation type
    
    Since:
    
    0.1.0

Class HalParser

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_JSON_MAPPER

Method Detail

parse

parse

as

as

as