Package org.apache.juneau.swaps

Class StringFormatSwap

java.lang.Object

org.apache.juneau.swap.ObjectSwap<T,String>

org.apache.juneau.swap.StringSwap<Object>

org.apache.juneau.swaps.StringFormatSwap

public class StringFormatSwap
extends StringSwap<Object>

Built-in object swap implementation class for the @Beanp(format) annotation.

See Also:

• Swap Basics

Field Summary

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

NULL

Constructor Summary

Constructors

Constructor	Description
StringFormatSwap(String format)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	swap(BeanSession session, Object o)	If this transform is to be used to serialize non-serializable objects, it must implement this method.
Object	unswap(BeanSession session, String f, 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.swap.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

StringFormatSwap

public StringFormatSwap(String format)

Constructor.

Parameters:

format - The string format string.

Method Details

swap

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

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

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

unswap

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

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 StringSwap<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.

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.