org.apache.juneau.transform

Class StringSwap<T>

java.lang.Object

org.apache.juneau.transform.PojoSwap<T,String>

org.apache.juneau.transform.StringSwap<T>

Type Parameters:

T - The normal form of the class.

Direct Known Subclasses:

BeanStringSwap, ByteArrayBase64Swap, ByteArraySwap, CalendarSwap, ClassSwap, DateSwap, InputStreamSwap, LocaleSwap, ReaderSwap, StringFormatSwap, TemporalCalendarSwap, TemporalDateSwap, TemporalSwap, TimeZoneSwap, XMLGregorianCalendarSwap, ZoneIdSwap

public abstract class StringSwap<T>
extends PojoSwap<T,String>

Abstract subclass for POJO swaps that swap objects for strings.

Example:

// A swap that converts byte arrays to BASE64-encoded strings. public class ByteArrayBase64Swap extends StringSwap<byte[]> { @Override public String swap(BeanSession session, byte[] b) throws Exception { return StringUtils.base64Encode(b); } @Override public byte[] unswap(BeanSession session, String s, ClassMeta<?> hint) throws Exception { return StringUtils.base64Decode(s); } } // Use it to serialize a byte array. WriterSerializer s = JsonSerializer.create().simple().pojoSwaps(ByteArrayBase64Swap.class).build(); String json = s.serialize(new byte[] {1,2,3}); // Produces "'AQID'"

Field Summary

Fields inherited from class org.apache.juneau.transform.PojoSwap

NULL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StringSwap() Constructor.
protected	StringSwap(Class<T> normalClass) Constructor for when the normal and transformed classes are already known.

Method Summary

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

Methods inherited from class org.apache.juneau.transform.PojoSwap

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 Detail

StringSwap

protected StringSwap()

Constructor.

StringSwap

protected StringSwap(Class<T> normalClass)

Constructor for when the normal and transformed classes are already known.

Parameters:

normalClass - The normal class (cannot be serialized).

Method Detail

swap

public String swap(BeanSession session,
                   T o)
            throws Exception

Description copied from class: PojoSwap

If this transform is to be used to serialize non-serializable POJOs, 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 PojoSwap<T,String>

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:

Exception - If a problem occurred trying to convert the output.

unswap

public T unswap(BeanSession session,
                String f,
                ClassMeta<?> hint)
         throws Exception

Description copied from class: PojoSwap

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

Overrides:

unswap in class PojoSwap<T,String>

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.

f - 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:

Exception - If this method is not implemented.