Repository: incubator-juneau-website Updated Branches: refs/heads/asf-site f635b8696 -> 4903c5d14
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/serializer/SerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/serializer/SerializerSession.html b/content/site/apidocs/src-html/org/apache/juneau/serializer/SerializerSession.html index 87c394b..4b1c486 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/serializer/SerializerSession.html +++ b/content/site/apidocs/src-html/org/apache/juneau/serializer/SerializerSession.html @@ -293,7 +293,7 @@ <span class="sourceLineNo">285</span> *<a name="line.285"></a> <span class="sourceLineNo">286</span> * @return The {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting value for this session.<a name="line.286"></a> <span class="sourceLineNo">287</span> */<a name="line.287"></a> -<span class="sourceLineNo">288</span> public final boolean isAddBeanTypeProperties() {<a name="line.288"></a> +<span class="sourceLineNo">288</span> public boolean isAddBeanTypeProperties() {<a name="line.288"></a> <span class="sourceLineNo">289</span> return addBeanTypeProperties;<a name="line.289"></a> <span class="sourceLineNo">290</span> }<a name="line.290"></a> <span class="sourceLineNo">291</span><a name="line.291"></a> @@ -710,7 +710,7 @@ <span class="sourceLineNo">702</span> if (eType == aType)<a name="line.702"></a> <span class="sourceLineNo">703</span> return null;<a name="line.703"></a> <span class="sourceLineNo">704</span><a name="line.704"></a> -<span class="sourceLineNo">705</span> if (! addBeanTypeProperties)<a name="line.705"></a> +<span class="sourceLineNo">705</span> if (! isAddBeanTypeProperties())<a name="line.705"></a> <span class="sourceLineNo">706</span> return null;<a name="line.706"></a> <span class="sourceLineNo">707</span><a name="line.707"></a> <span class="sourceLineNo">708</span> String eTypeTn = eType.getDictionaryName();<a name="line.708"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UonSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UonSerializerContext.html b/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UonSerializerContext.html index 55ad704..e372a52 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UonSerializerContext.html +++ b/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UonSerializerContext.html @@ -59,30 +59,52 @@ <span class="sourceLineNo">051</span> */<a name="line.51"></a> <span class="sourceLineNo">052</span> public static final String UON_encodeChars = "UonSerializer.encodeChars";<a name="line.52"></a> <span class="sourceLineNo">053</span><a name="line.53"></a> -<span class="sourceLineNo">054</span><a name="line.54"></a> -<span class="sourceLineNo">055</span> final boolean<a name="line.55"></a> -<span class="sourceLineNo">056</span> encodeChars;<a name="line.56"></a> -<span class="sourceLineNo">057</span><a name="line.57"></a> -<span class="sourceLineNo">058</span> /**<a name="line.58"></a> -<span class="sourceLineNo">059</span> * Constructor.<a name="line.59"></a> -<span class="sourceLineNo">060</span> * <p><a name="line.60"></a> -<span class="sourceLineNo">061</span> * Typically only called from {@link ContextFactory#getContext(Class)}.<a name="line.61"></a> -<span class="sourceLineNo">062</span> *<a name="line.62"></a> -<span class="sourceLineNo">063</span> * @param cf The factory that created this context.<a name="line.63"></a> -<span class="sourceLineNo">064</span> */<a name="line.64"></a> -<span class="sourceLineNo">065</span> public UonSerializerContext(ContextFactory cf) {<a name="line.65"></a> -<span class="sourceLineNo">066</span> super(cf);<a name="line.66"></a> -<span class="sourceLineNo">067</span> encodeChars = cf.getProperty(UON_encodeChars, boolean.class, false);<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> @Override /* Context */<a name="line.70"></a> -<span class="sourceLineNo">071</span> public ObjectMap asMap() {<a name="line.71"></a> -<span class="sourceLineNo">072</span> return super.asMap()<a name="line.72"></a> -<span class="sourceLineNo">073</span> .append("UonSerializerContext", new ObjectMap()<a name="line.73"></a> -<span class="sourceLineNo">074</span> .append("encodeChars", encodeChars)<a name="line.74"></a> -<span class="sourceLineNo">075</span> );<a name="line.75"></a> -<span class="sourceLineNo">076</span> }<a name="line.76"></a> -<span class="sourceLineNo">077</span>}<a name="line.77"></a> +<span class="sourceLineNo">054</span> /**<a name="line.54"></a> +<span class="sourceLineNo">055</span> * <b>Configuration property:</b> Add <js>"_type"</js> properties when needed.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> +<span class="sourceLineNo">057</span> * <ul><a name="line.57"></a> +<span class="sourceLineNo">058</span> * <li><b>Name:</b> <js>"UonSerializer.addBeanTypeProperties"</js><a name="line.58"></a> +<span class="sourceLineNo">059</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.59"></a> +<span class="sourceLineNo">060</span> * <li><b>Default:</b> <jk>false</jk><a name="line.60"></a> +<span class="sourceLineNo">061</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.61"></a> +<span class="sourceLineNo">062</span> * </ul><a name="line.62"></a> +<span class="sourceLineNo">063</span> * <p><a name="line.63"></a> +<span class="sourceLineNo">064</span> * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred through reflection.<a name="line.64"></a> +<span class="sourceLineNo">065</span> * This is used to recreate the correct objects during parsing if the object types cannot be inferred.<a name="line.65"></a> +<span class="sourceLineNo">066</span> * For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined from the value type.<a name="line.66"></a> +<span class="sourceLineNo">067</span> * <p><a name="line.67"></a> +<span class="sourceLineNo">068</span> * When present, this value overrides the {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is<a name="line.68"></a> +<span class="sourceLineNo">069</span> * provided to customize the behavior of specific serializers in a {@link SerializerGroup}.<a name="line.69"></a> +<span class="sourceLineNo">070</span> */<a name="line.70"></a> +<span class="sourceLineNo">071</span> public static final String UON_addBeanTypeProperties = "UonSerializer.addBeanTypeProperties";<a name="line.71"></a> +<span class="sourceLineNo">072</span><a name="line.72"></a> +<span class="sourceLineNo">073</span><a name="line.73"></a> +<span class="sourceLineNo">074</span> final boolean<a name="line.74"></a> +<span class="sourceLineNo">075</span> encodeChars,<a name="line.75"></a> +<span class="sourceLineNo">076</span> addBeanTypeProperties;<a name="line.76"></a> +<span class="sourceLineNo">077</span><a name="line.77"></a> +<span class="sourceLineNo">078</span> /**<a name="line.78"></a> +<span class="sourceLineNo">079</span> * Constructor.<a name="line.79"></a> +<span class="sourceLineNo">080</span> * <p><a name="line.80"></a> +<span class="sourceLineNo">081</span> * Typically only called from {@link ContextFactory#getContext(Class)}.<a name="line.81"></a> +<span class="sourceLineNo">082</span> *<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @param cf The factory that created this context.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> public UonSerializerContext(ContextFactory cf) {<a name="line.85"></a> +<span class="sourceLineNo">086</span> super(cf);<a name="line.86"></a> +<span class="sourceLineNo">087</span> encodeChars = cf.getProperty(UON_encodeChars, boolean.class, false);<a name="line.87"></a> +<span class="sourceLineNo">088</span> addBeanTypeProperties = cf.getProperty(UON_addBeanTypeProperties, boolean.class, cf.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));<a name="line.88"></a> +<span class="sourceLineNo">089</span> }<a name="line.89"></a> +<span class="sourceLineNo">090</span><a name="line.90"></a> +<span class="sourceLineNo">091</span> @Override /* Context */<a name="line.91"></a> +<span class="sourceLineNo">092</span> public ObjectMap asMap() {<a name="line.92"></a> +<span class="sourceLineNo">093</span> return super.asMap()<a name="line.93"></a> +<span class="sourceLineNo">094</span> .append("UonSerializerContext", new ObjectMap()<a name="line.94"></a> +<span class="sourceLineNo">095</span> .append("encodeChars", encodeChars)<a name="line.95"></a> +<span class="sourceLineNo">096</span> .append("addBeanTypeProperties", addBeanTypeProperties)<a name="line.96"></a> +<span class="sourceLineNo">097</span> );<a name="line.97"></a> +<span class="sourceLineNo">098</span> }<a name="line.98"></a> +<span class="sourceLineNo">099</span>}<a name="line.99"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UonSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UonSerializerSession.html b/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UonSerializerSession.html index 2f934e3..99c8201 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UonSerializerSession.html +++ b/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UonSerializerSession.html @@ -20,65 +20,80 @@ <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> <span class="sourceLineNo">013</span>package org.apache.juneau.urlencoding;<a name="line.13"></a> <span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import static org.apache.juneau.urlencoding.UonSerializerContext.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span><a name="line.16"></a> -<span class="sourceLineNo">017</span>import java.lang.reflect.*;<a name="line.17"></a> -<span class="sourceLineNo">018</span>import java.util.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.juneau.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.json.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.juneau.serializer.*;<a name="line.22"></a> -<span class="sourceLineNo">023</span><a name="line.23"></a> -<span class="sourceLineNo">024</span>/**<a name="line.24"></a> -<span class="sourceLineNo">025</span> * Session object that lives for the duration of a single use of {@link UonSerializer}.<a name="line.25"></a> -<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> -<span class="sourceLineNo">027</span> * This class is NOT thread safe. It is meant to be discarded after one-time use.<a name="line.27"></a> -<span class="sourceLineNo">028</span> */<a name="line.28"></a> -<span class="sourceLineNo">029</span>public class UonSerializerSession extends SerializerSession {<a name="line.29"></a> -<span class="sourceLineNo">030</span><a name="line.30"></a> -<span class="sourceLineNo">031</span> private final boolean encodeChars;<a name="line.31"></a> -<span class="sourceLineNo">032</span><a name="line.32"></a> -<span class="sourceLineNo">033</span> /**<a name="line.33"></a> -<span class="sourceLineNo">034</span> * Create a new session using properties specified in the context.<a name="line.34"></a> -<span class="sourceLineNo">035</span> *<a name="line.35"></a> -<span class="sourceLineNo">036</span> * @param ctx The context creating this session object.<a name="line.36"></a> -<span class="sourceLineNo">037</span> * The context contains all the configuration settings for this object.<a name="line.37"></a> -<span class="sourceLineNo">038</span> * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.<a name="line.38"></a> -<span class="sourceLineNo">039</span> * @param op The override properties.<a name="line.39"></a> -<span class="sourceLineNo">040</span> * These override any context properties defined in the context.<a name="line.40"></a> -<span class="sourceLineNo">041</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.41"></a> -<span class="sourceLineNo">042</span> * @param locale The session locale.<a name="line.42"></a> -<span class="sourceLineNo">043</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.43"></a> -<span class="sourceLineNo">044</span> * @param timeZone The session timezone.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.45"></a> -<span class="sourceLineNo">046</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.46"></a> -<span class="sourceLineNo">047</span> */<a name="line.47"></a> -<span class="sourceLineNo">048</span> protected UonSerializerSession(UonSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.48"></a> -<span class="sourceLineNo">049</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.49"></a> -<span class="sourceLineNo">050</span> if (op == null || op.isEmpty()) {<a name="line.50"></a> -<span class="sourceLineNo">051</span> encodeChars = ctx.encodeChars;<a name="line.51"></a> -<span class="sourceLineNo">052</span> } else {<a name="line.52"></a> -<span class="sourceLineNo">053</span> encodeChars = op.getBoolean(UON_encodeChars, ctx.encodeChars);<a name="line.53"></a> -<span class="sourceLineNo">054</span> }<a name="line.54"></a> -<span class="sourceLineNo">055</span> }<a name="line.55"></a> -<span class="sourceLineNo">056</span><a name="line.56"></a> -<span class="sourceLineNo">057</span> @Override /* SerializerSession */<a name="line.57"></a> -<span class="sourceLineNo">058</span> public final UonWriter getWriter() throws Exception {<a name="line.58"></a> -<span class="sourceLineNo">059</span> Object output = getOutput();<a name="line.59"></a> -<span class="sourceLineNo">060</span> if (output instanceof UonWriter)<a name="line.60"></a> -<span class="sourceLineNo">061</span> return (UonWriter)output;<a name="line.61"></a> -<span class="sourceLineNo">062</span> return new UonWriter(this, super.getWriter(), isUseWhitespace(), isEncodeChars(), isTrimStrings(), getRelativeUriBase(), getAbsolutePathUriBase());<a name="line.62"></a> -<span class="sourceLineNo">063</span> }<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> /**<a name="line.65"></a> -<span class="sourceLineNo">066</span> * Returns the {@link UonSerializerContext#UON_encodeChars} setting value for this session.<a name="line.66"></a> -<span class="sourceLineNo">067</span> *<a name="line.67"></a> -<span class="sourceLineNo">068</span> * @return The {@link UonSerializerContext#UON_encodeChars} setting value for this session.<a name="line.68"></a> -<span class="sourceLineNo">069</span> */<a name="line.69"></a> -<span class="sourceLineNo">070</span> public final boolean isEncodeChars() {<a name="line.70"></a> -<span class="sourceLineNo">071</span> return encodeChars;<a name="line.71"></a> -<span class="sourceLineNo">072</span> }<a name="line.72"></a> -<span class="sourceLineNo">073</span>}<a name="line.73"></a> +<span class="sourceLineNo">015</span>import static org.apache.juneau.msgpack.MsgPackSerializerContext.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import static org.apache.juneau.urlencoding.UonSerializerContext.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>import java.lang.reflect.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.util.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.json.*;<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> * Session object that lives for the duration of a single use of {@link UonSerializer}.<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> +<span class="sourceLineNo">028</span> * This class is NOT thread safe. It is meant to be discarded after one-time use.<a name="line.28"></a> +<span class="sourceLineNo">029</span> */<a name="line.29"></a> +<span class="sourceLineNo">030</span>public class UonSerializerSession extends SerializerSession {<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span> private final boolean<a name="line.32"></a> +<span class="sourceLineNo">033</span> encodeChars,<a name="line.33"></a> +<span class="sourceLineNo">034</span> addBeanTypeProperties;<a name="line.34"></a> +<span class="sourceLineNo">035</span><a name="line.35"></a> +<span class="sourceLineNo">036</span> /**<a name="line.36"></a> +<span class="sourceLineNo">037</span> * Create a new session using properties specified in the context.<a name="line.37"></a> +<span class="sourceLineNo">038</span> *<a name="line.38"></a> +<span class="sourceLineNo">039</span> * @param ctx The context creating this session object.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * The context contains all the configuration settings for this object.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * @param op The override properties.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * These override any context properties defined in the context.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.44"></a> +<span class="sourceLineNo">045</span> * @param locale The session locale.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * @param timeZone The session timezone.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.48"></a> +<span class="sourceLineNo">049</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.49"></a> +<span class="sourceLineNo">050</span> */<a name="line.50"></a> +<span class="sourceLineNo">051</span> protected UonSerializerSession(UonSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.51"></a> +<span class="sourceLineNo">052</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.52"></a> +<span class="sourceLineNo">053</span> if (op == null || op.isEmpty()) {<a name="line.53"></a> +<span class="sourceLineNo">054</span> encodeChars = ctx.encodeChars;<a name="line.54"></a> +<span class="sourceLineNo">055</span> addBeanTypeProperties = ctx.addBeanTypeProperties;<a name="line.55"></a> +<span class="sourceLineNo">056</span> } else {<a name="line.56"></a> +<span class="sourceLineNo">057</span> encodeChars = op.getBoolean(UON_encodeChars, ctx.encodeChars);<a name="line.57"></a> +<span class="sourceLineNo">058</span> addBeanTypeProperties = op.getBoolean(MSGPACK_addBeanTypeProperties, ctx.addBeanTypeProperties);<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><a name="line.61"></a> +<span class="sourceLineNo">062</span> /**<a name="line.62"></a> +<span class="sourceLineNo">063</span> * Returns the {@link UonSerializerContext#UON_encodeChars} setting value for this session.<a name="line.63"></a> +<span class="sourceLineNo">064</span> *<a name="line.64"></a> +<span class="sourceLineNo">065</span> * @return The {@link UonSerializerContext#UON_encodeChars} setting value for this session.<a name="line.65"></a> +<span class="sourceLineNo">066</span> */<a name="line.66"></a> +<span class="sourceLineNo">067</span> public final boolean isEncodeChars() {<a name="line.67"></a> +<span class="sourceLineNo">068</span> return encodeChars;<a name="line.68"></a> +<span class="sourceLineNo">069</span> }<a name="line.69"></a> +<span class="sourceLineNo">070</span><a name="line.70"></a> +<span class="sourceLineNo">071</span> /**<a name="line.71"></a> +<span class="sourceLineNo">072</span> * Returns the {@link UonSerializerContext#UON_addBeanTypeProperties} setting value for this session.<a name="line.72"></a> +<span class="sourceLineNo">073</span> *<a name="line.73"></a> +<span class="sourceLineNo">074</span> * @return The {@link UonSerializerContext#UON_addBeanTypeProperties} setting value for this session.<a name="line.74"></a> +<span class="sourceLineNo">075</span> */<a name="line.75"></a> +<span class="sourceLineNo">076</span> @Override /* SerializerSession */<a name="line.76"></a> +<span class="sourceLineNo">077</span> public final boolean isAddBeanTypeProperties() {<a name="line.77"></a> +<span class="sourceLineNo">078</span> return addBeanTypeProperties;<a name="line.78"></a> +<span class="sourceLineNo">079</span> }<a name="line.79"></a> +<span class="sourceLineNo">080</span><a name="line.80"></a> +<span class="sourceLineNo">081</span> @Override /* SerializerSession */<a name="line.81"></a> +<span class="sourceLineNo">082</span> public final UonWriter getWriter() throws Exception {<a name="line.82"></a> +<span class="sourceLineNo">083</span> Object output = getOutput();<a name="line.83"></a> +<span class="sourceLineNo">084</span> if (output instanceof UonWriter)<a name="line.84"></a> +<span class="sourceLineNo">085</span> return (UonWriter)output;<a name="line.85"></a> +<span class="sourceLineNo">086</span> return new UonWriter(this, super.getWriter(), isUseWhitespace(), isEncodeChars(), isTrimStrings(), getRelativeUriBase(), getAbsolutePathUriBase());<a name="line.86"></a> +<span class="sourceLineNo">087</span> }<a name="line.87"></a> +<span class="sourceLineNo">088</span>}<a name="line.88"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSerializerContext.html b/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSerializerContext.html index 7f73a75..d6cede1 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSerializerContext.html +++ b/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSerializerContext.html @@ -146,49 +146,71 @@ <span class="sourceLineNo">138</span> */<a name="line.138"></a> <span class="sourceLineNo">139</span> public static final String XML_namespaces = "XmlSerializer.namespaces.list";<a name="line.139"></a> <span class="sourceLineNo">140</span><a name="line.140"></a> -<span class="sourceLineNo">141</span><a name="line.141"></a> -<span class="sourceLineNo">142</span> final boolean<a name="line.142"></a> -<span class="sourceLineNo">143</span> autoDetectNamespaces,<a name="line.143"></a> -<span class="sourceLineNo">144</span> enableNamespaces,<a name="line.144"></a> -<span class="sourceLineNo">145</span> addNamespaceUrlsToRoot;<a name="line.145"></a> -<span class="sourceLineNo">146</span><a name="line.146"></a> -<span class="sourceLineNo">147</span> final String defaultNamespace;<a name="line.147"></a> -<span class="sourceLineNo">148</span><a name="line.148"></a> -<span class="sourceLineNo">149</span> final Namespace<a name="line.149"></a> -<span class="sourceLineNo">150</span> xsNamespace;<a name="line.150"></a> -<span class="sourceLineNo">151</span><a name="line.151"></a> -<span class="sourceLineNo">152</span> final Namespace[] namespaces;<a name="line.152"></a> -<span class="sourceLineNo">153</span><a name="line.153"></a> -<span class="sourceLineNo">154</span> /**<a name="line.154"></a> -<span class="sourceLineNo">155</span> * Constructor.<a name="line.155"></a> -<span class="sourceLineNo">156</span> * <p><a name="line.156"></a> -<span class="sourceLineNo">157</span> * Typically only called from {@link ContextFactory#getContext(Class)}.<a name="line.157"></a> -<span class="sourceLineNo">158</span> *<a name="line.158"></a> -<span class="sourceLineNo">159</span> * @param cf The factory that created this context.<a name="line.159"></a> -<span class="sourceLineNo">160</span> */<a name="line.160"></a> -<span class="sourceLineNo">161</span> public XmlSerializerContext(ContextFactory cf) {<a name="line.161"></a> -<span class="sourceLineNo">162</span> super(cf);<a name="line.162"></a> -<span class="sourceLineNo">163</span> autoDetectNamespaces = cf.getProperty(XML_autoDetectNamespaces, boolean.class, true);<a name="line.163"></a> -<span class="sourceLineNo">164</span> enableNamespaces = cf.getProperty(XML_enableNamespaces, boolean.class, false);<a name="line.164"></a> -<span class="sourceLineNo">165</span> addNamespaceUrlsToRoot = cf.getProperty(XML_addNamespaceUrisToRoot, boolean.class, false);<a name="line.165"></a> -<span class="sourceLineNo">166</span> defaultNamespace = cf.getProperty(XML_defaultNamespace, String.class, "{juneau:'http://www.apache.org/2013/Juneau'}");<a name="line.166"></a> -<span class="sourceLineNo">167</span> xsNamespace = cf.getProperty(XML_xsNamespace, Namespace.class, new Namespace("xs", "http://www.w3.org/2001/XMLSchema"));<a name="line.167"></a> -<span class="sourceLineNo">168</span> namespaces = cf.getProperty(XML_namespaces, Namespace[].class, new Namespace[0]);<a name="line.168"></a> -<span class="sourceLineNo">169</span> }<a name="line.169"></a> -<span class="sourceLineNo">170</span><a name="line.170"></a> -<span class="sourceLineNo">171</span> @Override /* Context */<a name="line.171"></a> -<span class="sourceLineNo">172</span> public ObjectMap asMap() {<a name="line.172"></a> -<span class="sourceLineNo">173</span> return super.asMap()<a name="line.173"></a> -<span class="sourceLineNo">174</span> .append("XmlSerializerContext", new ObjectMap()<a name="line.174"></a> -<span class="sourceLineNo">175</span> .append("autoDetectNamespaces", autoDetectNamespaces)<a name="line.175"></a> -<span class="sourceLineNo">176</span> .append("enableNamespaces", enableNamespaces)<a name="line.176"></a> -<span class="sourceLineNo">177</span> .append("addNamespaceUrlsToRoot", addNamespaceUrlsToRoot)<a name="line.177"></a> -<span class="sourceLineNo">178</span> .append("defaultNamespace", defaultNamespace)<a name="line.178"></a> -<span class="sourceLineNo">179</span> .append("xsNamespace", xsNamespace)<a name="line.179"></a> -<span class="sourceLineNo">180</span> .append("namespaces", namespaces)<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>}<a name="line.183"></a> +<span class="sourceLineNo">141</span> /**<a name="line.141"></a> +<span class="sourceLineNo">142</span> * <b>Configuration property:</b> Add <js>"_type"</js> properties when needed.<a name="line.142"></a> +<span class="sourceLineNo">143</span> * <p><a name="line.143"></a> +<span class="sourceLineNo">144</span> * <ul><a name="line.144"></a> +<span class="sourceLineNo">145</span> * <li><b>Name:</b> <js>"XmlSerializer.addBeanTypeProperties"</js><a name="line.145"></a> +<span class="sourceLineNo">146</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.146"></a> +<span class="sourceLineNo">147</span> * <li><b>Default:</b> <jk>false</jk><a name="line.147"></a> +<span class="sourceLineNo">148</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.148"></a> +<span class="sourceLineNo">149</span> * </ul><a name="line.149"></a> +<span class="sourceLineNo">150</span> * <p><a name="line.150"></a> +<span class="sourceLineNo">151</span> * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred through reflection.<a name="line.151"></a> +<span class="sourceLineNo">152</span> * This is used to recreate the correct objects during parsing if the object types cannot be inferred.<a name="line.152"></a> +<span class="sourceLineNo">153</span> * For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined from the value type.<a name="line.153"></a> +<span class="sourceLineNo">154</span> * <p><a name="line.154"></a> +<span class="sourceLineNo">155</span> * When present, this value overrides the {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is<a name="line.155"></a> +<span class="sourceLineNo">156</span> * provided to customize the behavior of specific serializers in a {@link SerializerGroup}.<a name="line.156"></a> +<span class="sourceLineNo">157</span> */<a name="line.157"></a> +<span class="sourceLineNo">158</span> public static final String XML_addBeanTypeProperties = "XmlSerializer.addBeanTypeProperties";<a name="line.158"></a> +<span class="sourceLineNo">159</span><a name="line.159"></a> +<span class="sourceLineNo">160</span><a name="line.160"></a> +<span class="sourceLineNo">161</span> final boolean<a name="line.161"></a> +<span class="sourceLineNo">162</span> autoDetectNamespaces,<a name="line.162"></a> +<span class="sourceLineNo">163</span> enableNamespaces,<a name="line.163"></a> +<span class="sourceLineNo">164</span> addNamespaceUrlsToRoot,<a name="line.164"></a> +<span class="sourceLineNo">165</span> addBeanTypeProperties;<a name="line.165"></a> +<span class="sourceLineNo">166</span><a name="line.166"></a> +<span class="sourceLineNo">167</span> final String defaultNamespace;<a name="line.167"></a> +<span class="sourceLineNo">168</span><a name="line.168"></a> +<span class="sourceLineNo">169</span> final Namespace<a name="line.169"></a> +<span class="sourceLineNo">170</span> xsNamespace;<a name="line.170"></a> +<span class="sourceLineNo">171</span><a name="line.171"></a> +<span class="sourceLineNo">172</span> final Namespace[] namespaces;<a name="line.172"></a> +<span class="sourceLineNo">173</span><a name="line.173"></a> +<span class="sourceLineNo">174</span> /**<a name="line.174"></a> +<span class="sourceLineNo">175</span> * Constructor.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * <p><a name="line.176"></a> +<span class="sourceLineNo">177</span> * Typically only called from {@link ContextFactory#getContext(Class)}.<a name="line.177"></a> +<span class="sourceLineNo">178</span> *<a name="line.178"></a> +<span class="sourceLineNo">179</span> * @param cf The factory that created this context.<a name="line.179"></a> +<span class="sourceLineNo">180</span> */<a name="line.180"></a> +<span class="sourceLineNo">181</span> public XmlSerializerContext(ContextFactory cf) {<a name="line.181"></a> +<span class="sourceLineNo">182</span> super(cf);<a name="line.182"></a> +<span class="sourceLineNo">183</span> autoDetectNamespaces = cf.getProperty(XML_autoDetectNamespaces, boolean.class, true);<a name="line.183"></a> +<span class="sourceLineNo">184</span> enableNamespaces = cf.getProperty(XML_enableNamespaces, boolean.class, false);<a name="line.184"></a> +<span class="sourceLineNo">185</span> addNamespaceUrlsToRoot = cf.getProperty(XML_addNamespaceUrisToRoot, boolean.class, false);<a name="line.185"></a> +<span class="sourceLineNo">186</span> defaultNamespace = cf.getProperty(XML_defaultNamespace, String.class, "{juneau:'http://www.apache.org/2013/Juneau'}");<a name="line.186"></a> +<span class="sourceLineNo">187</span> xsNamespace = cf.getProperty(XML_xsNamespace, Namespace.class, new Namespace("xs", "http://www.w3.org/2001/XMLSchema"));<a name="line.187"></a> +<span class="sourceLineNo">188</span> namespaces = cf.getProperty(XML_namespaces, Namespace[].class, new Namespace[0]);<a name="line.188"></a> +<span class="sourceLineNo">189</span> addBeanTypeProperties = cf.getProperty(XML_addBeanTypeProperties, boolean.class, cf.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));<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> @Override /* Context */<a name="line.192"></a> +<span class="sourceLineNo">193</span> public ObjectMap asMap() {<a name="line.193"></a> +<span class="sourceLineNo">194</span> return super.asMap()<a name="line.194"></a> +<span class="sourceLineNo">195</span> .append("XmlSerializerContext", new ObjectMap()<a name="line.195"></a> +<span class="sourceLineNo">196</span> .append("autoDetectNamespaces", autoDetectNamespaces)<a name="line.196"></a> +<span class="sourceLineNo">197</span> .append("enableNamespaces", enableNamespaces)<a name="line.197"></a> +<span class="sourceLineNo">198</span> .append("addNamespaceUrlsToRoot", addNamespaceUrlsToRoot)<a name="line.198"></a> +<span class="sourceLineNo">199</span> .append("defaultNamespace", defaultNamespace)<a name="line.199"></a> +<span class="sourceLineNo">200</span> .append("xsNamespace", xsNamespace)<a name="line.200"></a> +<span class="sourceLineNo">201</span> .append("namespaces", namespaces)<a name="line.201"></a> +<span class="sourceLineNo">202</span> .append("addBeanTypeProperties", addBeanTypeProperties)<a name="line.202"></a> +<span class="sourceLineNo">203</span> );<a name="line.203"></a> +<span class="sourceLineNo">204</span> }<a name="line.204"></a> +<span class="sourceLineNo">205</span>}<a name="line.205"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSerializerSession.html b/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSerializerSession.html index 501fcf0..bfb5ea6 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSerializerSession.html +++ b/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSerializerSession.html @@ -20,167 +20,181 @@ <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> <span class="sourceLineNo">013</span>package org.apache.juneau.xml;<a name="line.13"></a> <span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import static org.apache.juneau.xml.NamespaceFactory.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span>import static org.apache.juneau.xml.XmlSerializerContext.*;<a name="line.16"></a> -<span class="sourceLineNo">017</span><a name="line.17"></a> -<span class="sourceLineNo">018</span>import java.lang.reflect.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span>import java.util.*;<a name="line.19"></a> -<span class="sourceLineNo">020</span><a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.juneau.internal.*;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.juneau.json.*;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.juneau.serializer.*;<a name="line.24"></a> -<span class="sourceLineNo">025</span><a name="line.25"></a> -<span class="sourceLineNo">026</span>/**<a name="line.26"></a> -<span class="sourceLineNo">027</span> * Session object that lives for the duration of a single use of {@link XmlSerializer}.<a name="line.27"></a> -<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> -<span class="sourceLineNo">029</span> * This class is NOT thread safe. It is meant to be discarded after one-time use.<a name="line.29"></a> -<span class="sourceLineNo">030</span> */<a name="line.30"></a> -<span class="sourceLineNo">031</span>@SuppressWarnings("hiding")<a name="line.31"></a> -<span class="sourceLineNo">032</span>public class XmlSerializerSession extends SerializerSession {<a name="line.32"></a> -<span class="sourceLineNo">033</span><a name="line.33"></a> -<span class="sourceLineNo">034</span> private final boolean<a name="line.34"></a> -<span class="sourceLineNo">035</span> autoDetectNamespaces,<a name="line.35"></a> -<span class="sourceLineNo">036</span> enableNamespaces,<a name="line.36"></a> -<span class="sourceLineNo">037</span> addNamespaceUrlsToRoot;<a name="line.37"></a> -<span class="sourceLineNo">038</span><a name="line.38"></a> -<span class="sourceLineNo">039</span> private Namespace<a name="line.39"></a> -<span class="sourceLineNo">040</span> defaultNamespace;<a name="line.40"></a> -<span class="sourceLineNo">041</span> private final Namespace<a name="line.41"></a> -<span class="sourceLineNo">042</span> xsNamespace;<a name="line.42"></a> -<span class="sourceLineNo">043</span><a name="line.43"></a> -<span class="sourceLineNo">044</span> private Namespace[] namespaces = new Namespace[0];<a name="line.44"></a> +<span class="sourceLineNo">015</span>import static org.apache.juneau.msgpack.MsgPackSerializerContext.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import static org.apache.juneau.xml.NamespaceFactory.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span>import static org.apache.juneau.xml.XmlSerializerContext.*;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.lang.reflect.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.util.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.juneau.internal.*;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.juneau.json.*;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.juneau.serializer.*;<a name="line.25"></a> +<span class="sourceLineNo">026</span><a name="line.26"></a> +<span class="sourceLineNo">027</span>/**<a name="line.27"></a> +<span class="sourceLineNo">028</span> * Session object that lives for the duration of a single use of {@link XmlSerializer}.<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <p><a name="line.29"></a> +<span class="sourceLineNo">030</span> * This class is NOT thread safe. It is meant to be discarded after one-time use.<a name="line.30"></a> +<span class="sourceLineNo">031</span> */<a name="line.31"></a> +<span class="sourceLineNo">032</span>@SuppressWarnings("hiding")<a name="line.32"></a> +<span class="sourceLineNo">033</span>public class XmlSerializerSession extends SerializerSession {<a name="line.33"></a> +<span class="sourceLineNo">034</span><a name="line.34"></a> +<span class="sourceLineNo">035</span> private final boolean<a name="line.35"></a> +<span class="sourceLineNo">036</span> autoDetectNamespaces,<a name="line.36"></a> +<span class="sourceLineNo">037</span> enableNamespaces,<a name="line.37"></a> +<span class="sourceLineNo">038</span> addNamespaceUrlsToRoot,<a name="line.38"></a> +<span class="sourceLineNo">039</span> addBeanTypeProperties;<a name="line.39"></a> +<span class="sourceLineNo">040</span><a name="line.40"></a> +<span class="sourceLineNo">041</span> private Namespace<a name="line.41"></a> +<span class="sourceLineNo">042</span> defaultNamespace;<a name="line.42"></a> +<span class="sourceLineNo">043</span> private final Namespace<a name="line.43"></a> +<span class="sourceLineNo">044</span> xsNamespace;<a name="line.44"></a> <span class="sourceLineNo">045</span><a name="line.45"></a> -<span class="sourceLineNo">046</span> /**<a name="line.46"></a> -<span class="sourceLineNo">047</span> * Create a new session using properties specified in the context.<a name="line.47"></a> -<span class="sourceLineNo">048</span> *<a name="line.48"></a> -<span class="sourceLineNo">049</span> * @param ctx The context creating this session object.<a name="line.49"></a> -<span class="sourceLineNo">050</span> * The context contains all the configuration settings for this object.<a name="line.50"></a> -<span class="sourceLineNo">051</span> * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.<a name="line.51"></a> -<span class="sourceLineNo">052</span> * @param op The override properties.<a name="line.52"></a> -<span class="sourceLineNo">053</span> * These override any context properties defined in the context.<a name="line.53"></a> -<span class="sourceLineNo">054</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.54"></a> -<span class="sourceLineNo">055</span> * @param locale The session locale.<a name="line.55"></a> -<span class="sourceLineNo">056</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * @param timeZone The session timezone.<a name="line.57"></a> -<span class="sourceLineNo">058</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.58"></a> -<span class="sourceLineNo">059</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.59"></a> -<span class="sourceLineNo">060</span> */<a name="line.60"></a> -<span class="sourceLineNo">061</span> public XmlSerializerSession(XmlSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.61"></a> -<span class="sourceLineNo">062</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.62"></a> -<span class="sourceLineNo">063</span> if (op == null || op.isEmpty()) {<a name="line.63"></a> -<span class="sourceLineNo">064</span> enableNamespaces = ctx.enableNamespaces;<a name="line.64"></a> -<span class="sourceLineNo">065</span> autoDetectNamespaces = ctx.autoDetectNamespaces;<a name="line.65"></a> -<span class="sourceLineNo">066</span> addNamespaceUrlsToRoot = ctx.addNamespaceUrlsToRoot;<a name="line.66"></a> -<span class="sourceLineNo">067</span> addNamespaces(ctx.namespaces);<a name="line.67"></a> -<span class="sourceLineNo">068</span> defaultNamespace = findDefaultNamespace(ctx.defaultNamespace);<a name="line.68"></a> -<span class="sourceLineNo">069</span> xsNamespace = ctx.xsNamespace;<a name="line.69"></a> -<span class="sourceLineNo">070</span> } else {<a name="line.70"></a> -<span class="sourceLineNo">071</span> enableNamespaces = op.getBoolean(XML_enableNamespaces, ctx.enableNamespaces);<a name="line.71"></a> -<span class="sourceLineNo">072</span> autoDetectNamespaces = op.getBoolean(XML_autoDetectNamespaces, ctx.autoDetectNamespaces);<a name="line.72"></a> -<span class="sourceLineNo">073</span> addNamespaceUrlsToRoot = op.getBoolean(XML_addNamespaceUrisToRoot, ctx.addNamespaceUrlsToRoot);<a name="line.73"></a> -<span class="sourceLineNo">074</span> namespaces = (op.containsKey(XML_namespaces) ? parseNamespaces(op.get(XML_namespaces)) : ctx.namespaces);<a name="line.74"></a> -<span class="sourceLineNo">075</span> defaultNamespace = findDefaultNamespace(op.containsKey(XML_defaultNamespace) ? op.getString(XML_defaultNamespace) : ctx.defaultNamespace);<a name="line.75"></a> -<span class="sourceLineNo">076</span> xsNamespace = (op.containsKey(XML_xsNamespace) ? parseNamespace(op.get(XML_xsNamespace)) : ctx.xsNamespace);<a name="line.76"></a> -<span class="sourceLineNo">077</span> }<a name="line.77"></a> -<span class="sourceLineNo">078</span> }<a name="line.78"></a> -<span class="sourceLineNo">079</span><a name="line.79"></a> -<span class="sourceLineNo">080</span> private Namespace findDefaultNamespace(String s) {<a name="line.80"></a> -<span class="sourceLineNo">081</span> if (s == null)<a name="line.81"></a> -<span class="sourceLineNo">082</span> return null;<a name="line.82"></a> -<span class="sourceLineNo">083</span> if (StringUtils.startsWith(s, '{'))<a name="line.83"></a> -<span class="sourceLineNo">084</span> return parseNamespace(s);<a name="line.84"></a> -<span class="sourceLineNo">085</span> if (! s.startsWith("http://"))<a name="line.85"></a> -<span class="sourceLineNo">086</span> return get(s, "http://unknown");<a name="line.86"></a> -<span class="sourceLineNo">087</span> return get(null, s);<a name="line.87"></a> -<span class="sourceLineNo">088</span> }<a name="line.88"></a> -<span class="sourceLineNo">089</span><a name="line.89"></a> -<span class="sourceLineNo">090</span> private void addNamespaces(Namespace...namespaces) {<a name="line.90"></a> -<span class="sourceLineNo">091</span> for (Namespace ns : namespaces)<a name="line.91"></a> -<span class="sourceLineNo">092</span> addNamespace(ns);<a name="line.92"></a> -<span class="sourceLineNo">093</span> }<a name="line.93"></a> -<span class="sourceLineNo">094</span><a name="line.94"></a> -<span class="sourceLineNo">095</span> /**<a name="line.95"></a> -<span class="sourceLineNo">096</span> * Add a namespace to this session.<a name="line.96"></a> -<span class="sourceLineNo">097</span> *<a name="line.97"></a> -<span class="sourceLineNo">098</span> * @param ns The namespace being added.<a name="line.98"></a> -<span class="sourceLineNo">099</span> */<a name="line.99"></a> -<span class="sourceLineNo">100</span> public void addNamespace(Namespace ns) {<a name="line.100"></a> -<span class="sourceLineNo">101</span> if (ns == defaultNamespace)<a name="line.101"></a> -<span class="sourceLineNo">102</span> return;<a name="line.102"></a> -<span class="sourceLineNo">103</span><a name="line.103"></a> -<span class="sourceLineNo">104</span> for (Namespace n : namespaces)<a name="line.104"></a> -<span class="sourceLineNo">105</span> if (n == ns)<a name="line.105"></a> -<span class="sourceLineNo">106</span> return;<a name="line.106"></a> +<span class="sourceLineNo">046</span> private Namespace[] namespaces = new Namespace[0];<a name="line.46"></a> +<span class="sourceLineNo">047</span><a name="line.47"></a> +<span class="sourceLineNo">048</span> /**<a name="line.48"></a> +<span class="sourceLineNo">049</span> * Create a new session using properties specified in the context.<a name="line.49"></a> +<span class="sourceLineNo">050</span> *<a name="line.50"></a> +<span class="sourceLineNo">051</span> * @param ctx The context creating this session object.<a name="line.51"></a> +<span class="sourceLineNo">052</span> * The context contains all the configuration settings for this object.<a name="line.52"></a> +<span class="sourceLineNo">053</span> * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.<a name="line.53"></a> +<span class="sourceLineNo">054</span> * @param op The override properties.<a name="line.54"></a> +<span class="sourceLineNo">055</span> * These override any context properties defined in the context.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @param locale The session locale.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @param timeZone The session timezone.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.61"></a> +<span class="sourceLineNo">062</span> */<a name="line.62"></a> +<span class="sourceLineNo">063</span> public XmlSerializerSession(XmlSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.63"></a> +<span class="sourceLineNo">064</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.64"></a> +<span class="sourceLineNo">065</span> if (op == null || op.isEmpty()) {<a name="line.65"></a> +<span class="sourceLineNo">066</span> enableNamespaces = ctx.enableNamespaces;<a name="line.66"></a> +<span class="sourceLineNo">067</span> autoDetectNamespaces = ctx.autoDetectNamespaces;<a name="line.67"></a> +<span class="sourceLineNo">068</span> addNamespaceUrlsToRoot = ctx.addNamespaceUrlsToRoot;<a name="line.68"></a> +<span class="sourceLineNo">069</span> addNamespaces(ctx.namespaces);<a name="line.69"></a> +<span class="sourceLineNo">070</span> defaultNamespace = findDefaultNamespace(ctx.defaultNamespace);<a name="line.70"></a> +<span class="sourceLineNo">071</span> xsNamespace = ctx.xsNamespace;<a name="line.71"></a> +<span class="sourceLineNo">072</span> addBeanTypeProperties = ctx.addBeanTypeProperties;<a name="line.72"></a> +<span class="sourceLineNo">073</span> } else {<a name="line.73"></a> +<span class="sourceLineNo">074</span> enableNamespaces = op.getBoolean(XML_enableNamespaces, ctx.enableNamespaces);<a name="line.74"></a> +<span class="sourceLineNo">075</span> autoDetectNamespaces = op.getBoolean(XML_autoDetectNamespaces, ctx.autoDetectNamespaces);<a name="line.75"></a> +<span class="sourceLineNo">076</span> addNamespaceUrlsToRoot = op.getBoolean(XML_addNamespaceUrisToRoot, ctx.addNamespaceUrlsToRoot);<a name="line.76"></a> +<span class="sourceLineNo">077</span> namespaces = (op.containsKey(XML_namespaces) ? parseNamespaces(op.get(XML_namespaces)) : ctx.namespaces);<a name="line.77"></a> +<span class="sourceLineNo">078</span> defaultNamespace = findDefaultNamespace(op.containsKey(XML_defaultNamespace) ? op.getString(XML_defaultNamespace) : ctx.defaultNamespace);<a name="line.78"></a> +<span class="sourceLineNo">079</span> xsNamespace = (op.containsKey(XML_xsNamespace) ? parseNamespace(op.get(XML_xsNamespace)) : ctx.xsNamespace);<a name="line.79"></a> +<span class="sourceLineNo">080</span> addBeanTypeProperties = op.getBoolean(MSGPACK_addBeanTypeProperties, ctx.addBeanTypeProperties);<a name="line.80"></a> +<span class="sourceLineNo">081</span> }<a name="line.81"></a> +<span class="sourceLineNo">082</span> }<a name="line.82"></a> +<span class="sourceLineNo">083</span><a name="line.83"></a> +<span class="sourceLineNo">084</span> private Namespace findDefaultNamespace(String s) {<a name="line.84"></a> +<span class="sourceLineNo">085</span> if (s == null)<a name="line.85"></a> +<span class="sourceLineNo">086</span> return null;<a name="line.86"></a> +<span class="sourceLineNo">087</span> if (StringUtils.startsWith(s, '{'))<a name="line.87"></a> +<span class="sourceLineNo">088</span> return parseNamespace(s);<a name="line.88"></a> +<span class="sourceLineNo">089</span> if (! s.startsWith("http://"))<a name="line.89"></a> +<span class="sourceLineNo">090</span> return get(s, "http://unknown");<a name="line.90"></a> +<span class="sourceLineNo">091</span> return get(null, s);<a name="line.91"></a> +<span class="sourceLineNo">092</span> }<a name="line.92"></a> +<span class="sourceLineNo">093</span><a name="line.93"></a> +<span class="sourceLineNo">094</span> private void addNamespaces(Namespace...namespaces) {<a name="line.94"></a> +<span class="sourceLineNo">095</span> for (Namespace ns : namespaces)<a name="line.95"></a> +<span class="sourceLineNo">096</span> addNamespace(ns);<a name="line.96"></a> +<span class="sourceLineNo">097</span> }<a name="line.97"></a> +<span class="sourceLineNo">098</span><a name="line.98"></a> +<span class="sourceLineNo">099</span> /**<a name="line.99"></a> +<span class="sourceLineNo">100</span> * Add a namespace to this session.<a name="line.100"></a> +<span class="sourceLineNo">101</span> *<a name="line.101"></a> +<span class="sourceLineNo">102</span> * @param ns The namespace being added.<a name="line.102"></a> +<span class="sourceLineNo">103</span> */<a name="line.103"></a> +<span class="sourceLineNo">104</span> public void addNamespace(Namespace ns) {<a name="line.104"></a> +<span class="sourceLineNo">105</span> if (ns == defaultNamespace)<a name="line.105"></a> +<span class="sourceLineNo">106</span> return;<a name="line.106"></a> <span class="sourceLineNo">107</span><a name="line.107"></a> -<span class="sourceLineNo">108</span> if (defaultNamespace != null && (ns.uri.equals(defaultNamespace.uri) || ns.name.equals(defaultNamespace.name)))<a name="line.108"></a> -<span class="sourceLineNo">109</span> defaultNamespace = ns;<a name="line.109"></a> -<span class="sourceLineNo">110</span> else<a name="line.110"></a> -<span class="sourceLineNo">111</span> namespaces = ArrayUtils.append(namespaces, ns);<a name="line.111"></a> -<span class="sourceLineNo">112</span> }<a name="line.112"></a> -<span class="sourceLineNo">113</span><a name="line.113"></a> -<span class="sourceLineNo">114</span> /**<a name="line.114"></a> -<span class="sourceLineNo">115</span> * Returns the list of namespaces being used in the current XML serialization.<a name="line.115"></a> -<span class="sourceLineNo">116</span> *<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @return The list of namespaces being used in the current XML serialization.<a name="line.117"></a> -<span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> public Namespace[] getNamespaces() {<a name="line.119"></a> -<span class="sourceLineNo">120</span> return namespaces;<a name="line.120"></a> -<span class="sourceLineNo">121</span> }<a name="line.121"></a> -<span class="sourceLineNo">122</span><a name="line.122"></a> -<span class="sourceLineNo">123</span> /**<a name="line.123"></a> -<span class="sourceLineNo">124</span> * Returns the {@link XmlSerializerContext#XML_autoDetectNamespaces} setting value in this context.<a name="line.124"></a> -<span class="sourceLineNo">125</span> *<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @return The {@link XmlSerializerContext#XML_autoDetectNamespaces} setting value in this context.<a name="line.126"></a> -<span class="sourceLineNo">127</span> */<a name="line.127"></a> -<span class="sourceLineNo">128</span> public final boolean isAutoDetectNamespaces() {<a name="line.128"></a> -<span class="sourceLineNo">129</span> return enableNamespaces && autoDetectNamespaces;<a name="line.129"></a> -<span class="sourceLineNo">130</span> }<a name="line.130"></a> -<span class="sourceLineNo">131</span><a name="line.131"></a> -<span class="sourceLineNo">132</span> /**<a name="line.132"></a> -<span class="sourceLineNo">133</span> * Returns the {@link XmlSerializerContext#XML_enableNamespaces} setting value in this context.<a name="line.133"></a> -<span class="sourceLineNo">134</span> *<a name="line.134"></a> -<span class="sourceLineNo">135</span> * @return The {@link XmlSerializerContext#XML_enableNamespaces} setting value in this context.<a name="line.135"></a> -<span class="sourceLineNo">136</span> */<a name="line.136"></a> -<span class="sourceLineNo">137</span> public final boolean isEnableNamespaces() {<a name="line.137"></a> -<span class="sourceLineNo">138</span> return enableNamespaces;<a name="line.138"></a> -<span class="sourceLineNo">139</span> }<a name="line.139"></a> -<span class="sourceLineNo">140</span><a name="line.140"></a> -<span class="sourceLineNo">141</span> /**<a name="line.141"></a> -<span class="sourceLineNo">142</span> * Returns the {@link XmlSerializerContext#XML_addNamespaceUrisToRoot} setting value in this context.<a name="line.142"></a> -<span class="sourceLineNo">143</span> *<a name="line.143"></a> -<span class="sourceLineNo">144</span> * @return The {@link XmlSerializerContext#XML_addNamespaceUrisToRoot} setting value in this context.<a name="line.144"></a> -<span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> public final boolean isAddNamespaceUrlsToRoot() {<a name="line.146"></a> -<span class="sourceLineNo">147</span> return addNamespaceUrlsToRoot;<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> /**<a name="line.150"></a> -<span class="sourceLineNo">151</span> * Returns the {@link XmlSerializerContext#XML_defaultNamespace} setting value in this context.<a name="line.151"></a> -<span class="sourceLineNo">152</span> *<a name="line.152"></a> -<span class="sourceLineNo">153</span> * @return The {@link XmlSerializerContext#XML_defaultNamespace} setting value in this context.<a name="line.153"></a> -<span class="sourceLineNo">154</span> */<a name="line.154"></a> -<span class="sourceLineNo">155</span> public final Namespace getDefaultNamespace() {<a name="line.155"></a> -<span class="sourceLineNo">156</span> return defaultNamespace;<a name="line.156"></a> -<span class="sourceLineNo">157</span> }<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> * Returns the {@link XmlSerializerContext#XML_xsNamespace} setting value in this context.<a name="line.160"></a> -<span class="sourceLineNo">161</span> *<a name="line.161"></a> -<span class="sourceLineNo">162</span> * @return The {@link XmlSerializerContext#XML_xsNamespace} setting value in this context.<a name="line.162"></a> -<span class="sourceLineNo">163</span> */<a name="line.163"></a> -<span class="sourceLineNo">164</span> public final Namespace getXsNamespace() {<a name="line.164"></a> -<span class="sourceLineNo">165</span> return xsNamespace;<a name="line.165"></a> -<span class="sourceLineNo">166</span> }<a name="line.166"></a> -<span class="sourceLineNo">167</span><a name="line.167"></a> -<span class="sourceLineNo">168</span> @Override /* SerializerSession */<a name="line.168"></a> -<span class="sourceLineNo">169</span> public XmlWriter getWriter() throws Exception {<a name="line.169"></a> -<span class="sourceLineNo">170</span> Object output = getOutput();<a name="line.170"></a> -<span class="sourceLineNo">171</span> if (output instanceof XmlWriter)<a name="line.171"></a> -<span class="sourceLineNo">172</span> return (XmlWriter)output;<a name="line.172"></a> -<span class="sourceLineNo">173</span> return new XmlWriter(super.getWriter(), isUseWhitespace(), isTrimStrings(), getQuoteChar(), getRelativeUriBase(), getAbsolutePathUriBase(), isEnableNamespaces(), getDefaultNamespace());<a name="line.173"></a> -<span class="sourceLineNo">174</span> }<a name="line.174"></a> -<span class="sourceLineNo">175</span>}<a name="line.175"></a> +<span class="sourceLineNo">108</span> for (Namespace n : namespaces)<a name="line.108"></a> +<span class="sourceLineNo">109</span> if (n == ns)<a name="line.109"></a> +<span class="sourceLineNo">110</span> return;<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> if (defaultNamespace != null && (ns.uri.equals(defaultNamespace.uri) || ns.name.equals(defaultNamespace.name)))<a name="line.112"></a> +<span class="sourceLineNo">113</span> defaultNamespace = ns;<a name="line.113"></a> +<span class="sourceLineNo">114</span> else<a name="line.114"></a> +<span class="sourceLineNo">115</span> namespaces = ArrayUtils.append(namespaces, ns);<a name="line.115"></a> +<span class="sourceLineNo">116</span> }<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * Returns the list of namespaces being used in the current XML serialization.<a name="line.119"></a> +<span class="sourceLineNo">120</span> *<a name="line.120"></a> +<span class="sourceLineNo">121</span> * @return The list of namespaces being used in the current XML serialization.<a name="line.121"></a> +<span class="sourceLineNo">122</span> */<a name="line.122"></a> +<span class="sourceLineNo">123</span> public Namespace[] getNamespaces() {<a name="line.123"></a> +<span class="sourceLineNo">124</span> return namespaces;<a name="line.124"></a> +<span class="sourceLineNo">125</span> }<a name="line.125"></a> +<span class="sourceLineNo">126</span><a name="line.126"></a> +<span class="sourceLineNo">127</span> /**<a name="line.127"></a> +<span class="sourceLineNo">128</span> * Returns the {@link XmlSerializerContext#XML_autoDetectNamespaces} setting value in this context.<a name="line.128"></a> +<span class="sourceLineNo">129</span> *<a name="line.129"></a> +<span class="sourceLineNo">130</span> * @return The {@link XmlSerializerContext#XML_autoDetectNamespaces} setting value in this context.<a name="line.130"></a> +<span class="sourceLineNo">131</span> */<a name="line.131"></a> +<span class="sourceLineNo">132</span> public final boolean isAutoDetectNamespaces() {<a name="line.132"></a> +<span class="sourceLineNo">133</span> return enableNamespaces && autoDetectNamespaces;<a name="line.133"></a> +<span class="sourceLineNo">134</span> }<a name="line.134"></a> +<span class="sourceLineNo">135</span><a name="line.135"></a> +<span class="sourceLineNo">136</span> /**<a name="line.136"></a> +<span class="sourceLineNo">137</span> * Returns the {@link XmlSerializerContext#XML_enableNamespaces} setting value in this context.<a name="line.137"></a> +<span class="sourceLineNo">138</span> *<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @return The {@link XmlSerializerContext#XML_enableNamespaces} setting value in this context.<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> public final boolean isEnableNamespaces() {<a name="line.141"></a> +<span class="sourceLineNo">142</span> return enableNamespaces;<a name="line.142"></a> +<span class="sourceLineNo">143</span> }<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> * Returns the {@link XmlSerializerContext#XML_addNamespaceUrisToRoot} setting value in this context.<a name="line.146"></a> +<span class="sourceLineNo">147</span> *<a name="line.147"></a> +<span class="sourceLineNo">148</span> * @return The {@link XmlSerializerContext#XML_addNamespaceUrisToRoot} setting value in this context.<a name="line.148"></a> +<span class="sourceLineNo">149</span> */<a name="line.149"></a> +<span class="sourceLineNo">150</span> public final boolean isAddNamespaceUrlsToRoot() {<a name="line.150"></a> +<span class="sourceLineNo">151</span> return addNamespaceUrlsToRoot;<a name="line.151"></a> +<span class="sourceLineNo">152</span> }<a name="line.152"></a> +<span class="sourceLineNo">153</span><a name="line.153"></a> +<span class="sourceLineNo">154</span> /**<a name="line.154"></a> +<span class="sourceLineNo">155</span> * Returns the {@link XmlSerializerContext#XML_addBeanTypeProperties} setting value for this session.<a name="line.155"></a> +<span class="sourceLineNo">156</span> *<a name="line.156"></a> +<span class="sourceLineNo">157</span> * @return The {@link XmlSerializerContext#XML_addBeanTypeProperties} setting value for this session.<a name="line.157"></a> +<span class="sourceLineNo">158</span> */<a name="line.158"></a> +<span class="sourceLineNo">159</span> @Override /* SerializerSession */<a name="line.159"></a> +<span class="sourceLineNo">160</span> public boolean isAddBeanTypeProperties() {<a name="line.160"></a> +<span class="sourceLineNo">161</span> return addBeanTypeProperties;<a name="line.161"></a> +<span class="sourceLineNo">162</span> }<a name="line.162"></a> +<span class="sourceLineNo">163</span><a name="line.163"></a> +<span class="sourceLineNo">164</span> /**<a name="line.164"></a> +<span class="sourceLineNo">165</span> * Returns the {@link XmlSerializerContext#XML_defaultNamespace} setting value in this context.<a name="line.165"></a> +<span class="sourceLineNo">166</span> *<a name="line.166"></a> +<span class="sourceLineNo">167</span> * @return The {@link XmlSerializerContext#XML_defaultNamespace} setting value in this context.<a name="line.167"></a> +<span class="sourceLineNo">168</span> */<a name="line.168"></a> +<span class="sourceLineNo">169</span> public final Namespace getDefaultNamespace() {<a name="line.169"></a> +<span class="sourceLineNo">170</span> return defaultNamespace;<a name="line.170"></a> +<span class="sourceLineNo">171</span> }<a name="line.171"></a> +<span class="sourceLineNo">172</span><a name="line.172"></a> +<span class="sourceLineNo">173</span> /**<a name="line.173"></a> +<span class="sourceLineNo">174</span> * Returns the {@link XmlSerializerContext#XML_xsNamespace} setting value in this context.<a name="line.174"></a> +<span class="sourceLineNo">175</span> *<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @return The {@link XmlSerializerContext#XML_xsNamespace} setting value in this context.<a name="line.176"></a> +<span class="sourceLineNo">177</span> */<a name="line.177"></a> +<span class="sourceLineNo">178</span> public final Namespace getXsNamespace() {<a name="line.178"></a> +<span class="sourceLineNo">179</span> return xsNamespace;<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> @Override /* SerializerSession */<a name="line.182"></a> +<span class="sourceLineNo">183</span> public XmlWriter getWriter() throws Exception {<a name="line.183"></a> +<span class="sourceLineNo">184</span> Object output = getOutput();<a name="line.184"></a> +<span class="sourceLineNo">185</span> if (output instanceof XmlWriter)<a name="line.185"></a> +<span class="sourceLineNo">186</span> return (XmlWriter)output;<a name="line.186"></a> +<span class="sourceLineNo">187</span> return new XmlWriter(super.getWriter(), isUseWhitespace(), isTrimStrings(), getQuoteChar(), getRelativeUriBase(), getAbsolutePathUriBase(), isEnableNamespaces(), getDefaultNamespace());<a name="line.187"></a> +<span class="sourceLineNo">188</span> }<a name="line.188"></a> +<span class="sourceLineNo">189</span>}<a name="line.189"></a>
