http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/62afb533/content/site/apidocs/src-html/org/apache/juneau/transform/PojoSwap.html
----------------------------------------------------------------------
diff --git
a/content/site/apidocs/src-html/org/apache/juneau/transform/PojoSwap.html
b/content/site/apidocs/src-html/org/apache/juneau/transform/PojoSwap.html
index ccac44c..2c886f5 100644
--- a/content/site/apidocs/src-html/org/apache/juneau/transform/PojoSwap.html
+++ b/content/site/apidocs/src-html/org/apache/juneau/transform/PojoSwap.html
@@ -25,264 +25,601 @@
<span class="sourceLineNo">017</span>import java.util.*;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.juneau.*;<a
name="line.19"></a>
-<span class="sourceLineNo">020</span>import org.apache.juneau.parser.*;<a
name="line.20"></a>
-<span class="sourceLineNo">021</span>import org.apache.juneau.serializer.*;<a
name="line.21"></a>
-<span class="sourceLineNo">022</span><a name="line.22"></a>
-<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
-<span class="sourceLineNo">024</span> * Used to swap out non-serializable
objects with serializable replacements during serialization, and vis-versa
during parsing.<a name="line.24"></a>
-<span class="sourceLineNo">025</span> *<a name="line.25"></a>
-<span class="sourceLineNo">026</span> * <h5
class='section'>Description:</h5><a name="line.26"></a>
-<span class="sourceLineNo">027</span> *<a name="line.27"></a>
-<span class="sourceLineNo">028</span> * <code>PojoSwaps</code> are
used to extend the functionality of the serializers and parsers to be able to
handle<a name="line.28"></a>
-<span class="sourceLineNo">029</span> * POJOs that aren't automatically
handled by the serializers or parsers. For example, JSON does not have a
standard<a name="line.29"></a>
-<span class="sourceLineNo">030</span> * representation for rendering dates.<a
name="line.30"></a>
-<span class="sourceLineNo">031</span> * By defining a special {@code Date}
swap and associating it with a serializer and parser, you can convert a<a
name="line.31"></a>
-<span class="sourceLineNo">032</span> * {@code Date} object to a {@code
String} during serialization, and convert that {@code String} object back into
a<a name="line.32"></a>
-<span class="sourceLineNo">033</span> * {@code Date} object during parsing.<a
name="line.33"></a>
-<span class="sourceLineNo">034</span> *<a name="line.34"></a>
-<span class="sourceLineNo">035</span> * <p><a name="line.35"></a>
-<span class="sourceLineNo">036</span> * Swaps MUST declare a public no-arg
constructor so that the bean context can instantiate them.<a name="line.36"></a>
-<span class="sourceLineNo">037</span> *<a name="line.37"></a>
-<span class="sourceLineNo">038</span> * <p><a name="line.38"></a>
-<span class="sourceLineNo">039</span> * <code>PojoSwaps</code> are
associated with instances of {@link BeanContext BeanContexts} by passing the
swap<a name="line.39"></a>
-<span class="sourceLineNo">040</span> * class to the {@link
CoreObjectBuilder#pojoSwaps(Class...)} method.<a name="line.40"></a>
-<span class="sourceLineNo">041</span> * <br>When associated with a bean
context, fields of the specified type will automatically be converted when
the<a name="line.41"></a>
-<span class="sourceLineNo">042</span> * {@link BeanMap#get(Object)} or {@link
BeanMap#put(String, Object)} methods are called.<a name="line.42"></a>
-<span class="sourceLineNo">043</span> *<a name="line.43"></a>
-<span class="sourceLineNo">044</span> * <p><a name="line.44"></a>
-<span class="sourceLineNo">045</span> * <code>PojoSwaps</code>
have two parameters:<a name="line.45"></a>
-<span class="sourceLineNo">046</span> * <ol><a name="line.46"></a>
-<span class="sourceLineNo">047</span> * <li>{@code <T>} - The
normal representation of an object.<a name="line.47"></a>
-<span class="sourceLineNo">048</span> * <li>{@code <S>} - The
swapped representation of an object.<a name="line.48"></a>
-<span class="sourceLineNo">049</span> * </ol><a name="line.49"></a>
-<span class="sourceLineNo">050</span> * <br>{@link Serializer
Serializers} use swaps to convert objects of type T into objects of type S, and
on calls to<a name="line.50"></a>
-<span class="sourceLineNo">051</span> * {@link BeanMap#get(Object)}.<a
name="line.51"></a>
-<span class="sourceLineNo">052</span> * <br>{@link Parser Parsers} use
swaps to convert objects of type S into objects of type T, and on calls to<a
name="line.52"></a>
-<span class="sourceLineNo">053</span> * {@link BeanMap#put(String,Object)}.<a
name="line.53"></a>
-<span class="sourceLineNo">054</span> *<a name="line.54"></a>
-<span class="sourceLineNo">055</span> * <h6
class='topic'>Subtypes</h6><a name="line.55"></a>
-<span class="sourceLineNo">056</span> *<a name="line.56"></a>
-<span class="sourceLineNo">057</span> * The following abstract subclasses are
provided for common swap types:<a name="line.57"></a>
-<span class="sourceLineNo">058</span> * <ol><a name="line.58"></a>
-<span class="sourceLineNo">059</span> * <li>{@link StringSwap} -
Objects swapped with strings.<a name="line.59"></a>
-<span class="sourceLineNo">060</span> * <li>{@link MapSwap} - Objects
swapped with {@link ObjectMap ObjectMaps}.<a name="line.60"></a>
-<span class="sourceLineNo">061</span> * </ol><a name="line.61"></a>
+<span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a
name="line.20"></a>
+<span class="sourceLineNo">021</span>import org.apache.juneau.http.*;<a
name="line.21"></a>
+<span class="sourceLineNo">022</span>import org.apache.juneau.parser.*;<a
name="line.22"></a>
+<span class="sourceLineNo">023</span>import org.apache.juneau.serializer.*;<a
name="line.23"></a>
+<span class="sourceLineNo">024</span><a name="line.24"></a>
+<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
+<span class="sourceLineNo">026</span> * Used to swap out non-serializable
objects with serializable replacements during serialization, and vis-versa
during<a name="line.26"></a>
+<span class="sourceLineNo">027</span> * parsing.<a name="line.27"></a>
+<span class="sourceLineNo">028</span> *<a name="line.28"></a>
+<span class="sourceLineNo">029</span> *<a name="line.29"></a>
+<span class="sourceLineNo">030</span> * <h6
class='section'>Description:</h6><a name="line.30"></a>
+<span class="sourceLineNo">031</span> *<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * <p><a name="line.32"></a>
+<span class="sourceLineNo">033</span> * <code>PojoSwaps</code> are
used to extend the functionality of the serializers and parsers to be able to
handle<a name="line.33"></a>
+<span class="sourceLineNo">034</span> * POJOs that aren't automatically
handled by the serializers or parsers.<a name="line.34"></a>
+<span class="sourceLineNo">035</span> * <br>For example, JSON does not
have a standard representation for rendering dates.<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * By defining a special {@code Date}
swap and associating it with a serializer and parser, you can convert a<a
name="line.36"></a>
+<span class="sourceLineNo">037</span> * {@code Date} object to a {@code
String} during serialization, and convert that {@code String} object back into
a<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * {@code Date} object during parsing.<a
name="line.38"></a>
+<span class="sourceLineNo">039</span> *<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * <p><a name="line.40"></a>
+<span class="sourceLineNo">041</span> * Swaps MUST declare a public no-arg
constructor so that the bean context can instantiate them.<a name="line.41"></a>
+<span class="sourceLineNo">042</span> *<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * <p><a name="line.43"></a>
+<span class="sourceLineNo">044</span> * <code>PojoSwaps</code> are
associated with instances of {@link BeanContext BeanContexts} by passing the
swap<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * class to the {@link
SerializerBuilder#pojoSwaps(Class...)} and {@link
ParserBuilder#pojoSwaps(Class...)} methods.<a name="line.45"></a>
+<span class="sourceLineNo">046</span> * <br>When associated with a bean
context, fields of the specified type will automatically be converted when
the<a name="line.46"></a>
+<span class="sourceLineNo">047</span> * {@link BeanMap#get(Object)} or {@link
BeanMap#put(String, Object)} methods are called.<a name="line.47"></a>
+<span class="sourceLineNo">048</span> *<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * <p><a name="line.49"></a>
+<span class="sourceLineNo">050</span> * <code>PojoSwaps</code>
have two parameters:<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * <ol><a name="line.51"></a>
+<span class="sourceLineNo">052</span> * <li>{@code <T>} - The
normal representation of an object.<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * <li>{@code <S>} - The
swapped representation of an object.<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * </ol><a name="line.54"></a>
+<span class="sourceLineNo">055</span> * <br>{@link Serializer
Serializers} use swaps to convert objects of type T into objects of type S, and
on calls to<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * {@link BeanMap#get(Object)}.<a
name="line.56"></a>
+<span class="sourceLineNo">057</span> * <br>{@link Parser Parsers} use
swaps to convert objects of type S into objects of type T, and on calls to<a
name="line.57"></a>
+<span class="sourceLineNo">058</span> * {@link BeanMap#put(String,Object)}.<a
name="line.58"></a>
+<span class="sourceLineNo">059</span> *<a name="line.59"></a>
+<span class="sourceLineNo">060</span> *<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * <h6
class='topic'>Subtypes</h6><a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
-<span class="sourceLineNo">063</span> * <h6
class='topic'>Localization</h6><a name="line.63"></a>
-<span class="sourceLineNo">064</span> *<a name="line.64"></a>
-<span class="sourceLineNo">065</span> * Swaps have access to the session
locale and timezone through the {@link BeanSession#getLocale()} and<a
name="line.65"></a>
-<span class="sourceLineNo">066</span> * {@link BeanSession#getTimeZone()}
methods.<a name="line.66"></a>
-<span class="sourceLineNo">067</span> * This allows you to specify localized
swap values when needed.<a name="line.67"></a>
-<span class="sourceLineNo">068</span> * If using the REST server API, the
locale and timezone are set based on the
<code>Accept-Language</code> and<a name="line.68"></a>
-<span class="sourceLineNo">069</span> * <code>Time-Zone</code>
headers on the request.<a name="line.69"></a>
-<span class="sourceLineNo">070</span> *<a name="line.70"></a>
-<span class="sourceLineNo">071</span> * <h6 class='topic'>Swap Class
Type {@code <S>}</h6><a name="line.71"></a>
-<span class="sourceLineNo">072</span> *<a name="line.72"></a>
-<span class="sourceLineNo">073</span> * The swapped object representation of
an object must be an object type that the serializers can natively convert to<a
name="line.73"></a>
-<span class="sourceLineNo">074</span> * JSON (or language-specific
equivalent).<a name="line.74"></a>
-<span class="sourceLineNo">075</span> * The list of valid transformed types
are as follows...<a name="line.75"></a>
-<span class="sourceLineNo">076</span> * <ul class='spaced-list'><a
name="line.76"></a>
-<span class="sourceLineNo">077</span> * <li><a name="line.77"></a>
-<span class="sourceLineNo">078</span> * {@link String}<a
name="line.78"></a>
-<span class="sourceLineNo">079</span> * <li><a name="line.79"></a>
-<span class="sourceLineNo">080</span> * {@link Number}<a
name="line.80"></a>
-<span class="sourceLineNo">081</span> * <li><a name="line.81"></a>
-<span class="sourceLineNo">082</span> * {@link Boolean}<a
name="line.82"></a>
-<span class="sourceLineNo">083</span> * <li><a name="line.83"></a>
-<span class="sourceLineNo">084</span> * {@link Collection} containing
anything on this list.<a name="line.84"></a>
-<span class="sourceLineNo">085</span> * <li><a name="line.85"></a>
-<span class="sourceLineNo">086</span> * {@link Map} containing anything
on this list.<a name="line.86"></a>
-<span class="sourceLineNo">087</span> * <li><a name="line.87"></a>
-<span class="sourceLineNo">088</span> * A java bean with properties of
anything on this list.<a name="line.88"></a>
-<span class="sourceLineNo">089</span> * <li><a name="line.89"></a>
-<span class="sourceLineNo">090</span> * An array of anything on this
list.<a name="line.90"></a>
-<span class="sourceLineNo">091</span> * </ul><a name="line.91"></a>
+<span class="sourceLineNo">063</span> * The following abstract subclasses are
provided for common swap types:<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * <ol><a name="line.64"></a>
+<span class="sourceLineNo">065</span> * <li>{@link StringSwap} -
Objects swapped with strings.<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * <li>{@link MapSwap} - Objects
swapped with {@link ObjectMap ObjectMaps}.<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * </ol><a name="line.67"></a>
+<span class="sourceLineNo">068</span> *<a name="line.68"></a>
+<span class="sourceLineNo">069</span> *<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * <h6 class='topic'>Swap Class
Type {@code <S>}</h6><a name="line.70"></a>
+<span class="sourceLineNo">071</span> *<a name="line.71"></a>
+<span class="sourceLineNo">072</span> * The swapped object representation of
an object must be an object type that the serializers can natively convert to<a
name="line.72"></a>
+<span class="sourceLineNo">073</span> * JSON (or language-specific
equivalent).<a name="line.73"></a>
+<span class="sourceLineNo">074</span> * The list of valid transformed types
are as follows...<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * <ul class='spaced-list'><a
name="line.75"></a>
+<span class="sourceLineNo">076</span> * <li><a name="line.76"></a>
+<span class="sourceLineNo">077</span> * {@link String}<a
name="line.77"></a>
+<span class="sourceLineNo">078</span> * <li><a name="line.78"></a>
+<span class="sourceLineNo">079</span> * {@link Number}<a
name="line.79"></a>
+<span class="sourceLineNo">080</span> * <li><a name="line.80"></a>
+<span class="sourceLineNo">081</span> * {@link Boolean}<a
name="line.81"></a>
+<span class="sourceLineNo">082</span> * <li><a name="line.82"></a>
+<span class="sourceLineNo">083</span> * {@link Collection} containing
anything on this list.<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * <li><a name="line.84"></a>
+<span class="sourceLineNo">085</span> * {@link Map} containing anything
on this list.<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * <li><a name="line.86"></a>
+<span class="sourceLineNo">087</span> * A java bean with properties of
anything on this list.<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * <li><a name="line.88"></a>
+<span class="sourceLineNo">089</span> * An array of anything on this
list.<a name="line.89"></a>
+<span class="sourceLineNo">090</span> * </ul><a name="line.90"></a>
+<span class="sourceLineNo">091</span> *<a name="line.91"></a>
<span class="sourceLineNo">092</span> *<a name="line.92"></a>
<span class="sourceLineNo">093</span> * <h6 class='topic'>Normal Class
Type {@code <T>}</h6><a name="line.93"></a>
<span class="sourceLineNo">094</span> *<a name="line.94"></a>
<span class="sourceLineNo">095</span> * The normal object representation of an
object.<a name="line.95"></a>
<span class="sourceLineNo">096</span> *<a name="line.96"></a>
-<span class="sourceLineNo">097</span> * <h6 class='topic'>One-way vs.
Two-way Serialization</h6><a name="line.97"></a>
-<span class="sourceLineNo">098</span> *<a name="line.98"></a>
-<span class="sourceLineNo">099</span> * Note that while there is a unified
interface for handling swaps during both serialization and parsing,<a
name="line.99"></a>
-<span class="sourceLineNo">100</span> * in many cases only one of the {@link
#swap(BeanSession, Object)} or {@link #unswap(BeanSession, Object,
ClassMeta)}<a name="line.100"></a>
-<span class="sourceLineNo">101</span> * methods will be defined because the
swap is one-way.<a name="line.101"></a>
-<span class="sourceLineNo">102</span> * For example, a swap may be defined to
convert an {@code Iterator} to a {@code ObjectList}, but<a name="line.102"></a>
-<span class="sourceLineNo">103</span> * it's not possible to unswap an {@code
Iterator}.<a name="line.103"></a>
-<span class="sourceLineNo">104</span> * In that case, the {@code swap(Object}}
method would be implemented, but the {@code unswap(ObjectMap)} object would<a
name="line.104"></a>
-<span class="sourceLineNo">105</span> * not, and the swap would be associated
on the serializer, but not the parser.<a name="line.105"></a>
-<span class="sourceLineNo">106</span> * Also, you may choose to serialize
objects like {@code Dates} to readable {@code Strings}, in which case it's
not<a name="line.106"></a>
-<span class="sourceLineNo">107</span> * possible to re-parse it back into a
{@code Date}, since there is no way for the {@code Parser} to know it's a<a
name="line.107"></a>
-<span class="sourceLineNo">108</span> * {@code Date} from just the JSON or XML
text.<a name="line.108"></a>
-<span class="sourceLineNo">109</span> *<a name="line.109"></a>
-<span class="sourceLineNo">110</span> * <h5 class='section'>Additional
information:</h5><a name="line.110"></a>
-<span class="sourceLineNo">111</span> *<a name="line.111"></a>
-<span class="sourceLineNo">112</span> * See <a class='doclink'
href='package-summary.html#TOC'>org.apache.juneau.transform</a> for
more information.<a name="line.112"></a>
-<span class="sourceLineNo">113</span> *<a name="line.113"></a>
-<span class="sourceLineNo">114</span> * @param <T> The normal form of
the class.<a name="line.114"></a>
-<span class="sourceLineNo">115</span> * @param <S> The swapped form of
the class.<a name="line.115"></a>
-<span class="sourceLineNo">116</span> */<a name="line.116"></a>
-<span class="sourceLineNo">117</span>public abstract class PojoSwap<T,S>
{<a name="line.117"></a>
-<span class="sourceLineNo">118</span><a name="line.118"></a>
-<span class="sourceLineNo">119</span> /**<a name="line.119"></a>
-<span class="sourceLineNo">120</span> * Represents a non-existent pojo
swap.<a name="line.120"></a>
-<span class="sourceLineNo">121</span> */<a name="line.121"></a>
-<span class="sourceLineNo">122</span> @SuppressWarnings({ "unchecked",
"rawtypes" })<a name="line.122"></a>
-<span class="sourceLineNo">123</span> public final static PojoSwap NULL =
new PojoSwap(null, null) {};<a name="line.123"></a>
-<span class="sourceLineNo">124</span><a name="line.124"></a>
-<span class="sourceLineNo">125</span> private final Class<T>
normalClass;<a name="line.125"></a>
-<span class="sourceLineNo">126</span> private final Class<?>
swapClass;<a name="line.126"></a>
-<span class="sourceLineNo">127</span> private ClassMeta<?>
swapClassMeta;<a name="line.127"></a>
-<span class="sourceLineNo">128</span><a name="line.128"></a>
-<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
-<span class="sourceLineNo">130</span> * Constructor.<a name="line.130"></a>
-<span class="sourceLineNo">131</span> */<a name="line.131"></a>
-<span class="sourceLineNo">132</span> @SuppressWarnings("unchecked")<a
name="line.132"></a>
-<span class="sourceLineNo">133</span> protected PojoSwap() {<a
name="line.133"></a>
-<span class="sourceLineNo">134</span> normalClass =
(Class<T>)resolveParameterType(PojoSwap.class, 0, this.getClass());<a
name="line.134"></a>
-<span class="sourceLineNo">135</span> swapClass =
resolveParameterType(PojoSwap.class, 1, this.getClass());<a name="line.135"></a>
-<span class="sourceLineNo">136</span> }<a name="line.136"></a>
-<span class="sourceLineNo">137</span><a name="line.137"></a>
-<span class="sourceLineNo">138</span> /**<a name="line.138"></a>
-<span class="sourceLineNo">139</span> * Constructor for when the normal and
transformed classes are already known.<a name="line.139"></a>
-<span class="sourceLineNo">140</span> *<a name="line.140"></a>
-<span class="sourceLineNo">141</span> * @param normalClass The normal class
(cannot be serialized).<a name="line.141"></a>
-<span class="sourceLineNo">142</span> * @param swapClass The transformed
class (serializable).<a name="line.142"></a>
-<span class="sourceLineNo">143</span> */<a name="line.143"></a>
-<span class="sourceLineNo">144</span> protected PojoSwap(Class<T>
normalClass, Class<?> swapClass) {<a name="line.144"></a>
-<span class="sourceLineNo">145</span> this.normalClass = normalClass;<a
name="line.145"></a>
-<span class="sourceLineNo">146</span> this.swapClass = swapClass;<a
name="line.146"></a>
-<span class="sourceLineNo">147</span> }<a name="line.147"></a>
-<span class="sourceLineNo">148</span><a name="line.148"></a>
-<span class="sourceLineNo">149</span> /**<a name="line.149"></a>
-<span class="sourceLineNo">150</span> * If this transform is to be used to
serialize non-serializable POJOs, it must implement this method.<a
name="line.150"></a>
-<span class="sourceLineNo">151</span> *<a name="line.151"></a>
-<span class="sourceLineNo">152</span> * <p><a name="line.152"></a>
-<span class="sourceLineNo">153</span> * The object must be converted into
one of the following serializable types:<a name="line.153"></a>
-<span class="sourceLineNo">154</span> * <ul class='spaced-list'><a
name="line.154"></a>
-<span class="sourceLineNo">155</span> * <li><a name="line.155"></a>
-<span class="sourceLineNo">156</span> * {@link String}<a
name="line.156"></a>
-<span class="sourceLineNo">157</span> * <li><a name="line.157"></a>
-<span class="sourceLineNo">158</span> * {@link Number}<a
name="line.158"></a>
-<span class="sourceLineNo">159</span> * <li><a name="line.159"></a>
-<span class="sourceLineNo">160</span> * {@link Boolean}<a
name="line.160"></a>
-<span class="sourceLineNo">161</span> * <li><a name="line.161"></a>
-<span class="sourceLineNo">162</span> * {@link Collection} containing
anything on this list.<a name="line.162"></a>
-<span class="sourceLineNo">163</span> * <li><a name="line.163"></a>
-<span class="sourceLineNo">164</span> * {@link Map} containing
anything on this list.<a name="line.164"></a>
-<span class="sourceLineNo">165</span> * <li><a name="line.165"></a>
-<span class="sourceLineNo">166</span> * A java bean with properties
of anything on this list.<a name="line.166"></a>
-<span class="sourceLineNo">167</span> * <li><a name="line.167"></a>
-<span class="sourceLineNo">168</span> * An array of anything on this
list.<a name="line.168"></a>
-<span class="sourceLineNo">169</span> * </ul><a name="line.169"></a>
-<span class="sourceLineNo">170</span> *<a name="line.170"></a>
-<span class="sourceLineNo">171</span> * @param session<a
name="line.171"></a>
-<span class="sourceLineNo">172</span> * The bean session to use to get
the class meta.<a name="line.172"></a>
-<span class="sourceLineNo">173</span> * This is always going to be the
same bean context that created this swap.<a name="line.173"></a>
-<span class="sourceLineNo">174</span> * @param o The object to be
transformed.<a name="line.174"></a>
-<span class="sourceLineNo">175</span> * @return The transformed object.<a
name="line.175"></a>
-<span class="sourceLineNo">176</span> * @throws Exception If a problem
occurred trying to convert the output.<a name="line.176"></a>
-<span class="sourceLineNo">177</span> */<a name="line.177"></a>
-<span class="sourceLineNo">178</span> public S swap(BeanSession session, T
o) throws Exception {<a name="line.178"></a>
-<span class="sourceLineNo">179</span> throw new SerializeException("Swap
method not implemented on PojoSwap ''{0}''", this.getClass().getName());<a
name="line.179"></a>
-<span class="sourceLineNo">180</span> }<a name="line.180"></a>
-<span class="sourceLineNo">181</span><a name="line.181"></a>
-<span class="sourceLineNo">182</span> /**<a name="line.182"></a>
-<span class="sourceLineNo">183</span> * If this transform is to be used to
reconstitute POJOs that aren't true Java beans, it must implement this
method.<a name="line.183"></a>
-<span class="sourceLineNo">184</span> *<a name="line.184"></a>
-<span class="sourceLineNo">185</span> * @param session<a
name="line.185"></a>
-<span class="sourceLineNo">186</span> * The bean session to use to get
the class meta.<a name="line.186"></a>
-<span class="sourceLineNo">187</span> * This is always going to be the
same bean context that created this swap.<a name="line.187"></a>
-<span class="sourceLineNo">188</span> * @param f The transformed object.<a
name="line.188"></a>
-<span class="sourceLineNo">189</span> * @param hint<a name="line.189"></a>
-<span class="sourceLineNo">190</span> * If possible, the parser will try
to tell you the object type being created.<a name="line.190"></a>
-<span class="sourceLineNo">191</span> * For example, on a serialized
date, this may tell you that the object being created must be of type<a
name="line.191"></a>
-<span class="sourceLineNo">192</span> * {@code GregorianCalendar}.<a
name="line.192"></a>
-<span class="sourceLineNo">193</span> * <br>This may be
<jk>null</jk> if the parser cannot make this determination.<a
name="line.193"></a>
-<span class="sourceLineNo">194</span> * @return The narrowed object.<a
name="line.194"></a>
-<span class="sourceLineNo">195</span> * @throws Exception If this method is
not implemented.<a name="line.195"></a>
-<span class="sourceLineNo">196</span> */<a name="line.196"></a>
-<span class="sourceLineNo">197</span> public T unswap(BeanSession session, S
f, ClassMeta<?> hint) throws Exception {<a name="line.197"></a>
-<span class="sourceLineNo">198</span> throw new ParseException("Unswap
method not implemented on PojoSwap ''{0}''", this.getClass().getName());<a
name="line.198"></a>
-<span class="sourceLineNo">199</span> }<a name="line.199"></a>
-<span class="sourceLineNo">200</span><a name="line.200"></a>
-<span class="sourceLineNo">201</span> /**<a name="line.201"></a>
-<span class="sourceLineNo">202</span> * Returns the T class, the normalized
form of the class.<a name="line.202"></a>
-<span class="sourceLineNo">203</span> *<a name="line.203"></a>
-<span class="sourceLineNo">204</span> * @return The normal form of this
class.<a name="line.204"></a>
-<span class="sourceLineNo">205</span> */<a name="line.205"></a>
-<span class="sourceLineNo">206</span> public Class<T> getNormalClass()
{<a name="line.206"></a>
-<span class="sourceLineNo">207</span> return normalClass;<a
name="line.207"></a>
-<span class="sourceLineNo">208</span> }<a name="line.208"></a>
-<span class="sourceLineNo">209</span><a name="line.209"></a>
-<span class="sourceLineNo">210</span> /**<a name="line.210"></a>
-<span class="sourceLineNo">211</span> * Returns the G class, the
generalized form of the class.<a name="line.211"></a>
-<span class="sourceLineNo">212</span> *<a name="line.212"></a>
-<span class="sourceLineNo">213</span> * <p><a name="line.213"></a>
-<span class="sourceLineNo">214</span> * Subclasses must override this
method if the generalized class is {@code Object}, meaning it can produce
multiple<a name="line.214"></a>
-<span class="sourceLineNo">215</span> * generalized forms.<a
name="line.215"></a>
-<span class="sourceLineNo">216</span> *<a name="line.216"></a>
-<span class="sourceLineNo">217</span> * @return The transformed form of
this class.<a name="line.217"></a>
-<span class="sourceLineNo">218</span> */<a name="line.218"></a>
-<span class="sourceLineNo">219</span> public Class<?> getSwapClass()
{<a name="line.219"></a>
-<span class="sourceLineNo">220</span> return swapClass;<a
name="line.220"></a>
-<span class="sourceLineNo">221</span> }<a name="line.221"></a>
-<span class="sourceLineNo">222</span><a name="line.222"></a>
-<span class="sourceLineNo">223</span> /**<a name="line.223"></a>
-<span class="sourceLineNo">224</span> * Returns the {@link ClassMeta} of
the transformed class type.<a name="line.224"></a>
-<span class="sourceLineNo">225</span> *<a name="line.225"></a>
-<span class="sourceLineNo">226</span> * <p><a name="line.226"></a>
-<span class="sourceLineNo">227</span> * This value is cached for quick
lookup.<a name="line.227"></a>
-<span class="sourceLineNo">228</span> *<a name="line.228"></a>
-<span class="sourceLineNo">229</span> * @param beanContext<a
name="line.229"></a>
-<span class="sourceLineNo">230</span> * The bean context to use to get
the class meta.<a name="line.230"></a>
-<span class="sourceLineNo">231</span> * This is always going to be the
same bean context that created this swap.<a name="line.231"></a>
-<span class="sourceLineNo">232</span> * @return The {@link ClassMeta} of
the transformed class type.<a name="line.232"></a>
-<span class="sourceLineNo">233</span> */<a name="line.233"></a>
-<span class="sourceLineNo">234</span> public ClassMeta<?>
getSwapClassMeta(BeanContext beanContext) {<a name="line.234"></a>
-<span class="sourceLineNo">235</span> if (swapClassMeta == null)<a
name="line.235"></a>
-<span class="sourceLineNo">236</span> swapClassMeta =
beanContext.getClassMeta(swapClass);<a name="line.236"></a>
-<span class="sourceLineNo">237</span> return swapClassMeta;<a
name="line.237"></a>
-<span class="sourceLineNo">238</span> }<a name="line.238"></a>
-<span class="sourceLineNo">239</span><a name="line.239"></a>
-<span class="sourceLineNo">240</span> /**<a name="line.240"></a>
-<span class="sourceLineNo">241</span> * Checks if the specified object is
an instance of the normal class defined on this swap.<a name="line.241"></a>
-<span class="sourceLineNo">242</span> *<a name="line.242"></a>
-<span class="sourceLineNo">243</span> * @param o The object to check.<a
name="line.243"></a>
-<span class="sourceLineNo">244</span> * @return<a name="line.244"></a>
-<span class="sourceLineNo">245</span> * <jk>true</jk> if the
specified object is a subclass of the normal class defined on this transform.<a
name="line.245"></a>
-<span class="sourceLineNo">246</span> * <jk>null</jk> always
return <jk>false</jk>.<a name="line.246"></a>
-<span class="sourceLineNo">247</span> */<a name="line.247"></a>
-<span class="sourceLineNo">248</span> public boolean isNormalObject(Object
o) {<a name="line.248"></a>
-<span class="sourceLineNo">249</span> if (o == null)<a
name="line.249"></a>
-<span class="sourceLineNo">250</span> return false;<a
name="line.250"></a>
-<span class="sourceLineNo">251</span> return isParentClass(normalClass,
o.getClass());<a name="line.251"></a>
-<span class="sourceLineNo">252</span> }<a name="line.252"></a>
-<span class="sourceLineNo">253</span><a name="line.253"></a>
-<span class="sourceLineNo">254</span> /**<a name="line.254"></a>
-<span class="sourceLineNo">255</span> * Checks if the specified object is
an instance of the swap class defined on this swap.<a name="line.255"></a>
-<span class="sourceLineNo">256</span> *<a name="line.256"></a>
-<span class="sourceLineNo">257</span> * @param o The object to check.<a
name="line.257"></a>
-<span class="sourceLineNo">258</span> * @return<a name="line.258"></a>
-<span class="sourceLineNo">259</span> * <jk>true</jk> if the
specified object is a subclass of the transformed class defined on this
transform.<a name="line.259"></a>
-<span class="sourceLineNo">260</span> * <jk>null</jk> always
return <jk>false</jk>.<a name="line.260"></a>
-<span class="sourceLineNo">261</span> */<a name="line.261"></a>
-<span class="sourceLineNo">262</span> public boolean isSwappedObject(Object
o) {<a name="line.262"></a>
-<span class="sourceLineNo">263</span> if (o == null)<a
name="line.263"></a>
-<span class="sourceLineNo">264</span> return false;<a
name="line.264"></a>
-<span class="sourceLineNo">265</span> return isParentClass(swapClass,
o.getClass());<a name="line.265"></a>
-<span class="sourceLineNo">266</span> }<a name="line.266"></a>
-<span class="sourceLineNo">267</span><a name="line.267"></a>
-<span class="sourceLineNo">268</span><a name="line.268"></a>
-<span class="sourceLineNo">269</span>
//--------------------------------------------------------------------------------<a
name="line.269"></a>
-<span class="sourceLineNo">270</span> // Overridden methods<a
name="line.270"></a>
-<span class="sourceLineNo">271</span>
//--------------------------------------------------------------------------------<a
name="line.271"></a>
-<span class="sourceLineNo">272</span><a name="line.272"></a>
-<span class="sourceLineNo">273</span> @Override /* Object */<a
name="line.273"></a>
-<span class="sourceLineNo">274</span> public String toString() {<a
name="line.274"></a>
-<span class="sourceLineNo">275</span> return getClass().getSimpleName() +
'<' + getNormalClass().getSimpleName() + "," +
getSwapClass().getSimpleName() + '>';<a name="line.275"></a>
-<span class="sourceLineNo">276</span> }<a name="line.276"></a>
-<span class="sourceLineNo">277</span>}<a name="line.277"></a>
+<span class="sourceLineNo">097</span> *<a name="line.97"></a>
+<span class="sourceLineNo">098</span> * <h6
class='topic'>Overview</h6><a name="line.98"></a>
+<span class="sourceLineNo">099</span> *<a name="line.99"></a>
+<span class="sourceLineNo">100</span> * The following is an example of a swap
that replaces byte arrays with BASE-64 encoded strings:<a name="line.100"></a>
+<span class="sourceLineNo">101</span> *<a name="line.101"></a>
+<span class="sourceLineNo">102</span> * <p class='bcode'><a
name="line.102"></a>
+<span class="sourceLineNo">103</span> * <jk>public class</jk>
ByteArrayBase64Swap <jk>extends</jk>
PojoSwap<<jk>byte</jk>[],String> {<a name="line.103"></a>
+<span class="sourceLineNo">104</span> *<a name="line.104"></a>
+<span class="sourceLineNo">105</span> * <jk>public</jk>
String swap(BeanSession session, <jk>byte</jk>[] b)
<jk>throws</jk> SerializeException {<a name="line.105"></a>
+<span class="sourceLineNo">106</span> * <jk>return</jk>
StringUtils.<jsm>base64Encode</jsm>(b);<a name="line.106"></a>
+<span class="sourceLineNo">107</span> * }<a name="line.107"></a>
+<span class="sourceLineNo">108</span> *<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * <jk>public
byte</jk>[] unswap(BeanSession session, String s,
ClassMeta&lt;?&gt; hint) <jk>throws</jk> ParseException {<a
name="line.109"></a>
+<span class="sourceLineNo">110</span> * <jk>return</jk>
StringUtils.<jsm>base64Decode</jsm>(s);<a name="line.110"></a>
+<span class="sourceLineNo">111</span> * }<a name="line.111"></a>
+<span class="sourceLineNo">112</span> * }<a name="line.112"></a>
+<span class="sourceLineNo">113</span> * </p><a name="line.113"></a>
+<span class="sourceLineNo">114</span> *<a name="line.114"></a>
+<span class="sourceLineNo">115</span> * <p class='bcode'><a
name="line.115"></a>
+<span class="sourceLineNo">116</span> * WriterSerializer s =
JsonSerializer.<jsf>DEFAULT_LAX</jsf>.builder().pojoSwaps(ByteArrayBase64Swap.<jk>class</jk>).build();<a
name="line.116"></a>
+<span class="sourceLineNo">117</span> * String json =
s.serialize(<jk>new byte</jk>[] {1,2,3}); <jc>// Produces
"'AQID'"</jc><a name="line.117"></a>
+<span class="sourceLineNo">118</span> * </p><a name="line.118"></a>
+<span class="sourceLineNo">119</span> *<a name="line.119"></a>
+<span class="sourceLineNo">120</span> *<a name="line.120"></a>
+<span class="sourceLineNo">121</span> * <h6 class='topic'>Swap
annotation</h6><a name="line.121"></a>
+<span class="sourceLineNo">122</span> *<a name="line.122"></a>
+<span class="sourceLineNo">123</span> * <p><a name="line.123"></a>
+<span class="sourceLineNo">124</span> * Swap classes are often associated
directly with POJOs using the {@link Swap @Swap} annotation.<a
name="line.124"></a>
+<span class="sourceLineNo">125</span> *<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * <p class='bcode'><a
name="line.126"></a>
+<span class="sourceLineNo">127</span> * <jk>public class</jk>
MyPojoSwap <jk>extends</jk> PojoSwap&lt;MyPojo,String&gt; {
... }<a name="line.127"></a>
+<span class="sourceLineNo">128</span> *<a name="line.128"></a>
+<span class="sourceLineNo">129</span> *
<ja>@Swap</ja>(MyPojoSwap.<jk>class</jk>)<a
name="line.129"></a>
+<span class="sourceLineNo">130</span> * <jk>public class</jk>
MyPojo { ... }<a name="line.130"></a>
+<span class="sourceLineNo">131</span> * </p><a name="line.131"></a>
+<span class="sourceLineNo">132</span> *<a name="line.132"></a>
+<span class="sourceLineNo">133</span> * <p><a name="line.133"></a>
+<span class="sourceLineNo">134</span> * The <ja>@Swap</ja>
annotation is often simpler since you do not need to tell your serializers and
parsers about them<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * leading to less code.<a
name="line.135"></a>
+<span class="sourceLineNo">136</span> *<a name="line.136"></a>
+<span class="sourceLineNo">137</span> * <p><a name="line.137"></a>
+<span class="sourceLineNo">138</span> * Swaps can also be associated with
getters and setters as well:<a name="line.138"></a>
+<span class="sourceLineNo">139</span> *<a name="line.139"></a>
+<span class="sourceLineNo">140</span> * <p class='bcode'><a
name="line.140"></a>
+<span class="sourceLineNo">141</span> *
<ja>@BeanProperty</ja>(swap=MyPojo.<jk>class</jk>)<a
name="line.141"></a>
+<span class="sourceLineNo">142</span> * <jk>public</jk> MyPojo
getMyPojo();<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * </p><a name="line.143"></a>
+<span class="sourceLineNo">144</span> *<a name="line.144"></a>
+<span class="sourceLineNo">145</span> *<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * <h6 class='topic'>One-way vs.
Two-way Serialization</h6><a name="line.146"></a>
+<span class="sourceLineNo">147</span> *<a name="line.147"></a>
+<span class="sourceLineNo">148</span> * Note that while there is a unified
interface for handling swaps during both serialization and parsing,<a
name="line.148"></a>
+<span class="sourceLineNo">149</span> * in many cases only one of the {@link
#swap(BeanSession, Object)} or {@link #unswap(BeanSession, Object,
ClassMeta)}<a name="line.149"></a>
+<span class="sourceLineNo">150</span> * methods will be defined because the
swap is one-way.<a name="line.150"></a>
+<span class="sourceLineNo">151</span> * For example, a swap may be defined to
convert an {@code Iterator} to a {@code ObjectList}, but<a name="line.151"></a>
+<span class="sourceLineNo">152</span> * it's not possible to unswap an {@code
Iterator}.<a name="line.152"></a>
+<span class="sourceLineNo">153</span> * In that case, the {@code swap(Object}}
method would be implemented, but the {@code unswap(ObjectMap)} object would<a
name="line.153"></a>
+<span class="sourceLineNo">154</span> * not, and the swap would be associated
on the serializer, but not the parser.<a name="line.154"></a>
+<span class="sourceLineNo">155</span> * Also, you may choose to serialize
objects like {@code Dates} to readable {@code Strings}, in which case it's
not<a name="line.155"></a>
+<span class="sourceLineNo">156</span> * possible to re-parse it back into a
{@code Date}, since there is no way for the {@code Parser} to know it's a<a
name="line.156"></a>
+<span class="sourceLineNo">157</span> * {@code Date} from just the JSON or XML
text.<a name="line.157"></a>
+<span class="sourceLineNo">158</span> *<a name="line.158"></a>
+<span class="sourceLineNo">159</span> *<a name="line.159"></a>
+<span class="sourceLineNo">160</span> * <h6 class='topic'>Per media-type
swaps</h6><a name="line.160"></a>
+<span class="sourceLineNo">161</span> * <p><a name="line.161"></a>
+<span class="sourceLineNo">162</span> * The {@link #forMediaTypes()} method
can be overridden to provide a set of media types that the swap is invoked
on.<a name="line.162"></a>
+<span class="sourceLineNo">163</span> * It's also possible to define multiple
swaps against the same POJO as long as they're differentiated by media type.<a
name="line.163"></a>
+<span class="sourceLineNo">164</span> * When multiple swaps are defined, the
best-match media type is used.<a name="line.164"></a>
+<span class="sourceLineNo">165</span> *<a name="line.165"></a>
+<span class="sourceLineNo">166</span> * <p><a name="line.166"></a>
+<span class="sourceLineNo">167</span> * In the following example, we define 3
swaps against the same POJO. One for JSON, one for XML, and one for all<a
name="line.167"></a>
+<span class="sourceLineNo">168</span> * other types.<a name="line.168"></a>
+<span class="sourceLineNo">169</span> *<a name="line.169"></a>
+<span class="sourceLineNo">170</span> * <p class='bcode'><a
name="line.170"></a>
+<span class="sourceLineNo">171</span> * <jk>public class</jk>
PojoSwapTest {<a name="line.171"></a>
+<span class="sourceLineNo">172</span> *<a name="line.172"></a>
+<span class="sourceLineNo">173</span> * <jk>public static
class</jk> MyPojo {}<a name="line.173"></a>
+<span class="sourceLineNo">174</span> *<a name="line.174"></a>
+<span class="sourceLineNo">175</span> * <jk>public static
class</jk> MyJsonSwap <jk>extends</jk>
PojoSwap&lt;MyPojo,String&gt; {<a name="line.175"></a>
+<span class="sourceLineNo">176</span> *<a name="line.176"></a>
+<span class="sourceLineNo">177</span> * <jk>public</jk>
MediaType[] forMediaTypes() {<a name="line.177"></a>
+<span class="sourceLineNo">178</span> *
<jk>return</jk>
MediaType.<jsm>forStrings</jsm>(<js>"&#42;/json"</js>);<a
name="line.178"></a>
+<span class="sourceLineNo">179</span> * }<a name="line.179"></a>
+<span class="sourceLineNo">180</span> *<a name="line.180"></a>
+<span class="sourceLineNo">181</span> * <jk>public</jk>
String swap(BeanSession session, MyPojo o) <jk>throws</jk>
Exception {<a name="line.181"></a>
+<span class="sourceLineNo">182</span> *
<jk>return</jk> <js>"It's JSON!"</js>;<a
name="line.182"></a>
+<span class="sourceLineNo">183</span> * }<a name="line.183"></a>
+<span class="sourceLineNo">184</span> * }<a name="line.184"></a>
+<span class="sourceLineNo">185</span> *<a name="line.185"></a>
+<span class="sourceLineNo">186</span> * <jk>public static
class</jk> MyXmlSwap <jk>extends</jk>
PojoSwap&lt;MyPojo,String&gt; {<a name="line.186"></a>
+<span class="sourceLineNo">187</span> *<a name="line.187"></a>
+<span class="sourceLineNo">188</span> * <jk>public</jk>
MediaType[] forMediaTypes() {<a name="line.188"></a>
+<span class="sourceLineNo">189</span> *
<jk>return</jk>
MediaType.<jsm>forStrings</jsm>(<js>"&#42;/xml"</js>);<a
name="line.189"></a>
+<span class="sourceLineNo">190</span> * }<a name="line.190"></a>
+<span class="sourceLineNo">191</span> *<a name="line.191"></a>
+<span class="sourceLineNo">192</span> * <jk>public</jk>
String swap(BeanSession session, MyPojo o) <jk>throws</jk>
Exception {<a name="line.192"></a>
+<span class="sourceLineNo">193</span> *
<jk>return</jk> <js>"It's XML!"</js>;<a
name="line.193"></a>
+<span class="sourceLineNo">194</span> * }<a name="line.194"></a>
+<span class="sourceLineNo">195</span> * }<a name="line.195"></a>
+<span class="sourceLineNo">196</span> *<a name="line.196"></a>
+<span class="sourceLineNo">197</span> * <jk>public static
class</jk> MyOtherSwap <jk>extends</jk>
PojoSwap&lt;MyPojo,String&gt; {<a name="line.197"></a>
+<span class="sourceLineNo">198</span> *<a name="line.198"></a>
+<span class="sourceLineNo">199</span> * <jk>public</jk>
MediaType[] forMediaTypes() {<a name="line.199"></a>
+<span class="sourceLineNo">200</span> *
<jk>return</jk>
MediaType.<jsm>forStrings</jsm>(<js>"&#42;/*"</js>);<a
name="line.200"></a>
+<span class="sourceLineNo">201</span> * }<a name="line.201"></a>
+<span class="sourceLineNo">202</span> *<a name="line.202"></a>
+<span class="sourceLineNo">203</span> * <jk>public</jk>
String swap(BeanSession session, MyPojo o) <jk>throws</jk>
Exception {<a name="line.203"></a>
+<span class="sourceLineNo">204</span> *
<jk>return</jk> <js>"It's something else!"</js>;<a
name="line.204"></a>
+<span class="sourceLineNo">205</span> * }<a name="line.205"></a>
+<span class="sourceLineNo">206</span> * }<a name="line.206"></a>
+<span class="sourceLineNo">207</span> *<a name="line.207"></a>
+<span class="sourceLineNo">208</span> * <ja>@Test</ja><a
name="line.208"></a>
+<span class="sourceLineNo">209</span> * <jk>public void</jk>
doTest() <jk>throws</jk> Exception {<a name="line.209"></a>
+<span class="sourceLineNo">210</span> *<a name="line.210"></a>
+<span class="sourceLineNo">211</span> * SerializerGroup g =
<jk>new</jk> SerializerGroupBuilder()<a name="line.211"></a>
+<span class="sourceLineNo">212</span> *
.append(JsonSerializer.<jk>class</jk>,
XmlSerializer.<jk>class</jk>,
HtmlSerializer.<jk>class</jk>)<a name="line.212"></a>
+<span class="sourceLineNo">213</span> * .sq()<a
name="line.213"></a>
+<span class="sourceLineNo">214</span> *
.pojoSwaps(MyJsonSwap.<jk>class</jk>,
MyXmlSwap.<jk>class</jk>, MyOtherSwap.<jk>class</jk>)<a
name="line.214"></a>
+<span class="sourceLineNo">215</span> * .build();<a
name="line.215"></a>
+<span class="sourceLineNo">216</span> *<a name="line.216"></a>
+<span class="sourceLineNo">217</span> * MyPojo myPojo =
<jk>new</jk> MyPojo();<a name="line.217"></a>
+<span class="sourceLineNo">218</span> *<a name="line.218"></a>
+<span class="sourceLineNo">219</span> * String json =
g.getWriterSerializer(<js>"text/json"</js>).serialize(myPojo);<a
name="line.219"></a>
+<span class="sourceLineNo">220</span> *
<jsm>assertEquals</jsm>(<js>"'It\\'s JSON!'"</js>,
json);<a name="line.220"></a>
+<span class="sourceLineNo">221</span> *<a name="line.221"></a>
+<span class="sourceLineNo">222</span> * String xml =
g.getWriterSerializer(<js>"text/xml"</js>).serialize(myPojo);<a
name="line.222"></a>
+<span class="sourceLineNo">223</span> *
<jsm>assertEquals</jsm>(<js>"&lt;string&gt;It's
XML!&lt;/string&gt;"</js>, xml);<a name="line.223"></a>
+<span class="sourceLineNo">224</span> *<a name="line.224"></a>
+<span class="sourceLineNo">225</span> * String html =
g.getWriterSerializer(<js>"text/html"</js>).serialize(myPojo);<a
name="line.225"></a>
+<span class="sourceLineNo">226</span> *
<jsm>assertEquals</jsm>(<js>"&lt;string&gt;It's
something else!&lt;/string&gt;"</js>, html);<a
name="line.226"></a>
+<span class="sourceLineNo">227</span> * }<a name="line.227"></a>
+<span class="sourceLineNo">228</span> * }<a name="line.228"></a>
+<span class="sourceLineNo">229</span> * </p><a name="line.229"></a>
+<span class="sourceLineNo">230</span> *<a name="line.230"></a>
+<span class="sourceLineNo">231</span> * <p><a name="line.231"></a>
+<span class="sourceLineNo">232</span> * Multiple swaps can be associated with
a POJO by using the {@link Swaps @Swaps} annotation:<a name="line.232"></a>
+<span class="sourceLineNo">233</span> *<a name="line.233"></a>
+<span class="sourceLineNo">234</span> * <p class='bcode'><a
name="line.234"></a>
+<span class="sourceLineNo">235</span> * <ja>@Swaps</ja>(<a
name="line.235"></a>
+<span class="sourceLineNo">236</span> * {<a name="line.236"></a>
+<span class="sourceLineNo">237</span> *
<ja>@Swap</ja>(MyJsonSwap.<jk>class</jk>),<a
name="line.237"></a>
+<span class="sourceLineNo">238</span> *
<ja>@Swap</ja>(MyXmlSwap.<jk>class</jk>),<a
name="line.238"></a>
+<span class="sourceLineNo">239</span> *
<ja>@Swap</ja>(MyOtherSwap.<jk>class</jk>)<a
name="line.239"></a>
+<span class="sourceLineNo">240</span> * }<a name="line.240"></a>
+<span class="sourceLineNo">241</span> * )<a name="line.241"></a>
+<span class="sourceLineNo">242</span> * <jk>public class</jk>
MyPojo {}<a name="line.242"></a>
+<span class="sourceLineNo">243</span> * </p><a name="line.243"></a>
+<span class="sourceLineNo">244</span> *<a name="line.244"></a>
+<span class="sourceLineNo">245</span> * <p><a name="line.245"></a>
+<span class="sourceLineNo">246</span> * Note that since
<code>Readers</code> get serialized directly to the output of a
serializer, it's possible to<a name="line.246"></a>
+<span class="sourceLineNo">247</span> * implement a swap that provides
fully-customized output.<a name="line.247"></a>
+<span class="sourceLineNo">248</span> *<a name="line.248"></a>
+<span class="sourceLineNo">249</span> * <p class='bcode'><a
name="line.249"></a>
+<span class="sourceLineNo">250</span> * <jk>public class</jk>
MyJsonSwap <jk>extends</jk> PojoSwap&lt;MyPojo,Reader&gt;
{<a name="line.250"></a>
+<span class="sourceLineNo">251</span> *<a name="line.251"></a>
+<span class="sourceLineNo">252</span> * <jk>public</jk>
MediaType[] forMediaTypes() {<a name="line.252"></a>
+<span class="sourceLineNo">253</span> * <jk>return</jk>
MediaType.<jsm>forStrings</jsm>(<js>"&#42;/json"</js>);<a
name="line.253"></a>
+<span class="sourceLineNo">254</span> * }<a name="line.254"></a>
+<span class="sourceLineNo">255</span> *<a name="line.255"></a>
+<span class="sourceLineNo">256</span> * <jk>public</jk>
Reader swap(BeanSession session, MyPojo o) <jk>throws</jk>
Exception {<a name="line.256"></a>
+<span class="sourceLineNo">257</span> * <jk>return
new</jk> StringReader(<js>"{message:'Custom JSON!'}"</js>);<a
name="line.257"></a>
+<span class="sourceLineNo">258</span> * }<a name="line.258"></a>
+<span class="sourceLineNo">259</span> * }<a name="line.259"></a>
+<span class="sourceLineNo">260</span> * </p><a name="line.260"></a>
+<span class="sourceLineNo">261</span> *<a name="line.261"></a>
+<span class="sourceLineNo">262</span> *<a name="line.262"></a>
+<span class="sourceLineNo">263</span> * <h6
class='topic'>Templates</h6><a name="line.263"></a>
+<span class="sourceLineNo">264</span> *<a name="line.264"></a>
+<span class="sourceLineNo">265</span> * <p><a name="line.265"></a>
+<span class="sourceLineNo">266</span> * Template strings are arbitrary strings
associated with swaps that help provide additional context information<a
name="line.266"></a>
+<span class="sourceLineNo">267</span> * for the swap class.<a
name="line.267"></a>
+<span class="sourceLineNo">268</span> * They're called 'templates' because
their primary purpose is for providing template names, such as Apache
FreeMarker<a name="line.268"></a>
+<span class="sourceLineNo">269</span> * template names.<a name="line.269"></a>
+<span class="sourceLineNo">270</span> *<a name="line.270"></a>
+<span class="sourceLineNo">271</span> * <p><a name="line.271"></a>
+<span class="sourceLineNo">272</span> * The following is an example of a
templated swap class used to serialize POJOs to HTML using FreeMarker:<a
name="line.272"></a>
+<span class="sourceLineNo">273</span> *<a name="line.273"></a>
+<span class="sourceLineNo">274</span> * <p class='bcode'><a
name="line.274"></a>
+<span class="sourceLineNo">275</span> * <jc>// Our abstracted
templated swap class.</jc><a name="line.275"></a>
+<span class="sourceLineNo">276</span> * <jk>public abstract
class</jk> FreeMarkerSwap <jk>extends</jk>
PojoSwap&lt;Object,Reader&gt; {<a name="line.276"></a>
+<span class="sourceLineNo">277</span> *<a name="line.277"></a>
+<span class="sourceLineNo">278</span> * <jk>public</jk>
MediaType[] forMediaTypes() {<a name="line.278"></a>
+<span class="sourceLineNo">279</span> * <jk>return</jk>
MediaType.<jsm>forStrings</jsm>(<js>"&#42;/html"</js>);<a
name="line.279"></a>
+<span class="sourceLineNo">280</span> * }<a name="line.280"></a>
+<span class="sourceLineNo">281</span> *<a name="line.281"></a>
+<span class="sourceLineNo">282</span> * <jk>public</jk>
Reader swap(BeanSession session, Object o, String template)
<jk>throws</jk> Exception {<a name="line.282"></a>
+<span class="sourceLineNo">283</span> * <jk>return</jk>
getFreeMarkerReader(template, o); <jc>// Some method that creates raw
HTML.</jc><a name="line.283"></a>
+<span class="sourceLineNo">284</span> * }<a name="line.284"></a>
+<span class="sourceLineNo">285</span> * }<a name="line.285"></a>
+<span class="sourceLineNo">286</span> *<a name="line.286"></a>
+<span class="sourceLineNo">287</span> * <jc>// An implementation of
our templated swap class.</jc><a name="line.287"></a>
+<span class="sourceLineNo">288</span> * <jk>public class</jk>
MyPojoSwap <jk>extends</jk> FreeMarkerSwap {<a name="line.288"></a>
+<span class="sourceLineNo">289</span> * <jk>public</jk>
String withTemplate() {<a name="line.289"></a>
+<span class="sourceLineNo">290</span> * <jk>return</jk>
<js>"MyPojo.div.ftl"</js>;<a name="line.290"></a>
+<span class="sourceLineNo">291</span> * }<a name="line.291"></a>
+<span class="sourceLineNo">292</span> * }<a name="line.292"></a>
+<span class="sourceLineNo">293</span> * </p><a name="line.293"></a>
+<span class="sourceLineNo">294</span> *<a name="line.294"></a>
+<span class="sourceLineNo">295</span> * <p><a name="line.295"></a>
+<span class="sourceLineNo">296</span> * In practice however, the template is
usually going to be defined on a <ja>@Swap</ja> annotation like the
following<a name="line.296"></a>
+<span class="sourceLineNo">297</span> * example:<a name="line.297"></a>
+<span class="sourceLineNo">298</span> *<a name="line.298"></a>
+<span class="sourceLineNo">299</span> * <p class='bcode'><a
name="line.299"></a>
+<span class="sourceLineNo">300</span> *
<ja>@Swap</ja>(impl=FreeMarkerSwap.<jk>class</jk>,
template=<js>"MyPojo.div.ftl"</js>)<a name="line.300"></a>
+<span class="sourceLineNo">301</span> * <jk>public class</jk>
MyPojo {}<a name="line.301"></a>
+<span class="sourceLineNo">302</span> * </p><a name="line.302"></a>
+<span class="sourceLineNo">303</span> *<a name="line.303"></a>
+<span class="sourceLineNo">304</span> *<a name="line.304"></a>
+<span class="sourceLineNo">305</span> * <h6
class='topic'>Localization</h6><a name="line.305"></a>
+<span class="sourceLineNo">306</span> *<a name="line.306"></a>
+<span class="sourceLineNo">307</span> * Swaps have access to the session
locale and timezone through the {@link BeanSession#getLocale()} and<a
name="line.307"></a>
+<span class="sourceLineNo">308</span> * {@link BeanSession#getTimeZone()}
methods.<a name="line.308"></a>
+<span class="sourceLineNo">309</span> * This allows you to specify localized
swap values when needed.<a name="line.309"></a>
+<span class="sourceLineNo">310</span> * If using the REST server API, the
locale and timezone are set based on the
<code>Accept-Language</code> and<a name="line.310"></a>
+<span class="sourceLineNo">311</span> * <code>Time-Zone</code>
headers on the request.<a name="line.311"></a>
+<span class="sourceLineNo">312</span> *<a name="line.312"></a>
+<span class="sourceLineNo">313</span> *<a name="line.313"></a>
+<span class="sourceLineNo">314</span> * <h6 class='section'>Additional
information:</h6><a name="line.314"></a>
+<span class="sourceLineNo">315</span> *<a name="line.315"></a>
+<span class="sourceLineNo">316</span> * See <a class='doclink'
href='package-summary.html#TOC'>org.apache.juneau.transform</a> for
more information.<a name="line.316"></a>
+<span class="sourceLineNo">317</span> *<a name="line.317"></a>
+<span class="sourceLineNo">318</span> * @param <T> The normal form of
the class.<a name="line.318"></a>
+<span class="sourceLineNo">319</span> * @param <S> The swapped form of
the class.<a name="line.319"></a>
+<span class="sourceLineNo">320</span> */<a name="line.320"></a>
+<span
class="sourceLineNo">321</span>@SuppressWarnings({"unchecked","rawtypes","hiding"})<a
name="line.321"></a>
+<span class="sourceLineNo">322</span>public abstract class PojoSwap<T,S>
{<a name="line.322"></a>
+<span class="sourceLineNo">323</span><a name="line.323"></a>
+<span class="sourceLineNo">324</span> /**<a name="line.324"></a>
+<span class="sourceLineNo">325</span> * Represents a non-existent pojo
swap.<a name="line.325"></a>
+<span class="sourceLineNo">326</span> */<a name="line.326"></a>
+<span class="sourceLineNo">327</span> public final static PojoSwap NULL =
new PojoSwap((Class)null, (Class)null) {};<a name="line.327"></a>
+<span class="sourceLineNo">328</span><a name="line.328"></a>
+<span class="sourceLineNo">329</span> private final Class<T>
normalClass;<a name="line.329"></a>
+<span class="sourceLineNo">330</span> private final Class<?>
swapClass;<a name="line.330"></a>
+<span class="sourceLineNo">331</span> private ClassMeta<?>
swapClassMeta;<a name="line.331"></a>
+<span class="sourceLineNo">332</span><a name="line.332"></a>
+<span class="sourceLineNo">333</span> // Unfortunately these cannot be made
final because we want to allow for PojoSwaps with no-arg constructors<a
name="line.333"></a>
+<span class="sourceLineNo">334</span> // which simplifies declarations.<a
name="line.334"></a>
+<span class="sourceLineNo">335</span> private MediaType[] forMediaTypes;<a
name="line.335"></a>
+<span class="sourceLineNo">336</span> private String template;<a
name="line.336"></a>
+<span class="sourceLineNo">337</span><a name="line.337"></a>
+<span class="sourceLineNo">338</span> /**<a name="line.338"></a>
+<span class="sourceLineNo">339</span> * Constructor.<a name="line.339"></a>
+<span class="sourceLineNo">340</span> */<a name="line.340"></a>
+<span class="sourceLineNo">341</span> protected PojoSwap() {<a
name="line.341"></a>
+<span class="sourceLineNo">342</span> normalClass =
(Class<T>)resolveParameterType(PojoSwap.class, 0, this.getClass());<a
name="line.342"></a>
+<span class="sourceLineNo">343</span> swapClass =
resolveParameterType(PojoSwap.class, 1, this.getClass());<a name="line.343"></a>
+<span class="sourceLineNo">344</span> forMediaTypes = forMediaTypes();<a
name="line.344"></a>
+<span class="sourceLineNo">345</span> template = withTemplate();<a
name="line.345"></a>
+<span class="sourceLineNo">346</span> }<a name="line.346"></a>
+<span class="sourceLineNo">347</span><a name="line.347"></a>
+<span class="sourceLineNo">348</span> /**<a name="line.348"></a>
+<span class="sourceLineNo">349</span> * Constructor for when the normal and
transformed classes are already known.<a name="line.349"></a>
+<span class="sourceLineNo">350</span> *<a name="line.350"></a>
+<span class="sourceLineNo">351</span> * @param normalClass The normal class
(cannot be serialized).<a name="line.351"></a>
+<span class="sourceLineNo">352</span> * @param swapClass The transformed
class (serializable).<a name="line.352"></a>
+<span class="sourceLineNo">353</span> */<a name="line.353"></a>
+<span class="sourceLineNo">354</span> protected PojoSwap(Class<T>
normalClass, Class<?> swapClass) {<a name="line.354"></a>
+<span class="sourceLineNo">355</span> this.normalClass = normalClass;<a
name="line.355"></a>
+<span class="sourceLineNo">356</span> this.swapClass = swapClass;<a
name="line.356"></a>
+<span class="sourceLineNo">357</span> this.forMediaTypes =
forMediaTypes();<a name="line.357"></a>
+<span class="sourceLineNo">358</span> this.template = withTemplate();<a
name="line.358"></a>
+<span class="sourceLineNo">359</span> }<a name="line.359"></a>
+<span class="sourceLineNo">360</span><a name="line.360"></a>
+<span class="sourceLineNo">361</span> /**<a name="line.361"></a>
+<span class="sourceLineNo">362</span> * Returns the media types that this
swap is applicable to.<a name="line.362"></a>
+<span class="sourceLineNo">363</span> *<a name="line.363"></a>
+<span class="sourceLineNo">364</span> * <p><a name="line.364"></a>
+<span class="sourceLineNo">365</span> * This method can be overridden to
programmatically specify what media types it applies to.<a name="line.365"></a>
+<span class="sourceLineNo">366</span> *<a name="line.366"></a>
+<span class="sourceLineNo">367</span> * <p><a name="line.367"></a>
+<span class="sourceLineNo">368</span> * This method is the programmatic
equivalent to the {@link Swap#mediaTypes()} annotation.<a name="line.368"></a>
+<span class="sourceLineNo">369</span> *<a name="line.369"></a>
+<span class="sourceLineNo">370</span> * @return The media types that this
swap is applicable to, or <jk>null</jk> if it's applicable for all
media types.<a name="line.370"></a>
+<span class="sourceLineNo">371</span> */<a name="line.371"></a>
+<span class="sourceLineNo">372</span> public MediaType[] forMediaTypes() {<a
name="line.372"></a>
+<span class="sourceLineNo">373</span> return null;<a name="line.373"></a>
+<span class="sourceLineNo">374</span> }<a name="line.374"></a>
+<span class="sourceLineNo">375</span><a name="line.375"></a>
+<span class="sourceLineNo">376</span> /**<a name="line.376"></a>
+<span class="sourceLineNo">377</span> * Returns additional context
information for this swap.<a name="line.377"></a>
+<span class="sourceLineNo">378</span> *<a name="line.378"></a>
+<span class="sourceLineNo">379</span> * <p><a name="line.379"></a>
+<span class="sourceLineNo">380</span> * Typically this is going to be used
to specify a template name, such as a FreeMarker template file name.<a
name="line.380"></a>
+<span class="sourceLineNo">381</span> *<a name="line.381"></a>
+<span class="sourceLineNo">382</span> * <p><a name="line.382"></a>
+<span class="sourceLineNo">383</span> * This method can be overridden to
programmatically specify a template value.<a name="line.383"></a>
+<span class="sourceLineNo">384</span> *<a name="line.384"></a>
+<span class="sourceLineNo">385</span> * <p><a name="line.385"></a>
+<span class="sourceLineNo">386</span> * This method is the programmatic
equivalent to the {@link Swap#template()} annotation.<a name="line.386"></a>
+<span class="sourceLineNo">387</span> *<a name="line.387"></a>
+<span class="sourceLineNo">388</span> * @return Additional context
information, or <jk>null</jk> if not specified.<a
name="line.388"></a>
+<span class="sourceLineNo">389</span> */<a name="line.389"></a>
+<span class="sourceLineNo">390</span> public String withTemplate() {<a
name="line.390"></a>
+<span class="sourceLineNo">391</span> return null;<a name="line.391"></a>
+<span class="sourceLineNo">392</span> }<a name="line.392"></a>
+<span class="sourceLineNo">393</span><a name="line.393"></a>
+<span class="sourceLineNo">394</span> /**<a name="line.394"></a>
+<span class="sourceLineNo">395</span> * Sets the media types that this swap
is associated with.<a name="line.395"></a>
+<span class="sourceLineNo">396</span> *<a name="line.396"></a>
+<span class="sourceLineNo">397</span> * @param mediaTypes The media types
that this swap is associated with.<a name="line.397"></a>
+<span class="sourceLineNo">398</span> * @return This object (for method
chaining).<a name="line.398"></a>
+<span class="sourceLineNo">399</span> */<a name="line.399"></a>
+<span class="sourceLineNo">400</span> public PojoSwap<T,?>
forMediaTypes(MediaType[] mediaTypes) {<a name="line.400"></a>
+<span class="sourceLineNo">401</span> this.forMediaTypes = mediaTypes;<a
name="line.401"></a>
+<span class="sourceLineNo">402</span> return this;<a name="line.402"></a>
+<span class="sourceLineNo">403</span> }<a name="line.403"></a>
+<span class="sourceLineNo">404</span><a name="line.404"></a>
+<span class="sourceLineNo">405</span> /**<a name="line.405"></a>
+<span class="sourceLineNo">406</span> * Sets the template string on this
swap.<a name="line.406"></a>
+<span class="sourceLineNo">407</span> *<a name="line.407"></a>
+<span class="sourceLineNo">408</span> * @param template The template string
on this swap.<a name="line.408"></a>
+<span class="sourceLineNo">409</span> * @return This object (for method
chaining).<a name="line.409"></a>
+<span class="sourceLineNo">410</span> */<a name="line.410"></a>
+<span class="sourceLineNo">411</span> public PojoSwap<T,?>
withTemplate(String template) {<a name="line.411"></a>
+<span class="sourceLineNo">412</span> this.template = template;<a
name="line.412"></a>
+<span class="sourceLineNo">413</span> return this;<a name="line.413"></a>
+<span class="sourceLineNo">414</span> }<a name="line.414"></a>
+<span class="sourceLineNo">415</span><a name="line.415"></a>
+<span class="sourceLineNo">416</span> /**<a name="line.416"></a>
+<span class="sourceLineNo">417</span> * Returns a number indicating how
well this swap matches the specified session.<a name="line.417"></a>
+<span class="sourceLineNo">418</span> *<a name="line.418"></a>
+<span class="sourceLineNo">419</span> * <p><a name="line.419"></a>
+<span class="sourceLineNo">420</span> * Uses the {@link
MediaType#match(MediaType, boolean)} method algorithm to produce a number
whereby a<a name="line.420"></a>
+<span class="sourceLineNo">421</span> * larger value indicates a "better
match".<a name="line.421"></a>
+<span class="sourceLineNo">422</span> * The idea being that if multiple
swaps are associated with a given POJO, we want to pick the best one.<a
name="line.422"></a>
+<span class="sourceLineNo">423</span> *<a name="line.423"></a>
+<span class="sourceLineNo">424</span> * <p><a name="line.424"></a>
+<span class="sourceLineNo">425</span> * For example, if the session media
type is <js>"text/json"</js>, then the match values are shown
below:<a name="line.425"></a>
+<span class="sourceLineNo">426</span> *<a name="line.426"></a>
+<span class="sourceLineNo">427</span> * <ul><a name="line.427"></a>
+<span class="sourceLineNo">428</span> *
<li><js>"text/json"</js> = <code>100,000</code><a
name="line.428"></a>
+<span class="sourceLineNo">429</span> *
<li><js>"&#42;/json"</js> =
<code>5,100</code><a name="line.429"></a>
+<span class="sourceLineNo">430</span> *
<li><js>"&#42;/&#42;"</js> =
<code>5,000</code><a name="line.430"></a>
+<span class="sourceLineNo">431</span> * <li>No media types
specified on swap = <code>1</code><a name="line.431"></a>
+<span class="sourceLineNo">432</span> *
<li><js>"text/xml"</js> = <code>0</code><a
name="line.432"></a>
+<span class="sourceLineNo">433</span> * </ul><a name="line.433"></a>
+<span class="sourceLineNo">434</span> *<a name="line.434"></a>
+<span class="sourceLineNo">435</span> * @param session The bean session.<a
name="line.435"></a>
+<span class="sourceLineNo">436</span> * @return Zero if swap doesn't match
the session, or a positive number if it does.<a name="line.436"></a>
+<span class="sourceLineNo">437</span> */<a name="line.437"></a>
+<span class="sourceLineNo">438</span> public int match(BeanSession session)
{<a name="line.438"></a>
+<span class="sourceLineNo">439</span> if (forMediaTypes == null)<a
name="line.439"></a>
+<span class="sourceLineNo">440</span> return 1;<a name="line.440"></a>
+<span class="sourceLineNo">441</span> int i = 0;<a name="line.441"></a>
+<span class="sourceLineNo">442</span> MediaType mt =
session.getMediaType();<a name="line.442"></a>
+<span class="sourceLineNo">443</span> if (forMediaTypes != null)<a
name="line.443"></a>
+<span class="sourceLineNo">444</span> for (MediaType mt2 :
forMediaTypes)<a name="line.444"></a>
+<span class="sourceLineNo">445</span> i = Math.max(i, mt2.match(mt,
false));<a name="line.445"></a>
+<span class="sourceLineNo">446</span> return i;<a name="line.446"></a>
+<span class="sourceLineNo">447</span> }<a name="line.447"></a>
+<span class="sourceLineNo">448</span><a name="line.448"></a>
+<span class="sourceLineNo">449</span> /**<a name="line.449"></a>
+<span class="sourceLineNo">450</span> * If this transform is to be used to
serialize non-serializable POJOs, it must implement this method.<a
name="line.450"></a>
+<span class="sourceLineNo">451</span> *<a name="line.451"></a>
+<span class="sourceLineNo">452</span> * <p><a name="line.452"></a>
+<span class="sourceLineNo">453</span> * The object must be converted into
one of the following serializable types:<a name="line.453"></a>
+<span class="sourceLineNo">454</span> * <ul class='spaced-list'><a
name="line.454"></a>
+<span class="sourceLineNo">455</span> * <li><a name="line.455"></a>
+<span class="sourceLineNo">456</span> * {@link String}<a
name="line.456"></a>
+<span class="sourceLineNo">457</span> * <li><a name="line.457"></a>
+<span class="sourceLineNo">458</span> * {@link Number}<a
name="line.458"></a>
+<span class="sourceLineNo">459</span> * <li><a name="line.459"></a>
+<span class="sourceLineNo">460</span> * {@link Boolean}<a
name="line.460"></a>
+<span class="sourceLineNo">461</span> * <li><a name="line.461"></a>
+<span class="sourceLineNo">462</span> * {@link Collection} containing
anything on this list.<a name="line.462"></a>
+<span class="sourceLineNo">463</span> * <li><a name="line.463"></a>
+<span class="sourceLineNo">464</span> * {@link Map} containing
anything on this list.<a name="line.464"></a>
+<span class="sourceLineNo">465</span> * <li><a name="line.465"></a>
+<span class="sourceLineNo">466</span> * A java bean with properties
of anything on this list.<a name="line.466"></a>
+<span class="sourceLineNo">467</span> * <li><a name="line.467"></a>
+<span class="sourceLineNo">468</span> * An array of anything on this
list.<a name="line.468"></a>
+<span class="sourceLineNo">469</span> * </ul><a name="line.469"></a>
+<span class="sourceLineNo">470</span> *<a name="line.470"></a>
+<span class="sourceLineNo">471</span> * @param session<a
name="line.471"></a>
+<span class="sourceLineNo">472</span> * The bean session to use to get
the class meta.<a name="line.472"></a>
+<span class="sourceLineNo">473</span> * This is always going to be the
same bean context that created this swap.<a name="line.473"></a>
+<span class="sourceLineNo">474</span> * @param o The object to be
transformed.<a name="line.474"></a>
+<span class="sourceLineNo">475</span> * @return The transformed object.<a
name="line.475"></a>
+<span class="sourceLineNo">476</span> * @throws Exception If a problem
occurred trying to convert the output.<a name="line.476"></a>
+<span class="sourceLineNo">477</span> */<a name="line.477"></a>
+<span class="sourceLineNo">478</span> public S swap(BeanSession session, T
o) throws Exception {<a name="line.478"></a>
+<span class="sourceLineNo">479</span> return swap(session, o,
template);<a name="line.479"></a>
+<span class="sourceLineNo">480</span> }<a name="line.480"></a>
+<span class="sourceLineNo">481</span><a name="line.481"></a>
+<span class="sourceLineNo">482</span> /**<a name="line.482"></a>
+<span class="sourceLineNo">483</span> * Same as {@link #swap(BeanSession,
Object)}, but can be used if your swap has a template associated with it.<a
name="line.483"></a>
+<span class="sourceLineNo">484</span> *<a name="line.484"></a>
+<span class="sourceLineNo">485</span> * @param session<a
name="line.485"></a>
+<span class="sourceLineNo">486</span> * The bean session to use to get
the class meta.<a name="line.486"></a>
+<span class="sourceLineNo">487</span> * This is always going to be the
same bean context that created this swap.<a name="line.487"></a>
+<span class="sourceLineNo">488</span> * @param o The object to be
transformed.<a name="line.488"></a>
+<span class="sourceLineNo">489</span> * @param template<a
name="line.489"></a>
+<span class="sourceLineNo">490</span> * The template string associated
with this swap.<a name="line.490"></a>
+<span class="sourceLineNo">491</span> * @return The transformed object.<a
name="line.491"></a>
+<span class="sourceLineNo">492</span> * @throws Exception If a problem
occurred trying to convert the output.<a name="line.492"></a>
+<span class="sourceLineNo">493</span> */<a name="line.493"></a>
+<span class="sourceLineNo">494</span> public S swap(BeanSession session, T
o, String template) throws Exception {<a name="line.494"></a>
+<span class="sourceLineNo">495</span> throw new SerializeException("Swap
method not implemented on PojoSwap ''{0}''", this.getClass().getName());<a
name="line.495"></a>
+<span class="sourceLineNo">496</span> }<a name="line.496"></a>
+<span class="sourceLineNo">497</span><a name="line.497"></a>
+<span class="sourceLineNo">498</span> /**<a name="line.498"></a>
+<span class="sourceLineNo">499</span> * If this transform is to be used to
reconstitute POJOs that aren't true Java beans, it must implement this
method.<a name="line.499"></a>
+<span class="sourceLineNo">500</span> *<a name="line.500"></a>
+<span class="sourceLineNo">501</span> * @param session<a
name="line.501"></a>
+<span class="sourceLineNo">502</span> * The bean session to use to get
the class meta.<a name="line.502"></a>
+<span class="sourceLineNo">503</span> * This is always going to be the
same bean context that created this swap.<a name="line.503"></a>
+<span class="sourceLineNo">504</span> * @param f The transformed object.<a
name="line.504"></a>
+<span class="sourceLineNo">505</span> * @param hint<a name="line.505"></a>
+<span class="sourceLineNo">506</span> * If possible, the parser will try
to tell you the object type being created.<a name="line.506"></a>
+<span class="sourceLineNo">507</span> * For example, on a serialized
date, this may tell you that the object being created must be of type<a
name="line.507"></a>
+<span class="sourceLineNo">508</span> * {@code GregorianCalendar}.<a
name="line.508"></a>
+<span class="sourceLineNo">509</span> * <br>This may be
<jk>null</jk> if the parser cannot make this determination.<a
name="line.509"></a>
+<span class="sourceLineNo">510</span> * @return The narrowed object.<a
name="line.510"></a>
+<span class="sourceLineNo">511</span> * @throws Exception If this method is
not implemented.<a name="line.511"></a>
+<span class="sourceLineNo">512</span> */<a name="line.512"></a>
+<span class="sourceLineNo">513</span> public T unswap(BeanSession session, S
f, ClassMeta<?> hint) throws Exception {<a name="line.513"></a>
+<span class="sourceLineNo">514</span> return unswap(session, f, hint,
template);<a name="line.514"></a>
+<span class="sourceLineNo">515</span> }<a name="line.515"></a>
+<span class="sourceLineNo">516</span><a name="line.516"></a>
+<span class="sourceLineNo">517</span> /**<a name="line.517"></a>
+<span class="sourceLineNo">518</span> * Same as {@link #unswap(BeanSession,
Object, ClassMeta)}, but can be used if your swap has a template associated
with it.<a name="line.518"></a>
+<span class="sourceLineNo">519</span> *<a name="line.519"></a>
+<span class="sourceLineNo">520</span> * @param session<a
name="line.520"></a>
+<span class="sourceLineNo">521</span> * The bean session to use to get
the class meta.<a name="line.521"></a>
+<span class="sourceLineNo">522</span> * This is always going to be the
same bean context that created this swap.<a name="line.522"></a>
+<span class="sourceLineNo">523</span> * @param f The transformed object.<a
name="line.523"></a>
+<span class="sourceLineNo">524</span> * @param hint<a name="line.524"></a>
+<span class="sourceLineNo">525</span> * If possible, the parser will try
to tell you the object type being created.<a name="line.525"></a>
+<span class="sourceLineNo">526</span> * For example, on a serialized
date, this may tell you that the object being created must be of type<a
name="line.526"></a>
+<span class="sourceLineNo">527</span> * {@code GregorianCalendar}.<a
name="line.527"></a>
+<span class="sourceLineNo">528</span> * <br>This may be
<jk>null</jk> if the parser cannot make this determination.<a
name="line.528"></a>
+<span class="sourceLineNo">529</span> * @param template<a
name="line.529"></a>
+<span class="sourceLineNo">530</span> * The template string associated
with this swap.<a name="line.530"></a>
+<span class="sourceLineNo">531</span> * @return The transformed object.<a
name="line.531"></a>
+<span class="sourceLineNo">532</span> * @throws Exception If a problem
occurred trying to convert the output.<a name="line.532"></a>
+<span class="sourceLineNo">533</span> */<a name="line.533"></a>
+<span class="sourceLineNo">534</span> public T unswap(BeanSession session, S
f, ClassMeta<?> hint, String template) throws Exception {<a
name="line.534"></a>
+<span class="sourceLineNo">535</span> throw new ParseException("Unswap
method not implemented on PojoSwap ''{0}''", this.getClass().getName());<a
name="line.535"></a>
+<span class="sourceLineNo">536</span> }<a name="line.536"></a>
+<span class="sourceLineNo">537</span><a name="line.537"></a>
+<span class="sourceLineNo">538</span> /**<a name="line.538"></a>
+<span class="sourceLineNo">539</span> * Returns the T class, the normalized
form of the class.<a name="line.539"></a>
+<span class="sourceLineNo">540</span> *<a name="line.540"></a>
+<span class="sourceLineNo">541</span> * @return The normal form of this
class.<a name="line.541"></a>
+<span class="sourceLineNo">542</span> */<a name="line.542"></a>
+<span class="sourceLineNo">543</span> public Class<T> getNormalClass()
{<a name="line.543"></a>
+<span class="sourceLineNo">544</span> return normalClass;<a
name="line.544"></a>
+<span class="sourceLineNo">545</span> }<a name="line.545"></a>
+<span class="sourceLineNo">546</span><a name="line.546"></a>
+<span class="sourceLineNo">547</span> /**<a name="line.547"></a>
+<span class="sourceLineNo">548</span> * Returns the G class, the
generalized form of the class.<a name="line.548"></a>
+<span class="sourceLineNo">549</span> *<a name="line.549"></a>
+<span class="sourceLineNo">550</span> * <p><a name="line.550"></a>
+<span class="sourceLineNo">551</span> * Subclasses must override this
method if the generalized class is {@code Object}, meaning it can produce
multiple<a name="line.551"></a>
+<span class="sourceLineNo">552</span> * generalized forms.<a
name="line.552"></a>
+<span class="sourceLineNo">553</span> *<a name="line.553"></a>
+<span class="sourceLineNo">554</span> * @return The transformed form of
this class.<a name="line.554"></a>
+<span class="sourceLineNo">555</span> */<a name="line.555"></a>
+<span class="sourceLineNo">556</span> public Class<?> getSwapClass()
{<a name="line.556"></a>
+<span class="sourceLineNo">557</span> return swapClass;<a
name="line.557"></a>
+<span class="sourceLineNo">558</span> }<a name="line.558"></a>
+<span class="sourceLineNo">559</span><a name="line.559"></a>
+<span class="sourceLineNo">560</span> /**<a name="line.560"></a>
+<span class="sourceLineNo">561</span> * Returns the {@link ClassMeta} of
the transformed class type.<a name="line.561"></a>
+<span class="sourceLineNo">562</span> *<a name="line.562"></a>
+<span class="sourceLineNo">563</span> * <p><a name="line.563"></a>
+<span class="sourceLineNo">564</span> * This value is cached for quick
lookup.<a name="line.564"></a>
+<span class="sourceLineNo">565</span> *<a name="line.565"></a>
+<span class="sourceLineNo">566</span> * @param session<a
name="line.566"></a>
+<span class="sourceLineNo">567</span> * The bean context to use to get
the class meta.<a name="line.567"></a>
+<span class="sourceLineNo">568</span> * This is always going to be the
same bean context that created this swap.<a name="line.568"></a>
+<span class="sourceLineNo">569</span> * @return The {@link ClassMeta} of
the transformed class type.<a name="line.569"></a>
+<span class="sourceLineNo">570</span> */<a name="line.570"></a>
+<span class="sourceLineNo">571</span> public ClassMeta<?>
getSwapClassMeta(BeanSession session) {<a name="line.571"></a>
+<span class="sourceLineNo">572</span> if (swapClassMeta == null)<a
name="line.572"></a>
+<span class="sourceLineNo">573</span> swapClassMeta =
session.getClassMeta(swapClass);<a name="line.573"></a>
+<span class="sourceLineNo">574</span> return swapClassMeta;<a
name="line.574"></a>
+<span class="sourceLineNo">575</span> }<a name="line.575"></a>
+<span class="sourceLineNo">576</span><a name="line.576"></a>
+<span class="sourceLineNo">577</span> /**<a name="line.577"></a>
+<span class="sourceLineNo">578</span> * Checks if the specified object is
an instance of the normal class defined on this swap.<a name="line.578"></a>
+<span class="sourceLineNo">579</span> *<a name="line.579"></a>
+<span class="sourceLineNo">580</span> * @param o The object to check.<a
name="line.580"></a>
+<span class="sourceLineNo">581</span> * @return<a name="line.581"></a>
+<span class="sourceLineNo">582</span> * <jk>true</jk> if the
specified object is a subclass of the normal class defined on this transform.<a
name="line.582"></a>
+<span class="sourceLineNo">583</span> * <jk>null</jk> always
return <jk>false</jk>.<a name="line.583"></a>
+<span class="sourceLineNo">584</span> */<a name="line.584"></a>
+<span class="sourceLineNo">585</span> public boolean isNormalObject(Object
o) {<a name="line.585"></a>
+<span class="sourceLineNo">586</span> if (o == null)<a
name="line.586"></a>
+<span class="sourceLineNo">587</span> return false;<a
name="line.587"></a>
+<span class="sourceLineNo">588</span> return isParentClass(normalClass,
o.getClass());<a name="line.588"></a>
+<span class="sourceLineNo">589</span> }<a name="line.589"></a>
+<span class="sourceLineNo">590</span><a name="line.590"></a>
+<span class="sourceLineNo">591</span> /**<a name="line.591"></a>
+<span class="sourceLineNo">592</span> * Checks if the specified object is
an instance of the swap class defined on this swap.<a name="line.592"></a>
+<span class="sourceLineNo">593</span> *<a name="line.593"></a>
+<span class="sourceLineNo">594</span> * @param o The object to check.<a
name="line.594"></a>
+<span class="sourceLineNo">595</span> * @return<a name="line.595"></a>
+<span class="sourceLineNo">596</span> * <jk>true</jk> if the
specified object is a subclass of the transformed class defined on this
transform.<a name="line.596"></a>
+<span class="sourceLineNo">597</span> * <jk>null</jk> always
return <jk>false</jk>.<a name="line.597"></a>
+<span class="sourceLineNo">598</span> */<a name="line.598"></a>
+<span class="sourceLineNo">599</span> public boolean isSwappedObject(Object
o) {<a name="line.599"></a>
+<span class="sourceLineNo">600</span> if (o == null)<a
name="line.600"></a>
+<span class="sourceLineNo">601</span> return false;<a
name="line.601"></a>
+<span class="sourceLineNo">602</span> return isParentClass(swapClass,
o.getClass());<a name="line.602"></a>
+<span class="sourceLineNo">603</span> }<a name="line.603"></a>
+<span class="sourceLineNo">604</span><a name="line.604"></a>
+<span class="sourceLineNo">605</span><a name="line.605"></a>
+<span class="sourceLineNo">606</span>
//--------------------------------------------------------------------------------<a
name="line.606"></a>
+<span class="sourceLineNo">607</span> // Overridden methods<a
name="line.607"></a>
+<span class="sourceLineNo">608</span>
//--------------------------------------------------------------------------------<a
name="line.608"></a>
+<span class="sourceLineNo">609</span><a name="line.609"></a>
+<span class="sourceLineNo">610</span> @Override /* Object */<a
name="line.610"></a>
+<span class="sourceLineNo">611</span> public String toString() {<a
name="line.611"></a>
+<span class="sourceLineNo">612</span> return getClass().getSimpleName() +
'<' + getNormalClass().getSimpleName() + "," +
getSwapClass().getSimpleName() + '>';<a name="line.612"></a>
+<span class="sourceLineNo">613</span> }<a name="line.613"></a>
+<span class="sourceLineNo">614</span>}<a name="line.614"></a>