Package com.github.jasminb.jsonapi

Class SerializationSettings.Builder

java.lang.Object

com.github.jasminb.jsonapi.SerializationSettings.Builder

Enclosing class:

SerializationSettings

public static class SerializationSettings.Builder
extends Object

Serialisation settings builder.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SerializationSettings	build()	Create new SerialisationSettings instance.
SerializationSettings.Builder	excludedRelationships(String relationshipName)	Explicitly disable relationship serialisation.
SerializationSettings.Builder	includeRelationship(String relationshipName)	Explicitly enable relationship serialisation.
SerializationSettings.Builder	serializeId(Boolean flag)	Enable or disable id serialization.
SerializationSettings.Builder	serializeJSONAPIObject(Boolean flag)	Enable or disable JSON API object serialization.
SerializationSettings.Builder	serializeLinks(Boolean flag)	Enable or disable links serialization.
SerializationSettings.Builder	serializeMeta(Boolean flag)	Enable or disable meta serialization.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

includeRelationship

public SerializationSettings.Builder includeRelationship(String relationshipName)

Explicitly enable relationship serialisation.

Parameters:

relationshipName - String relationship name

Returns:

SerializationSettings.Builder

excludedRelationships

public SerializationSettings.Builder excludedRelationships(String relationshipName)

Explicitly disable relationship serialisation.

Parameters:

relationshipName - String relationship name

Returns:

SerializationSettings.Builder

serializeMeta

public SerializationSettings.Builder serializeMeta(Boolean flag)

Enable or disable meta serialization.

Parameters:

flag - Boolean serialization flag

Returns:

SerializationSettings.Builder

serializeLinks

public SerializationSettings.Builder serializeLinks(Boolean flag)

Enable or disable links serialization.

Parameters:

flag - Boolean serialization flag

Returns:

SerializationSettings.Builder

serializeId

public SerializationSettings.Builder serializeId(Boolean flag)

Enable or disable id serialization.

Parameters:

flag - Boolean serialization flag

Returns:

SerializationSettings.Builder

serializeJSONAPIObject

public SerializationSettings.Builder serializeJSONAPIObject(Boolean flag)

Enable or disable JSON API object serialization.

Parameters:

flag - Boolean serialization flag

Returns:

SerializationSettings.Builder

build

public SerializationSettings build()

Create new SerialisationSettings instance.

Returns:

SerializationSettings