SerializationSettings (JSONAPI Converter 0.13 API)

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

public class SerializationSettings
extends Object

Serialization settings.

Author:: jbegic

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SerializationSettings.Builder
Serialisation settings builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`hasIncludedRelationships()`	Returns `true` in case there is at least one relationship that should be included during serialization.
`boolean`	`isRelationshipExcluded(String relationshipName)`	Checks if relationship with provided name has been explicitly marked for exclusion in serialized object.
`boolean`	`isRelationshipIncluded(String relationshipName)`	Checks if relationship with provided name has been explicitly marked for inclusion in serialized object.
`Boolean`	`serializeId()`	Returns `Id` serialization flag.
`Boolean`	`serializeJSONAPIObject()`	Returns JSON API object serialization flag.
`Boolean`	`serializeLinks()`	Returns links serialization flag.
`Boolean`	`serializeMeta()`	Returns meta serialization flag.

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

- Method Detail
  - isRelationshipIncluded
```
public boolean isRelationshipIncluded(String relationshipName)
```
    Checks if relationship with provided name has been explicitly marked for inclusion in serialized object.
    
    Parameters:
    
    relationshipName - String relationship name
    
    Returns:
    
    Boolean
  - isRelationshipExcluded
```
public boolean isRelationshipExcluded(String relationshipName)
```
    Checks if relationship with provided name has been explicitly marked for exclusion in serialized object.
    
    Parameters:
    
    relationshipName - String relationship name
    
    Returns:
    
    Boolean
  - hasIncludedRelationships
```
public boolean hasIncludedRelationships()
```
    Returns true in case there is at least one relationship that should be included during serialization.
    
    Returns:
    
    Boolean
  - serializeMeta
```
public Boolean serializeMeta()
```
    Returns meta serialization flag.
    
    Returns:
    
    Boolean
  - serializeLinks
```
public Boolean serializeLinks()
```
    Returns links serialization flag.
    
    Returns:
    
    Boolean
  - serializeId
```
public Boolean serializeId()
```
    Returns Id serialization flag.
    
    Returns:
    
    Boolean
  - serializeJSONAPIObject
```
public Boolean serializeJSONAPIObject()
```
    Returns JSON API object serialization flag.
    
    Returns:
    
    Boolean