Package org.apache.juneau.bean.jsonapi

Class JsonApiLinkOrStringSwap

java.lang.Object

org.apache.juneau.marshall.swap.spi.ObjectSwap<Object,Object>

org.apache.juneau.bean.jsonapi.JsonApiLinkOrStringSwap

public class JsonApiLinkOrStringSwap
extends ObjectSwap<Object,Object>

Per-property ObjectSwap applied to JSON:API links maps so that each map entry round-trips as either a JSON string URL or a JsonApiLink JSON object per the spec.

The swap operates on the whole Map<String,Object> bean property and walks the entries:

• On serialize (swap(org.apache.juneau.marshall.MarshallingSession, java.lang.Object)): identity - String values and JsonApiLink values serialize directly as JSON strings and JSON objects respectively.
• On parse (unswap(org.apache.juneau.marshall.MarshallingSession, java.lang.Object, org.apache.juneau.marshall.ClassMeta<?>)): each value that came back as a parsed map (i.e. originally a JSON object) is converted to a JsonApiLink; all other values pass through unchanged.
• null input ⇒ null output.

Field Summary

Fields inherited from class org.apache.juneau.marshall.swap.spi.ObjectSwap

NULL

Constructor Summary

Constructors

Constructor	Description
JsonApiLinkOrStringSwap()

Method Summary

Modifier and Type	Method	Description
Object	swap(MarshallingSession session, Object o)	If this transform is to be used to serialize non-serializable objects, it must implement this method.
Object	unswap(MarshallingSession session, Object o, ClassMeta<?> hint)	If this transform is to be used to reconstitute objects that aren't true Java beans, it must implement this method.

Methods inherited from class org.apache.juneau.marshall.swap.spi.ObjectSwap

forMediaTypes, forMediaTypes, getNormalClass, getSwapClass, getSwapClassMeta, isNormalObject, isSwappedObject, match, swap, toString, unswap, withTemplate, withTemplate

Methods inherited from class java.lang.Object

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

Constructor Details

JsonApiLinkOrStringSwap

public JsonApiLinkOrStringSwap()

Method Details

swap

public Object swap(MarshallingSession session,
 Object o)
            throws SerializeException

Description copied from class: ObjectSwap

If this transform is to be used to serialize non-serializable objects, it must implement this method.

The object must be converted into one of the following serializable types:

• String
• Number
• Boolean
• Collection containing anything on this list.
• Map containing anything on this list.
• A java bean with properties of anything on this list.
• An array of anything on this list.

Overrides:

swap in class ObjectSwap<Object,Object>

Parameters:

session - The bean session to use to get the class meta. This is always going to be the same bean context that created this swap.

o - The object to be transformed.

Returns:

The transformed object.

Throws:

SerializeException

unswap

public Object unswap(MarshallingSession session,
 Object o,
 ClassMeta<?> hint)
              throws ParseException

Description copied from class: ObjectSwap

If this transform is to be used to reconstitute objects that aren't true Java beans, it must implement this method.

Overrides:

unswap in class ObjectSwap<Object,Object>

Parameters:

session - The bean session to use to get the class meta. This is always going to be the same bean context that created this swap.

o - The transformed object.

hint - If possible, the parser will try to tell you the object type being created. For example, on a serialized date, this may tell you that the object being created must be of type GregorianCalendar.
This may be null if the parser cannot make this determination.

Returns:

The narrowed object.

Throws:

ParseException