http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/jena/RdfSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/jena/RdfSerializerSession.html b/content/site/apidocs/src-html/org/apache/juneau/jena/RdfSerializerSession.html index 929e4f2..e410c0e 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/jena/RdfSerializerSession.html +++ b/content/site/apidocs/src-html/org/apache/juneau/jena/RdfSerializerSession.html @@ -29,255 +29,274 @@ <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.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>import org.apache.juneau.xml.*;<a name="line.25"></a> -<span class="sourceLineNo">026</span><a name="line.26"></a> -<span class="sourceLineNo">027</span>import com.hp.hpl.jena.rdf.model.*;<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> * Session object that lives for the duration of a single use of {@link RdfSerializer}.<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <p><a name="line.31"></a> -<span class="sourceLineNo">032</span> * This class is NOT thread safe. It is meant to be discarded after one-time use.<a name="line.32"></a> -<span class="sourceLineNo">033</span> */<a name="line.33"></a> -<span class="sourceLineNo">034</span>public final class RdfSerializerSession extends SerializerSession {<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span> private final String rdfLanguage;<a name="line.36"></a> -<span class="sourceLineNo">037</span> private final Namespace juneauNs, juneauBpNs;<a name="line.37"></a> -<span class="sourceLineNo">038</span> private final boolean addLiteralTypes, addRootProperty, useXmlNamespaces, looseCollections, autoDetectNamespaces;<a name="line.38"></a> -<span class="sourceLineNo">039</span> private final Property pRoot, pValue, pType;<a name="line.39"></a> -<span class="sourceLineNo">040</span> private final Model model;<a name="line.40"></a> -<span class="sourceLineNo">041</span> private final RDFWriter writer;<a name="line.41"></a> -<span class="sourceLineNo">042</span> private final RdfCollectionFormat collectionFormat;<a name="line.42"></a> -<span class="sourceLineNo">043</span> private final Namespace[] namespaces;<a name="line.43"></a> -<span class="sourceLineNo">044</span><a name="line.44"></a> -<span class="sourceLineNo">045</span> /**<a name="line.45"></a> -<span class="sourceLineNo">046</span> * Create a new session using properties specified in the context.<a name="line.46"></a> -<span class="sourceLineNo">047</span> *<a name="line.47"></a> -<span class="sourceLineNo">048</span> * @param ctx The context creating this session object.<a name="line.48"></a> -<span class="sourceLineNo">049</span> * The context contains all the configuration settings for this object.<a name="line.49"></a> -<span class="sourceLineNo">050</span> * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.<a name="line.50"></a> -<span class="sourceLineNo">051</span> * @param op The override properties.<a name="line.51"></a> -<span class="sourceLineNo">052</span> * These override any context properties defined in the context.<a name="line.52"></a> -<span class="sourceLineNo">053</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.53"></a> -<span class="sourceLineNo">054</span> * @param locale The session locale.<a name="line.54"></a> -<span class="sourceLineNo">055</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.55"></a> -<span class="sourceLineNo">056</span> * @param timeZone The session timezone.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.58"></a> -<span class="sourceLineNo">059</span> */<a name="line.59"></a> -<span class="sourceLineNo">060</span> protected RdfSerializerSession(RdfSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.60"></a> -<span class="sourceLineNo">061</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.61"></a> -<span class="sourceLineNo">062</span> ObjectMap jenaSettings = new ObjectMap();<a name="line.62"></a> -<span class="sourceLineNo">063</span> jenaSettings.put("rdfXml.tab", isUseWhitespace() ? 2 : 0);<a name="line.63"></a> -<span class="sourceLineNo">064</span> jenaSettings.put("rdfXml.attributeQuoteChar", Character.toString(getQuoteChar()));<a name="line.64"></a> -<span class="sourceLineNo">065</span> jenaSettings.putAll(ctx.jenaSettings);<a name="line.65"></a> -<span class="sourceLineNo">066</span> if (op == null || op.isEmpty()) {<a name="line.66"></a> -<span class="sourceLineNo">067</span> this.rdfLanguage = ctx.rdfLanguage;<a name="line.67"></a> -<span class="sourceLineNo">068</span> this.juneauNs = ctx.juneauNs;<a name="line.68"></a> -<span class="sourceLineNo">069</span> this.juneauBpNs = ctx.juneauBpNs;<a name="line.69"></a> -<span class="sourceLineNo">070</span> this.addLiteralTypes = ctx.addLiteralTypes;<a name="line.70"></a> -<span class="sourceLineNo">071</span> this.addRootProperty = ctx.addRootProperty;<a name="line.71"></a> -<span class="sourceLineNo">072</span> this.collectionFormat = ctx.collectionFormat;<a name="line.72"></a> -<span class="sourceLineNo">073</span> this.looseCollections = ctx.looseCollections;<a name="line.73"></a> -<span class="sourceLineNo">074</span> this.useXmlNamespaces = ctx.useXmlNamespaces;<a name="line.74"></a> -<span class="sourceLineNo">075</span> this.autoDetectNamespaces = ctx.autoDetectNamespaces;<a name="line.75"></a> -<span class="sourceLineNo">076</span> this.namespaces = ctx.namespaces;<a name="line.76"></a> -<span class="sourceLineNo">077</span> } else {<a name="line.77"></a> -<span class="sourceLineNo">078</span> this.rdfLanguage = op.getString(RDF_language, ctx.rdfLanguage);<a name="line.78"></a> -<span class="sourceLineNo">079</span> this.juneauNs = (op.containsKey(RDF_juneauNs) ? NamespaceFactory.parseNamespace(op.get(RDF_juneauNs)) : ctx.juneauNs);<a name="line.79"></a> -<span class="sourceLineNo">080</span> this.juneauBpNs = (op.containsKey(RDF_juneauBpNs) ? NamespaceFactory.parseNamespace(op.get(RDF_juneauBpNs)) : ctx.juneauBpNs);<a name="line.80"></a> -<span class="sourceLineNo">081</span> this.addLiteralTypes = op.getBoolean(RDF_addLiteralTypes, ctx.addLiteralTypes);<a name="line.81"></a> -<span class="sourceLineNo">082</span> this.addRootProperty = op.getBoolean(RDF_addRootProperty, ctx.addRootProperty);<a name="line.82"></a> -<span class="sourceLineNo">083</span> for (Map.Entry<String,Object> e : op.entrySet()) {<a name="line.83"></a> -<span class="sourceLineNo">084</span> String key = e.getKey();<a name="line.84"></a> -<span class="sourceLineNo">085</span> if (key.startsWith("Rdf.jena."))<a name="line.85"></a> -<span class="sourceLineNo">086</span> jenaSettings.put(key.substring(9), e.getValue());<a name="line.86"></a> -<span class="sourceLineNo">087</span> }<a name="line.87"></a> -<span class="sourceLineNo">088</span> this.collectionFormat = RdfCollectionFormat.valueOf(op.getString(RDF_collectionFormat, "DEFAULT"));<a name="line.88"></a> -<span class="sourceLineNo">089</span> this.looseCollections = op.getBoolean(RDF_looseCollections, ctx.looseCollections);<a name="line.89"></a> -<span class="sourceLineNo">090</span> this.useXmlNamespaces = op.getBoolean(RDF_useXmlNamespaces, ctx.useXmlNamespaces);<a name="line.90"></a> -<span class="sourceLineNo">091</span> this.autoDetectNamespaces = op.getBoolean(RDF_autoDetectNamespaces, ctx.autoDetectNamespaces);<a name="line.91"></a> -<span class="sourceLineNo">092</span> this.namespaces = op.get(Namespace[].class, RDF_namespaces, ctx.namespaces);<a name="line.92"></a> -<span class="sourceLineNo">093</span> }<a name="line.93"></a> -<span class="sourceLineNo">094</span> this.model = ModelFactory.createDefaultModel();<a name="line.94"></a> -<span class="sourceLineNo">095</span> addModelPrefix(juneauNs);<a name="line.95"></a> -<span class="sourceLineNo">096</span> addModelPrefix(juneauBpNs);<a name="line.96"></a> -<span class="sourceLineNo">097</span> for (Namespace ns : this.namespaces)<a name="line.97"></a> -<span class="sourceLineNo">098</span> addModelPrefix(ns);<a name="line.98"></a> -<span class="sourceLineNo">099</span> this.pRoot = model.createProperty(juneauNs.getUri(), RDF_juneauNs_ROOT);<a name="line.99"></a> -<span class="sourceLineNo">100</span> this.pValue = model.createProperty(juneauNs.getUri(), RDF_juneauNs_VALUE);<a name="line.100"></a> -<span class="sourceLineNo">101</span> this.pType = model.createProperty(juneauNs.getUri(), RDF_juneauNs_TYPE);<a name="line.101"></a> -<span class="sourceLineNo">102</span> writer = model.getWriter(rdfLanguage);<a name="line.102"></a> -<span class="sourceLineNo">103</span><a name="line.103"></a> -<span class="sourceLineNo">104</span> // Only apply properties with this prefix!<a name="line.104"></a> -<span class="sourceLineNo">105</span> String propPrefix = RdfCommonContext.LANG_PROP_MAP.get(rdfLanguage);<a name="line.105"></a> -<span class="sourceLineNo">106</span> if (propPrefix == null)<a name="line.106"></a> -<span class="sourceLineNo">107</span> throw new RuntimeException("Unknown RDF language encountered: '"+rdfLanguage+"'");<a name="line.107"></a> -<span class="sourceLineNo">108</span><a name="line.108"></a> -<span class="sourceLineNo">109</span> for (Map.Entry<String,Object> e : jenaSettings.entrySet())<a name="line.109"></a> -<span class="sourceLineNo">110</span> if (e.getKey().startsWith(propPrefix))<a name="line.110"></a> -<span class="sourceLineNo">111</span> writer.setProperty(e.getKey().substring(propPrefix.length()), e.getValue());<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> * Adds the specified namespace as a model prefix.<a name="line.115"></a> -<span class="sourceLineNo">116</span> *<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @param ns The XML namespace.<a name="line.117"></a> -<span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> public void addModelPrefix(Namespace ns) {<a name="line.119"></a> -<span class="sourceLineNo">120</span> model.setNsPrefix(ns.getName(), ns.getUri());<a name="line.120"></a> +<span class="sourceLineNo">024</span>import org.apache.juneau.msgpack.*;<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>import org.apache.juneau.xml.*;<a name="line.26"></a> +<span class="sourceLineNo">027</span><a name="line.27"></a> +<span class="sourceLineNo">028</span>import com.hp.hpl.jena.rdf.model.*;<a name="line.28"></a> +<span class="sourceLineNo">029</span><a name="line.29"></a> +<span class="sourceLineNo">030</span>/**<a name="line.30"></a> +<span class="sourceLineNo">031</span> * Session object that lives for the duration of a single use of {@link RdfSerializer}.<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <p><a name="line.32"></a> +<span class="sourceLineNo">033</span> * This class is NOT thread safe. It is meant to be discarded after one-time use.<a name="line.33"></a> +<span class="sourceLineNo">034</span> */<a name="line.34"></a> +<span class="sourceLineNo">035</span>public final class RdfSerializerSession extends SerializerSession {<a name="line.35"></a> +<span class="sourceLineNo">036</span><a name="line.36"></a> +<span class="sourceLineNo">037</span> private final String rdfLanguage;<a name="line.37"></a> +<span class="sourceLineNo">038</span> private final Namespace juneauNs, juneauBpNs;<a name="line.38"></a> +<span class="sourceLineNo">039</span> private final boolean <a name="line.39"></a> +<span class="sourceLineNo">040</span> addLiteralTypes, <a name="line.40"></a> +<span class="sourceLineNo">041</span> addRootProperty, <a name="line.41"></a> +<span class="sourceLineNo">042</span> useXmlNamespaces, <a name="line.42"></a> +<span class="sourceLineNo">043</span> looseCollections, <a name="line.43"></a> +<span class="sourceLineNo">044</span> autoDetectNamespaces,<a name="line.44"></a> +<span class="sourceLineNo">045</span> addBeanTypeProperties;<a name="line.45"></a> +<span class="sourceLineNo">046</span> private final Property pRoot, pValue, pType;<a name="line.46"></a> +<span class="sourceLineNo">047</span> private final Model model;<a name="line.47"></a> +<span class="sourceLineNo">048</span> private final RDFWriter writer;<a name="line.48"></a> +<span class="sourceLineNo">049</span> private final RdfCollectionFormat collectionFormat;<a name="line.49"></a> +<span class="sourceLineNo">050</span> private final Namespace[] namespaces;<a name="line.50"></a> +<span class="sourceLineNo">051</span><a name="line.51"></a> +<span class="sourceLineNo">052</span> /**<a name="line.52"></a> +<span class="sourceLineNo">053</span> * Create a new session using properties specified in the context.<a name="line.53"></a> +<span class="sourceLineNo">054</span> *<a name="line.54"></a> +<span class="sourceLineNo">055</span> * @param ctx The context creating this session object.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * The context contains all the configuration settings for this object.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param op The override properties.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * These override any context properties defined in the context.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @param locale The session locale.<a name="line.61"></a> +<span class="sourceLineNo">062</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @param timeZone The session timezone.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.64"></a> +<span class="sourceLineNo">065</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.65"></a> +<span class="sourceLineNo">066</span> */<a name="line.66"></a> +<span class="sourceLineNo">067</span> protected RdfSerializerSession(RdfSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.67"></a> +<span class="sourceLineNo">068</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.68"></a> +<span class="sourceLineNo">069</span> ObjectMap jenaSettings = new ObjectMap();<a name="line.69"></a> +<span class="sourceLineNo">070</span> jenaSettings.put("rdfXml.tab", isUseWhitespace() ? 2 : 0);<a name="line.70"></a> +<span class="sourceLineNo">071</span> jenaSettings.put("rdfXml.attributeQuoteChar", Character.toString(getQuoteChar()));<a name="line.71"></a> +<span class="sourceLineNo">072</span> jenaSettings.putAll(ctx.jenaSettings);<a name="line.72"></a> +<span class="sourceLineNo">073</span> if (op == null || op.isEmpty()) {<a name="line.73"></a> +<span class="sourceLineNo">074</span> this.rdfLanguage = ctx.rdfLanguage;<a name="line.74"></a> +<span class="sourceLineNo">075</span> this.juneauNs = ctx.juneauNs;<a name="line.75"></a> +<span class="sourceLineNo">076</span> this.juneauBpNs = ctx.juneauBpNs;<a name="line.76"></a> +<span class="sourceLineNo">077</span> this.addLiteralTypes = ctx.addLiteralTypes;<a name="line.77"></a> +<span class="sourceLineNo">078</span> this.addRootProperty = ctx.addRootProperty;<a name="line.78"></a> +<span class="sourceLineNo">079</span> this.collectionFormat = ctx.collectionFormat;<a name="line.79"></a> +<span class="sourceLineNo">080</span> this.looseCollections = ctx.looseCollections;<a name="line.80"></a> +<span class="sourceLineNo">081</span> this.useXmlNamespaces = ctx.useXmlNamespaces;<a name="line.81"></a> +<span class="sourceLineNo">082</span> this.autoDetectNamespaces = ctx.autoDetectNamespaces;<a name="line.82"></a> +<span class="sourceLineNo">083</span> this.namespaces = ctx.namespaces;<a name="line.83"></a> +<span class="sourceLineNo">084</span> addBeanTypeProperties = ctx.addBeanTypeProperties;<a name="line.84"></a> +<span class="sourceLineNo">085</span> } else {<a name="line.85"></a> +<span class="sourceLineNo">086</span> this.rdfLanguage = op.getString(RDF_language, ctx.rdfLanguage);<a name="line.86"></a> +<span class="sourceLineNo">087</span> this.juneauNs = (op.containsKey(RDF_juneauNs) ? NamespaceFactory.parseNamespace(op.get(RDF_juneauNs)) : ctx.juneauNs);<a name="line.87"></a> +<span class="sourceLineNo">088</span> this.juneauBpNs = (op.containsKey(RDF_juneauBpNs) ? NamespaceFactory.parseNamespace(op.get(RDF_juneauBpNs)) : ctx.juneauBpNs);<a name="line.88"></a> +<span class="sourceLineNo">089</span> this.addLiteralTypes = op.getBoolean(RDF_addLiteralTypes, ctx.addLiteralTypes);<a name="line.89"></a> +<span class="sourceLineNo">090</span> this.addRootProperty = op.getBoolean(RDF_addRootProperty, ctx.addRootProperty);<a name="line.90"></a> +<span class="sourceLineNo">091</span> for (Map.Entry<String,Object> e : op.entrySet()) {<a name="line.91"></a> +<span class="sourceLineNo">092</span> String key = e.getKey();<a name="line.92"></a> +<span class="sourceLineNo">093</span> if (key.startsWith("Rdf.jena."))<a name="line.93"></a> +<span class="sourceLineNo">094</span> jenaSettings.put(key.substring(9), e.getValue());<a name="line.94"></a> +<span class="sourceLineNo">095</span> }<a name="line.95"></a> +<span class="sourceLineNo">096</span> this.collectionFormat = RdfCollectionFormat.valueOf(op.getString(RDF_collectionFormat, "DEFAULT"));<a name="line.96"></a> +<span class="sourceLineNo">097</span> this.looseCollections = op.getBoolean(RDF_looseCollections, ctx.looseCollections);<a name="line.97"></a> +<span class="sourceLineNo">098</span> this.useXmlNamespaces = op.getBoolean(RDF_useXmlNamespaces, ctx.useXmlNamespaces);<a name="line.98"></a> +<span class="sourceLineNo">099</span> this.autoDetectNamespaces = op.getBoolean(RDF_autoDetectNamespaces, ctx.autoDetectNamespaces);<a name="line.99"></a> +<span class="sourceLineNo">100</span> this.namespaces = op.get(Namespace[].class, RDF_namespaces, ctx.namespaces);<a name="line.100"></a> +<span class="sourceLineNo">101</span> addBeanTypeProperties = op.getBoolean(RDF_addBeanTypeProperties, ctx.addBeanTypeProperties);<a name="line.101"></a> +<span class="sourceLineNo">102</span> }<a name="line.102"></a> +<span class="sourceLineNo">103</span> this.model = ModelFactory.createDefaultModel();<a name="line.103"></a> +<span class="sourceLineNo">104</span> addModelPrefix(juneauNs);<a name="line.104"></a> +<span class="sourceLineNo">105</span> addModelPrefix(juneauBpNs);<a name="line.105"></a> +<span class="sourceLineNo">106</span> for (Namespace ns : this.namespaces)<a name="line.106"></a> +<span class="sourceLineNo">107</span> addModelPrefix(ns);<a name="line.107"></a> +<span class="sourceLineNo">108</span> this.pRoot = model.createProperty(juneauNs.getUri(), RDF_juneauNs_ROOT);<a name="line.108"></a> +<span class="sourceLineNo">109</span> this.pValue = model.createProperty(juneauNs.getUri(), RDF_juneauNs_VALUE);<a name="line.109"></a> +<span class="sourceLineNo">110</span> this.pType = model.createProperty(juneauNs.getUri(), RDF_juneauNs_TYPE);<a name="line.110"></a> +<span class="sourceLineNo">111</span> writer = model.getWriter(rdfLanguage);<a name="line.111"></a> +<span class="sourceLineNo">112</span><a name="line.112"></a> +<span class="sourceLineNo">113</span> // Only apply properties with this prefix!<a name="line.113"></a> +<span class="sourceLineNo">114</span> String propPrefix = RdfCommonContext.LANG_PROP_MAP.get(rdfLanguage);<a name="line.114"></a> +<span class="sourceLineNo">115</span> if (propPrefix == null)<a name="line.115"></a> +<span class="sourceLineNo">116</span> throw new RuntimeException("Unknown RDF language encountered: '"+rdfLanguage+"'");<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> for (Map.Entry<String,Object> e : jenaSettings.entrySet())<a name="line.118"></a> +<span class="sourceLineNo">119</span> if (e.getKey().startsWith(propPrefix))<a name="line.119"></a> +<span class="sourceLineNo">120</span> writer.setProperty(e.getKey().substring(propPrefix.length()), e.getValue());<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 RdfCommonContext#RDF_collectionFormat} setting value for this session.<a name="line.124"></a> +<span class="sourceLineNo">124</span> * Adds the specified namespace as a model prefix.<a name="line.124"></a> <span class="sourceLineNo">125</span> *<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @return The {@link RdfCommonContext#RDF_collectionFormat} setting value for this session.<a name="line.126"></a> +<span class="sourceLineNo">126</span> * @param ns The XML namespace.<a name="line.126"></a> <span class="sourceLineNo">127</span> */<a name="line.127"></a> -<span class="sourceLineNo">128</span> public final RdfCollectionFormat getCollectionFormat() {<a name="line.128"></a> -<span class="sourceLineNo">129</span> return collectionFormat;<a name="line.129"></a> +<span class="sourceLineNo">128</span> public void addModelPrefix(Namespace ns) {<a name="line.128"></a> +<span class="sourceLineNo">129</span> model.setNsPrefix(ns.getName(), ns.getUri());<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 RdfCommonContext#RDF_useXmlNamespaces} setting value for this session.<a name="line.133"></a> +<span class="sourceLineNo">133</span> * Returns the {@link RdfCommonContext#RDF_collectionFormat} setting value for this session.<a name="line.133"></a> <span class="sourceLineNo">134</span> *<a name="line.134"></a> -<span class="sourceLineNo">135</span> * @return The {@link RdfCommonContext#RDF_useXmlNamespaces} setting value for this session.<a name="line.135"></a> +<span class="sourceLineNo">135</span> * @return The {@link RdfCommonContext#RDF_collectionFormat} setting value for this session.<a name="line.135"></a> <span class="sourceLineNo">136</span> */<a name="line.136"></a> -<span class="sourceLineNo">137</span> public final boolean isUseXmlNamespaces() {<a name="line.137"></a> -<span class="sourceLineNo">138</span> return useXmlNamespaces;<a name="line.138"></a> +<span class="sourceLineNo">137</span> public final RdfCollectionFormat getCollectionFormat() {<a name="line.137"></a> +<span class="sourceLineNo">138</span> return collectionFormat;<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 RdfCommonContext#RDF_looseCollections} setting value for this session.<a name="line.142"></a> +<span class="sourceLineNo">142</span> * Returns the {@link RdfCommonContext#RDF_useXmlNamespaces} setting value for this session.<a name="line.142"></a> <span class="sourceLineNo">143</span> *<a name="line.143"></a> -<span class="sourceLineNo">144</span> * @return The {@link RdfCommonContext#RDF_looseCollections} setting value for this session.<a name="line.144"></a> +<span class="sourceLineNo">144</span> * @return The {@link RdfCommonContext#RDF_useXmlNamespaces} setting value for this session.<a name="line.144"></a> <span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> public final boolean isLooseCollections() {<a name="line.146"></a> -<span class="sourceLineNo">147</span> return looseCollections;<a name="line.147"></a> +<span class="sourceLineNo">146</span> public final boolean isUseXmlNamespaces() {<a name="line.146"></a> +<span class="sourceLineNo">147</span> return useXmlNamespaces;<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 RdfCommonContext#RDF_language} setting value for this session.<a name="line.151"></a> +<span class="sourceLineNo">151</span> * Returns the {@link RdfCommonContext#RDF_looseCollections} setting value for this session.<a name="line.151"></a> <span class="sourceLineNo">152</span> *<a name="line.152"></a> -<span class="sourceLineNo">153</span> * @return The {@link RdfCommonContext#RDF_language} setting value for this session.<a name="line.153"></a> +<span class="sourceLineNo">153</span> * @return The {@link RdfCommonContext#RDF_looseCollections} setting value for this session.<a name="line.153"></a> <span class="sourceLineNo">154</span> */<a name="line.154"></a> -<span class="sourceLineNo">155</span> public final String getRdfLanguage() {<a name="line.155"></a> -<span class="sourceLineNo">156</span> return rdfLanguage;<a name="line.156"></a> +<span class="sourceLineNo">155</span> public final boolean isLooseCollections() {<a name="line.155"></a> +<span class="sourceLineNo">156</span> return looseCollections;<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 RdfCommonContext#RDF_juneauNs} setting value for this session.<a name="line.160"></a> +<span class="sourceLineNo">160</span> * Returns the {@link RdfCommonContext#RDF_language} setting value for this session.<a name="line.160"></a> <span class="sourceLineNo">161</span> *<a name="line.161"></a> -<span class="sourceLineNo">162</span> * @return The {@link RdfCommonContext#RDF_juneauNs} setting value for this session.<a name="line.162"></a> +<span class="sourceLineNo">162</span> * @return The {@link RdfCommonContext#RDF_language} setting value for this session.<a name="line.162"></a> <span class="sourceLineNo">163</span> */<a name="line.163"></a> -<span class="sourceLineNo">164</span> public final Namespace getJuneauNs() {<a name="line.164"></a> -<span class="sourceLineNo">165</span> return juneauNs;<a name="line.165"></a> +<span class="sourceLineNo">164</span> public final String getRdfLanguage() {<a name="line.164"></a> +<span class="sourceLineNo">165</span> return rdfLanguage;<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> /**<a name="line.168"></a> -<span class="sourceLineNo">169</span> * Returns the {@link RdfCommonContext#RDF_juneauBpNs} setting value for this session.<a name="line.169"></a> +<span class="sourceLineNo">169</span> * Returns the {@link RdfCommonContext#RDF_juneauNs} setting value for this session.<a name="line.169"></a> <span class="sourceLineNo">170</span> *<a name="line.170"></a> -<span class="sourceLineNo">171</span> * @return The {@link RdfCommonContext#RDF_juneauBpNs} setting value for this session.<a name="line.171"></a> +<span class="sourceLineNo">171</span> * @return The {@link RdfCommonContext#RDF_juneauNs} setting value for this session.<a name="line.171"></a> <span class="sourceLineNo">172</span> */<a name="line.172"></a> -<span class="sourceLineNo">173</span> public final Namespace getJuneauBpNs() {<a name="line.173"></a> -<span class="sourceLineNo">174</span> return juneauBpNs;<a name="line.174"></a> +<span class="sourceLineNo">173</span> public final Namespace getJuneauNs() {<a name="line.173"></a> +<span class="sourceLineNo">174</span> return juneauNs;<a name="line.174"></a> <span class="sourceLineNo">175</span> }<a name="line.175"></a> <span class="sourceLineNo">176</span><a name="line.176"></a> <span class="sourceLineNo">177</span> /**<a name="line.177"></a> -<span class="sourceLineNo">178</span> * Returns the {@link RdfSerializerContext#RDF_addLiteralTypes} setting value for this session.<a name="line.178"></a> +<span class="sourceLineNo">178</span> * Returns the {@link RdfCommonContext#RDF_juneauBpNs} setting value for this session.<a name="line.178"></a> <span class="sourceLineNo">179</span> *<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @return The {@link RdfSerializerContext#RDF_addLiteralTypes} setting value for this session.<a name="line.180"></a> +<span class="sourceLineNo">180</span> * @return The {@link RdfCommonContext#RDF_juneauBpNs} setting value for this session.<a name="line.180"></a> <span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> public final boolean isAddLiteralTypes() {<a name="line.182"></a> -<span class="sourceLineNo">183</span> return addLiteralTypes;<a name="line.183"></a> +<span class="sourceLineNo">182</span> public final Namespace getJuneauBpNs() {<a name="line.182"></a> +<span class="sourceLineNo">183</span> return juneauBpNs;<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> /**<a name="line.186"></a> -<span class="sourceLineNo">187</span> * Returns the {@link RdfSerializerContext#RDF_addRootProperty} setting value for this session.<a name="line.187"></a> +<span class="sourceLineNo">187</span> * Returns the {@link RdfSerializerContext#RDF_addLiteralTypes} setting value for this session.<a name="line.187"></a> <span class="sourceLineNo">188</span> *<a name="line.188"></a> -<span class="sourceLineNo">189</span> * @return The {@link RdfSerializerContext#RDF_addRootProperty} setting value for this session.<a name="line.189"></a> +<span class="sourceLineNo">189</span> * @return The {@link RdfSerializerContext#RDF_addLiteralTypes} setting value for this session.<a name="line.189"></a> <span class="sourceLineNo">190</span> */<a name="line.190"></a> -<span class="sourceLineNo">191</span> public final boolean isAddRootProp() {<a name="line.191"></a> -<span class="sourceLineNo">192</span> return addRootProperty;<a name="line.192"></a> +<span class="sourceLineNo">191</span> public final boolean isAddLiteralTypes() {<a name="line.191"></a> +<span class="sourceLineNo">192</span> return addLiteralTypes;<a name="line.192"></a> <span class="sourceLineNo">193</span> }<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> * Returns the {@link RdfSerializerContext#RDF_autoDetectNamespaces} setting value for this session.<a name="line.196"></a> +<span class="sourceLineNo">196</span> * Returns the {@link RdfSerializerContext#RDF_addRootProperty} setting value for this session.<a name="line.196"></a> <span class="sourceLineNo">197</span> *<a name="line.197"></a> -<span class="sourceLineNo">198</span> * @return The {@link RdfSerializerContext#RDF_autoDetectNamespaces} setting value for this session.<a name="line.198"></a> +<span class="sourceLineNo">198</span> * @return The {@link RdfSerializerContext#RDF_addRootProperty} setting value for this session.<a name="line.198"></a> <span class="sourceLineNo">199</span> */<a name="line.199"></a> -<span class="sourceLineNo">200</span> public final boolean isAutoDetectNamespaces() {<a name="line.200"></a> -<span class="sourceLineNo">201</span> return autoDetectNamespaces;<a name="line.201"></a> +<span class="sourceLineNo">200</span> public final boolean isAddRootProp() {<a name="line.200"></a> +<span class="sourceLineNo">201</span> return addRootProperty;<a name="line.201"></a> <span class="sourceLineNo">202</span> }<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> * Returns the RDF property that identifies the root node in the RDF model.<a name="line.205"></a> +<span class="sourceLineNo">205</span> * Returns the {@link RdfSerializerContext#RDF_autoDetectNamespaces} setting value for this session.<a name="line.205"></a> <span class="sourceLineNo">206</span> *<a name="line.206"></a> -<span class="sourceLineNo">207</span> * @return The RDF property that identifies the root node in the RDF model.<a name="line.207"></a> +<span class="sourceLineNo">207</span> * @return The {@link RdfSerializerContext#RDF_autoDetectNamespaces} setting value for this session.<a name="line.207"></a> <span class="sourceLineNo">208</span> */<a name="line.208"></a> -<span class="sourceLineNo">209</span> public final Property getRootProp() {<a name="line.209"></a> -<span class="sourceLineNo">210</span> return pRoot;<a name="line.210"></a> +<span class="sourceLineNo">209</span> public final boolean isAutoDetectNamespaces() {<a name="line.209"></a> +<span class="sourceLineNo">210</span> return autoDetectNamespaces;<a name="line.210"></a> <span class="sourceLineNo">211</span> }<a name="line.211"></a> <span class="sourceLineNo">212</span><a name="line.212"></a> <span class="sourceLineNo">213</span> /**<a name="line.213"></a> -<span class="sourceLineNo">214</span> * Returns the RDF property that represents a value in the RDF model.<a name="line.214"></a> +<span class="sourceLineNo">214</span> * Returns the {@link MsgPackSerializerContext#MSGPACK_addBeanTypeProperties} setting value for this session.<a name="line.214"></a> <span class="sourceLineNo">215</span> *<a name="line.215"></a> -<span class="sourceLineNo">216</span> * @return The RDF property that represents a value in the RDF model.<a name="line.216"></a> +<span class="sourceLineNo">216</span> * @return The {@link MsgPackSerializerContext#MSGPACK_addBeanTypeProperties} setting value for this session.<a name="line.216"></a> <span class="sourceLineNo">217</span> */<a name="line.217"></a> -<span class="sourceLineNo">218</span> public final Property getValueProperty() {<a name="line.218"></a> -<span class="sourceLineNo">219</span> return pValue;<a name="line.219"></a> -<span class="sourceLineNo">220</span> }<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> * Returns the RDF property that represents a class in the RDF model.<a name="line.223"></a> -<span class="sourceLineNo">224</span> *<a name="line.224"></a> -<span class="sourceLineNo">225</span> * @return The RDF property that represents a class in the RDF model.<a name="line.225"></a> -<span class="sourceLineNo">226</span> */<a name="line.226"></a> -<span class="sourceLineNo">227</span> public final Property getTypeProperty() {<a name="line.227"></a> -<span class="sourceLineNo">228</span> return pType;<a name="line.228"></a> -<span class="sourceLineNo">229</span> }<a name="line.229"></a> -<span class="sourceLineNo">230</span><a name="line.230"></a> -<span class="sourceLineNo">231</span> /**<a name="line.231"></a> -<span class="sourceLineNo">232</span> * Returns the RDF model being serialized.<a name="line.232"></a> -<span class="sourceLineNo">233</span> *<a name="line.233"></a> -<span class="sourceLineNo">234</span> * @return The RDF model being serialized.<a name="line.234"></a> -<span class="sourceLineNo">235</span> */<a name="line.235"></a> -<span class="sourceLineNo">236</span> public final Model getModel() {<a name="line.236"></a> -<span class="sourceLineNo">237</span> return model;<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> * Returns the RDF writer that's being serialized to.<a name="line.241"></a> -<span class="sourceLineNo">242</span> *<a name="line.242"></a> -<span class="sourceLineNo">243</span> * @return The RDF writer that's being serialized to.<a name="line.243"></a> -<span class="sourceLineNo">244</span> */<a name="line.244"></a> -<span class="sourceLineNo">245</span> public final RDFWriter getRdfWriter() {<a name="line.245"></a> -<span class="sourceLineNo">246</span> return writer;<a name="line.246"></a> -<span class="sourceLineNo">247</span> }<a name="line.247"></a> -<span class="sourceLineNo">248</span><a name="line.248"></a> -<span class="sourceLineNo">249</span> /**<a name="line.249"></a> -<span class="sourceLineNo">250</span> * XML-encodes the specified string using the {@link XmlUtils#encodeInvalidCharsForText(Object)} method.<a name="line.250"></a> -<span class="sourceLineNo">251</span> *<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @param o The string being encoded.<a name="line.252"></a> -<span class="sourceLineNo">253</span> * @return The encoded string, or <jk>null</jk> if the input was <jk>null</jk>.<a name="line.253"></a> +<span class="sourceLineNo">218</span> @Override /* SerializerSession */<a name="line.218"></a> +<span class="sourceLineNo">219</span> public final boolean isAddBeanTypeProperties() {<a name="line.219"></a> +<span class="sourceLineNo">220</span> return addBeanTypeProperties;<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 RDF property that identifies the root node in the RDF model.<a name="line.224"></a> +<span class="sourceLineNo">225</span> *<a name="line.225"></a> +<span class="sourceLineNo">226</span> * @return The RDF property that identifies the root node in the RDF model.<a name="line.226"></a> +<span class="sourceLineNo">227</span> */<a name="line.227"></a> +<span class="sourceLineNo">228</span> public final Property getRootProp() {<a name="line.228"></a> +<span class="sourceLineNo">229</span> return pRoot;<a name="line.229"></a> +<span class="sourceLineNo">230</span> }<a name="line.230"></a> +<span class="sourceLineNo">231</span><a name="line.231"></a> +<span class="sourceLineNo">232</span> /**<a name="line.232"></a> +<span class="sourceLineNo">233</span> * Returns the RDF property that represents a value in the RDF model.<a name="line.233"></a> +<span class="sourceLineNo">234</span> *<a name="line.234"></a> +<span class="sourceLineNo">235</span> * @return The RDF property that represents a value in the RDF model.<a name="line.235"></a> +<span class="sourceLineNo">236</span> */<a name="line.236"></a> +<span class="sourceLineNo">237</span> public final Property getValueProperty() {<a name="line.237"></a> +<span class="sourceLineNo">238</span> return pValue;<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> /**<a name="line.241"></a> +<span class="sourceLineNo">242</span> * Returns the RDF property that represents a class in the RDF model.<a name="line.242"></a> +<span class="sourceLineNo">243</span> *<a name="line.243"></a> +<span class="sourceLineNo">244</span> * @return The RDF property that represents a class in the RDF model.<a name="line.244"></a> +<span class="sourceLineNo">245</span> */<a name="line.245"></a> +<span class="sourceLineNo">246</span> public final Property getTypeProperty() {<a name="line.246"></a> +<span class="sourceLineNo">247</span> return pType;<a name="line.247"></a> +<span class="sourceLineNo">248</span> }<a name="line.248"></a> +<span class="sourceLineNo">249</span><a name="line.249"></a> +<span class="sourceLineNo">250</span> /**<a name="line.250"></a> +<span class="sourceLineNo">251</span> * Returns the RDF model being serialized.<a name="line.251"></a> +<span class="sourceLineNo">252</span> *<a name="line.252"></a> +<span class="sourceLineNo">253</span> * @return The RDF model being serialized.<a name="line.253"></a> <span class="sourceLineNo">254</span> */<a name="line.254"></a> -<span class="sourceLineNo">255</span> public final String encodeTextInvalidChars(Object o) {<a name="line.255"></a> -<span class="sourceLineNo">256</span> if (o == null)<a name="line.256"></a> -<span class="sourceLineNo">257</span> return null;<a name="line.257"></a> -<span class="sourceLineNo">258</span> String s = toString(o);<a name="line.258"></a> -<span class="sourceLineNo">259</span> return XmlUtils.encodeInvalidCharsForText(s);<a name="line.259"></a> -<span class="sourceLineNo">260</span> }<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> * XML-encoded the specified element name using the {@link XmlUtils#encodeElementName(Object)} method.<a name="line.263"></a> -<span class="sourceLineNo">264</span> *<a name="line.264"></a> -<span class="sourceLineNo">265</span> * @param o The string being encoded.<a name="line.265"></a> -<span class="sourceLineNo">266</span> * @return The encoded string.<a name="line.266"></a> -<span class="sourceLineNo">267</span> */<a name="line.267"></a> -<span class="sourceLineNo">268</span> public final String encodeElementName(Object o) {<a name="line.268"></a> -<span class="sourceLineNo">269</span> String s = toString(o);<a name="line.269"></a> -<span class="sourceLineNo">270</span> return XmlUtils.encodeElementName(s);<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">255</span> public final Model getModel() {<a name="line.255"></a> +<span class="sourceLineNo">256</span> return model;<a name="line.256"></a> +<span class="sourceLineNo">257</span> }<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> * Returns the RDF writer that's being serialized to.<a name="line.260"></a> +<span class="sourceLineNo">261</span> *<a name="line.261"></a> +<span class="sourceLineNo">262</span> * @return The RDF writer that's being serialized to.<a name="line.262"></a> +<span class="sourceLineNo">263</span> */<a name="line.263"></a> +<span class="sourceLineNo">264</span> public final RDFWriter getRdfWriter() {<a name="line.264"></a> +<span class="sourceLineNo">265</span> return writer;<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> * XML-encodes the specified string using the {@link XmlUtils#encodeInvalidCharsForText(Object)} method.<a name="line.269"></a> +<span class="sourceLineNo">270</span> *<a name="line.270"></a> +<span class="sourceLineNo">271</span> * @param o The string being encoded.<a name="line.271"></a> +<span class="sourceLineNo">272</span> * @return The encoded string, or <jk>null</jk> if the input was <jk>null</jk>.<a name="line.272"></a> +<span class="sourceLineNo">273</span> */<a name="line.273"></a> +<span class="sourceLineNo">274</span> public final String encodeTextInvalidChars(Object o) {<a name="line.274"></a> +<span class="sourceLineNo">275</span> if (o == null)<a name="line.275"></a> +<span class="sourceLineNo">276</span> return null;<a name="line.276"></a> +<span class="sourceLineNo">277</span> String s = toString(o);<a name="line.277"></a> +<span class="sourceLineNo">278</span> return XmlUtils.encodeInvalidCharsForText(s);<a name="line.278"></a> +<span class="sourceLineNo">279</span> }<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> * XML-encoded the specified element name using the {@link XmlUtils#encodeElementName(Object)} method.<a name="line.282"></a> +<span class="sourceLineNo">283</span> *<a name="line.283"></a> +<span class="sourceLineNo">284</span> * @param o The string being encoded.<a name="line.284"></a> +<span class="sourceLineNo">285</span> * @return The encoded string.<a name="line.285"></a> +<span class="sourceLineNo">286</span> */<a name="line.286"></a> +<span class="sourceLineNo">287</span> public final String encodeElementName(Object o) {<a name="line.287"></a> +<span class="sourceLineNo">288</span> String s = toString(o);<a name="line.288"></a> +<span class="sourceLineNo">289</span> return XmlUtils.encodeElementName(s);<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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializerContext.html b/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializerContext.html index 1f934ec..1231c6b 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializerContext.html +++ b/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializerContext.html @@ -73,33 +73,54 @@ <span class="sourceLineNo">065</span> */<a name="line.65"></a> <span class="sourceLineNo">066</span> public static final String JSON_escapeSolidus = "JsonSerializer.escapeSolidus";<a name="line.66"></a> <span class="sourceLineNo">067</span><a name="line.67"></a> -<span class="sourceLineNo">068</span><a name="line.68"></a> -<span class="sourceLineNo">069</span> final boolean<a name="line.69"></a> -<span class="sourceLineNo">070</span> simpleMode,<a name="line.70"></a> -<span class="sourceLineNo">071</span> escapeSolidus;<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> * Constructor.<a name="line.74"></a> -<span class="sourceLineNo">075</span> * <p><a name="line.75"></a> -<span class="sourceLineNo">076</span> * Typically only called from {@link ContextFactory#getContext(Class)}.<a name="line.76"></a> -<span class="sourceLineNo">077</span> *<a name="line.77"></a> -<span class="sourceLineNo">078</span> * @param cf The factory that created this context.<a name="line.78"></a> -<span class="sourceLineNo">079</span> */<a name="line.79"></a> -<span class="sourceLineNo">080</span> public JsonSerializerContext(ContextFactory cf) {<a name="line.80"></a> -<span class="sourceLineNo">081</span> super(cf);<a name="line.81"></a> -<span class="sourceLineNo">082</span> simpleMode = cf.getProperty(JSON_simpleMode, boolean.class, false);<a name="line.82"></a> -<span class="sourceLineNo">083</span> escapeSolidus = cf.getProperty(JSON_escapeSolidus, boolean.class, false);<a name="line.83"></a> -<span class="sourceLineNo">084</span> }<a name="line.84"></a> -<span class="sourceLineNo">085</span><a name="line.85"></a> -<span class="sourceLineNo">086</span> @Override /* Context */<a name="line.86"></a> -<span class="sourceLineNo">087</span> public ObjectMap asMap() {<a name="line.87"></a> -<span class="sourceLineNo">088</span> return super.asMap()<a name="line.88"></a> -<span class="sourceLineNo">089</span> .append("JsonSerializerContext", new ObjectMap()<a name="line.89"></a> -<span class="sourceLineNo">090</span> .append("simpleMode", simpleMode)<a name="line.90"></a> -<span class="sourceLineNo">091</span> .append("escapeSolidus", escapeSolidus)<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>}<a name="line.94"></a> +<span class="sourceLineNo">068</span> /**<a name="line.68"></a> +<span class="sourceLineNo">069</span> * <b>Configuration property:</b> Add <js>"_type"</js> properties when needed.<a name="line.69"></a> +<span class="sourceLineNo">070</span> * <p><a name="line.70"></a> +<span class="sourceLineNo">071</span> * <ul><a name="line.71"></a> +<span class="sourceLineNo">072</span> * <li><b>Name:</b> <js>"JsonSerializer.addBeanTypeProperties"</js><a name="line.72"></a> +<span class="sourceLineNo">073</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.73"></a> +<span class="sourceLineNo">074</span> * <li><b>Default:</b> <jk>false</jk><a name="line.74"></a> +<span class="sourceLineNo">075</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.75"></a> +<span class="sourceLineNo">076</span> * </ul><a name="line.76"></a> +<span class="sourceLineNo">077</span> * <p><a name="line.77"></a> +<span class="sourceLineNo">078</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.78"></a> +<span class="sourceLineNo">079</span> * This is used to recreate the correct objects during parsing if the object types cannot be inferred.<a name="line.79"></a> +<span class="sourceLineNo">080</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.80"></a> +<span class="sourceLineNo">081</span> * <p><a name="line.81"></a> +<span class="sourceLineNo">082</span> * When present, this value overrides the {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is<a name="line.82"></a> +<span class="sourceLineNo">083</span> * provided to customize the behavior of specific serializers in a {@link SerializerGroup}.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> public static final String JSON_addBeanTypeProperties = "JsonSerializer.addBeanTypeProperties";<a name="line.85"></a> +<span class="sourceLineNo">086</span><a name="line.86"></a> +<span class="sourceLineNo">087</span> final boolean<a name="line.87"></a> +<span class="sourceLineNo">088</span> simpleMode,<a name="line.88"></a> +<span class="sourceLineNo">089</span> escapeSolidus,<a name="line.89"></a> +<span class="sourceLineNo">090</span> addBeanTypeProperties;<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> * Constructor.<a name="line.93"></a> +<span class="sourceLineNo">094</span> * <p><a name="line.94"></a> +<span class="sourceLineNo">095</span> * Typically only called from {@link ContextFactory#getContext(Class)}.<a name="line.95"></a> +<span class="sourceLineNo">096</span> *<a name="line.96"></a> +<span class="sourceLineNo">097</span> * @param cf The factory that created this context.<a name="line.97"></a> +<span class="sourceLineNo">098</span> */<a name="line.98"></a> +<span class="sourceLineNo">099</span> public JsonSerializerContext(ContextFactory cf) {<a name="line.99"></a> +<span class="sourceLineNo">100</span> super(cf);<a name="line.100"></a> +<span class="sourceLineNo">101</span> simpleMode = cf.getProperty(JSON_simpleMode, boolean.class, false);<a name="line.101"></a> +<span class="sourceLineNo">102</span> escapeSolidus = cf.getProperty(JSON_escapeSolidus, boolean.class, false);<a name="line.102"></a> +<span class="sourceLineNo">103</span> addBeanTypeProperties = cf.getProperty(JSON_addBeanTypeProperties, boolean.class, cf.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));<a name="line.103"></a> +<span class="sourceLineNo">104</span> }<a name="line.104"></a> +<span class="sourceLineNo">105</span><a name="line.105"></a> +<span class="sourceLineNo">106</span> @Override /* Context */<a name="line.106"></a> +<span class="sourceLineNo">107</span> public ObjectMap asMap() {<a name="line.107"></a> +<span class="sourceLineNo">108</span> return super.asMap()<a name="line.108"></a> +<span class="sourceLineNo">109</span> .append("JsonSerializerContext", new ObjectMap()<a name="line.109"></a> +<span class="sourceLineNo">110</span> .append("simpleMode", simpleMode)<a name="line.110"></a> +<span class="sourceLineNo">111</span> .append("escapeSolidus", escapeSolidus)<a name="line.111"></a> +<span class="sourceLineNo">112</span> .append("addBeanTypeProperties", addBeanTypeProperties)<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>}<a name="line.115"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializerSession.html b/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializerSession.html index ba9100b..9301b10 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializerSession.html +++ b/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializerSession.html @@ -35,60 +35,75 @@ <span class="sourceLineNo">027</span> */<a name="line.27"></a> <span class="sourceLineNo">028</span>public final class JsonSerializerSession extends SerializerSession {<a name="line.28"></a> <span class="sourceLineNo">029</span><a name="line.29"></a> -<span class="sourceLineNo">030</span> private final boolean simpleMode, escapeSolidus;<a name="line.30"></a> -<span class="sourceLineNo">031</span><a name="line.31"></a> -<span class="sourceLineNo">032</span> /**<a name="line.32"></a> -<span class="sourceLineNo">033</span> * Create a new session using properties specified in the context.<a name="line.33"></a> -<span class="sourceLineNo">034</span> *<a name="line.34"></a> -<span class="sourceLineNo">035</span> * @param ctx The context creating this session object.<a name="line.35"></a> -<span class="sourceLineNo">036</span> * The context contains all the configuration settings for this object.<a name="line.36"></a> -<span class="sourceLineNo">037</span> * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.<a name="line.37"></a> -<span class="sourceLineNo">038</span> * @param op The override properties.<a name="line.38"></a> -<span class="sourceLineNo">039</span> * These override any context properties defined in the context.<a name="line.39"></a> -<span class="sourceLineNo">040</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.40"></a> -<span class="sourceLineNo">041</span> * @param locale The session locale.<a name="line.41"></a> -<span class="sourceLineNo">042</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.42"></a> -<span class="sourceLineNo">043</span> * @param timeZone The session timezone.<a name="line.43"></a> -<span class="sourceLineNo">044</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.45"></a> -<span class="sourceLineNo">046</span> */<a name="line.46"></a> -<span class="sourceLineNo">047</span> protected JsonSerializerSession(JsonSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.47"></a> -<span class="sourceLineNo">048</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.48"></a> -<span class="sourceLineNo">049</span> if (op == null || op.isEmpty()) {<a name="line.49"></a> -<span class="sourceLineNo">050</span> simpleMode = ctx.simpleMode;<a name="line.50"></a> -<span class="sourceLineNo">051</span> escapeSolidus = ctx.escapeSolidus;<a name="line.51"></a> -<span class="sourceLineNo">052</span> } else {<a name="line.52"></a> -<span class="sourceLineNo">053</span> simpleMode = op.getBoolean(JSON_simpleMode, ctx.simpleMode);<a name="line.53"></a> -<span class="sourceLineNo">054</span> escapeSolidus = op.getBoolean(JSON_escapeSolidus, ctx.escapeSolidus);<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><a name="line.57"></a> -<span class="sourceLineNo">058</span> /**<a name="line.58"></a> -<span class="sourceLineNo">059</span> * Returns the {@link JsonSerializerContext#JSON_simpleMode} setting value for this session.<a name="line.59"></a> -<span class="sourceLineNo">060</span> *<a name="line.60"></a> -<span class="sourceLineNo">061</span> * @return The {@link JsonSerializerContext#JSON_simpleMode} setting value for this session.<a name="line.61"></a> -<span class="sourceLineNo">062</span> */<a name="line.62"></a> -<span class="sourceLineNo">063</span> public final boolean isSimpleMode() {<a name="line.63"></a> -<span class="sourceLineNo">064</span> return simpleMode;<a name="line.64"></a> -<span class="sourceLineNo">065</span> }<a name="line.65"></a> -<span class="sourceLineNo">066</span><a name="line.66"></a> -<span class="sourceLineNo">067</span> /**<a name="line.67"></a> -<span class="sourceLineNo">068</span> * Returns the {@link JsonSerializerContext#JSON_escapeSolidus} 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> * @return The {@link JsonSerializerContext#JSON_escapeSolidus} setting value for this session.<a name="line.70"></a> -<span class="sourceLineNo">071</span> */<a name="line.71"></a> -<span class="sourceLineNo">072</span> public final boolean isEscapeSolidus() {<a name="line.72"></a> -<span class="sourceLineNo">073</span> return escapeSolidus;<a name="line.73"></a> -<span class="sourceLineNo">074</span> }<a name="line.74"></a> -<span class="sourceLineNo">075</span><a name="line.75"></a> -<span class="sourceLineNo">076</span> @Override /* ParserSession */<a name="line.76"></a> -<span class="sourceLineNo">077</span> public JsonWriter getWriter() throws Exception {<a name="line.77"></a> -<span class="sourceLineNo">078</span> Object output = getOutput();<a name="line.78"></a> -<span class="sourceLineNo">079</span> if (output instanceof JsonWriter)<a name="line.79"></a> -<span class="sourceLineNo">080</span> return (JsonWriter)output;<a name="line.80"></a> -<span class="sourceLineNo">081</span> return new JsonWriter(super.getWriter(), isUseWhitespace(), isEscapeSolidus(), getQuoteChar(), isSimpleMode(), isTrimStrings(), getRelativeUriBase(), getAbsolutePathUriBase());<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">030</span> private final boolean<a name="line.30"></a> +<span class="sourceLineNo">031</span> simpleMode,<a name="line.31"></a> +<span class="sourceLineNo">032</span> escapeSolidus,<a name="line.32"></a> +<span class="sourceLineNo">033</span> addBeanTypeProperties;<a name="line.33"></a> +<span class="sourceLineNo">034</span><a name="line.34"></a> +<span class="sourceLineNo">035</span> /**<a name="line.35"></a> +<span class="sourceLineNo">036</span> * Create a new session using properties specified in the context.<a name="line.36"></a> +<span class="sourceLineNo">037</span> *<a name="line.37"></a> +<span class="sourceLineNo">038</span> * @param ctx The context creating this session object.<a name="line.38"></a> +<span class="sourceLineNo">039</span> * The context contains all the configuration settings for this object.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * @param op The override properties.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * These override any context properties defined in the context.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * @param locale The session locale.<a name="line.44"></a> +<span class="sourceLineNo">045</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * @param timeZone The session timezone.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.48"></a> +<span class="sourceLineNo">049</span> */<a name="line.49"></a> +<span class="sourceLineNo">050</span> protected JsonSerializerSession(JsonSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.50"></a> +<span class="sourceLineNo">051</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.51"></a> +<span class="sourceLineNo">052</span> if (op == null || op.isEmpty()) {<a name="line.52"></a> +<span class="sourceLineNo">053</span> simpleMode = ctx.simpleMode;<a name="line.53"></a> +<span class="sourceLineNo">054</span> escapeSolidus = ctx.escapeSolidus;<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> simpleMode = op.getBoolean(JSON_simpleMode, ctx.simpleMode);<a name="line.57"></a> +<span class="sourceLineNo">058</span> escapeSolidus = op.getBoolean(JSON_escapeSolidus, ctx.escapeSolidus);<a name="line.58"></a> +<span class="sourceLineNo">059</span> addBeanTypeProperties = op.getBoolean(JSON_addBeanTypeProperties, ctx.addBeanTypeProperties);<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> /**<a name="line.63"></a> +<span class="sourceLineNo">064</span> * Returns the {@link JsonSerializerContext#JSON_simpleMode} setting value for this session.<a name="line.64"></a> +<span class="sourceLineNo">065</span> *<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @return The {@link JsonSerializerContext#JSON_simpleMode} 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> public final boolean isSimpleMode() {<a name="line.68"></a> +<span class="sourceLineNo">069</span> return simpleMode;<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> /**<a name="line.72"></a> +<span class="sourceLineNo">073</span> * Returns the {@link JsonSerializerContext#JSON_escapeSolidus} setting value for this session.<a name="line.73"></a> +<span class="sourceLineNo">074</span> *<a name="line.74"></a> +<span class="sourceLineNo">075</span> * @return The {@link JsonSerializerContext#JSON_escapeSolidus} setting value for this session.<a name="line.75"></a> +<span class="sourceLineNo">076</span> */<a name="line.76"></a> +<span class="sourceLineNo">077</span> public final boolean isEscapeSolidus() {<a name="line.77"></a> +<span class="sourceLineNo">078</span> return escapeSolidus;<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> /**<a name="line.81"></a> +<span class="sourceLineNo">082</span> * Returns the {@link JsonSerializerContext#JSON_addBeanTypeProperties} setting value for this session.<a name="line.82"></a> +<span class="sourceLineNo">083</span> *<a name="line.83"></a> +<span class="sourceLineNo">084</span> * @return The {@link JsonSerializerContext#JSON_addBeanTypeProperties} setting value for this session.<a name="line.84"></a> +<span class="sourceLineNo">085</span> */<a name="line.85"></a> +<span class="sourceLineNo">086</span> @Override /* SerializerSession */<a name="line.86"></a> +<span class="sourceLineNo">087</span> public final boolean isAddBeanTypeProperties() {<a name="line.87"></a> +<span class="sourceLineNo">088</span> return addBeanTypeProperties;<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 /* ParserSession */<a name="line.91"></a> +<span class="sourceLineNo">092</span> public JsonWriter getWriter() throws Exception {<a name="line.92"></a> +<span class="sourceLineNo">093</span> Object output = getOutput();<a name="line.93"></a> +<span class="sourceLineNo">094</span> if (output instanceof JsonWriter)<a name="line.94"></a> +<span class="sourceLineNo">095</span> return (JsonWriter)output;<a name="line.95"></a> +<span class="sourceLineNo">096</span> return new JsonWriter(super.getWriter(), isUseWhitespace(), isEscapeSolidus(), getQuoteChar(), isSimpleMode(), isTrimStrings(), getRelativeUriBase(), getAbsolutePathUriBase());<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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializerContext.html b/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializerContext.html index c8aab42..cee5038 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializerContext.html +++ b/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializerContext.html @@ -42,23 +42,47 @@ <span class="sourceLineNo">034</span>public final class MsgPackSerializerContext extends SerializerContext {<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> * Constructor.<a name="line.37"></a> +<span class="sourceLineNo">037</span> * <b>Configuration property:</b> Add <js>"_type"</js> properties when needed.<a name="line.37"></a> <span class="sourceLineNo">038</span> * <p><a name="line.38"></a> -<span class="sourceLineNo">039</span> * Typically only called from {@link ContextFactory#getContext(Class)}.<a name="line.39"></a> -<span class="sourceLineNo">040</span> *<a name="line.40"></a> -<span class="sourceLineNo">041</span> * @param cf The factory that created this context.<a name="line.41"></a> -<span class="sourceLineNo">042</span> */<a name="line.42"></a> -<span class="sourceLineNo">043</span> public MsgPackSerializerContext(ContextFactory cf) {<a name="line.43"></a> -<span class="sourceLineNo">044</span> super(cf);<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> @Override /* Context */<a name="line.47"></a> -<span class="sourceLineNo">048</span> public ObjectMap asMap() {<a name="line.48"></a> -<span class="sourceLineNo">049</span> return super.asMap()<a name="line.49"></a> -<span class="sourceLineNo">050</span> .append("MsgPackSerializerContext", new ObjectMap()<a name="line.50"></a> -<span class="sourceLineNo">051</span> );<a name="line.51"></a> -<span class="sourceLineNo">052</span> }<a name="line.52"></a> -<span class="sourceLineNo">053</span>}<a name="line.53"></a> +<span class="sourceLineNo">039</span> * <ul><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <li><b>Name:</b> <js>"MsgPackSerializer.addBeanTypeProperties"</js><a name="line.40"></a> +<span class="sourceLineNo">041</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.41"></a> +<span class="sourceLineNo">042</span> * <li><b>Default:</b> <jk>false</jk><a name="line.42"></a> +<span class="sourceLineNo">043</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.43"></a> +<span class="sourceLineNo">044</span> * </ul><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <p><a name="line.45"></a> +<span class="sourceLineNo">046</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.46"></a> +<span class="sourceLineNo">047</span> * This is used to recreate the correct objects during parsing if the object types cannot be inferred.<a name="line.47"></a> +<span class="sourceLineNo">048</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.48"></a> +<span class="sourceLineNo">049</span> * <p><a name="line.49"></a> +<span class="sourceLineNo">050</span> * When present, this value overrides the {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is<a name="line.50"></a> +<span class="sourceLineNo">051</span> * provided to customize the behavior of specific serializers in a {@link SerializerGroup}.<a name="line.51"></a> +<span class="sourceLineNo">052</span> */<a name="line.52"></a> +<span class="sourceLineNo">053</span> public static final String MSGPACK_addBeanTypeProperties = "MsgPackSerializer.addBeanTypeProperties";<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> addBeanTypeProperties;<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 MsgPackSerializerContext(ContextFactory cf) {<a name="line.65"></a> +<span class="sourceLineNo">066</span> super(cf);<a name="line.66"></a> +<span class="sourceLineNo">067</span> addBeanTypeProperties = cf.getProperty(MSGPACK_addBeanTypeProperties, boolean.class, cf.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));<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("MsgPackSerializerContext", new ObjectMap()<a name="line.73"></a> +<span class="sourceLineNo">074</span> .append("addBeanTypeProperties", addBeanTypeProperties)<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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializerSession.html b/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializerSession.html index 89c0bd5..cb71971 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializerSession.html +++ b/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializerSession.html @@ -20,48 +20,68 @@ <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> <span class="sourceLineNo">013</span>package org.apache.juneau.msgpack;<a name="line.13"></a> <span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import java.lang.reflect.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span>import java.util.*;<a name="line.16"></a> -<span class="sourceLineNo">017</span><a name="line.17"></a> -<span class="sourceLineNo">018</span>import org.apache.juneau.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span>import org.apache.juneau.MediaType;<a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.juneau.json.*;<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> * Session object that lives for the duration of a single use of {@link MsgPackSerializer}.<a name="line.24"></a> -<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> -<span class="sourceLineNo">026</span> * This class is NOT thread safe. It is meant to be discarded after one-time use.<a name="line.26"></a> -<span class="sourceLineNo">027</span> */<a name="line.27"></a> -<span class="sourceLineNo">028</span>public final class MsgPackSerializerSession extends SerializerSession {<a name="line.28"></a> -<span class="sourceLineNo">029</span><a name="line.29"></a> -<span class="sourceLineNo">030</span> /**<a name="line.30"></a> -<span class="sourceLineNo">031</span> * Create a new session using properties specified in the context.<a name="line.31"></a> -<span class="sourceLineNo">032</span> *<a name="line.32"></a> -<span class="sourceLineNo">033</span> * @param ctx The context creating this session object.<a name="line.33"></a> -<span class="sourceLineNo">034</span> * The context contains all the configuration settings for this object.<a name="line.34"></a> -<span class="sourceLineNo">035</span> * @param output The output object. See {@link JsonSerializerSession#getOutputStream()} for valid class types.<a name="line.35"></a> -<span class="sourceLineNo">036</span> * @param op The override properties.<a name="line.36"></a> -<span class="sourceLineNo">037</span> * These override any context properties defined in the context.<a name="line.37"></a> -<span class="sourceLineNo">038</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.38"></a> -<span class="sourceLineNo">039</span> * @param locale The session locale.<a name="line.39"></a> -<span class="sourceLineNo">040</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.40"></a> -<span class="sourceLineNo">041</span> * @param timeZone The session timezone.<a name="line.41"></a> -<span class="sourceLineNo">042</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.42"></a> -<span class="sourceLineNo">043</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.43"></a> -<span class="sourceLineNo">044</span> */<a name="line.44"></a> -<span class="sourceLineNo">045</span> protected MsgPackSerializerSession(MsgPackSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.45"></a> -<span class="sourceLineNo">046</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<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> @Override<a name="line.49"></a> -<span class="sourceLineNo">050</span> public MsgPackOutputStream getOutputStream() throws Exception {<a name="line.50"></a> -<span class="sourceLineNo">051</span> Object output = getOutput();<a name="line.51"></a> -<span class="sourceLineNo">052</span> if (output instanceof MsgPackOutputStream)<a name="line.52"></a> -<span class="sourceLineNo">053</span> return (MsgPackOutputStream)output;<a name="line.53"></a> -<span class="sourceLineNo">054</span> return new MsgPackOutputStream(super.getOutputStream());<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">015</span>import static org.apache.juneau.msgpack.MsgPackSerializerContext.*;<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.MediaType;<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 MsgPackSerializer}.<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 final class MsgPackSerializerSession 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> addBeanTypeProperties;<a name="line.33"></a> +<span class="sourceLineNo">034</span><a name="line.34"></a> +<span class="sourceLineNo">035</span> /**<a name="line.35"></a> +<span class="sourceLineNo">036</span> * Create a new session using properties specified in the context.<a name="line.36"></a> +<span class="sourceLineNo">037</span> *<a name="line.37"></a> +<span class="sourceLineNo">038</span> * @param ctx The context creating this session object.<a name="line.38"></a> +<span class="sourceLineNo">039</span> * The context contains all the configuration settings for this object.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * @param output The output object. See {@link JsonSerializerSession#getOutputStream()} for valid class types.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * @param op The override properties.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * These override any context properties defined in the context.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * @param locale The session locale.<a name="line.44"></a> +<span class="sourceLineNo">045</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * @param timeZone The session timezone.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.48"></a> +<span class="sourceLineNo">049</span> */<a name="line.49"></a> +<span class="sourceLineNo">050</span> protected MsgPackSerializerSession(MsgPackSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.50"></a> +<span class="sourceLineNo">051</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.51"></a> +<span class="sourceLineNo">052</span> if (op == null || op.isEmpty()) {<a name="line.52"></a> +<span class="sourceLineNo">053</span> addBeanTypeProperties = ctx.addBeanTypeProperties;<a name="line.53"></a> +<span class="sourceLineNo">054</span> } else {<a name="line.54"></a> +<span class="sourceLineNo">055</span> addBeanTypeProperties = op.getBoolean(MSGPACK_addBeanTypeProperties, ctx.addBeanTypeProperties);<a name="line.55"></a> +<span class="sourceLineNo">056</span> }<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> /**<a name="line.59"></a> +<span class="sourceLineNo">060</span> * Returns the {@link MsgPackSerializerContext#MSGPACK_addBeanTypeProperties} setting value for this session.<a name="line.60"></a> +<span class="sourceLineNo">061</span> *<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @return The {@link MsgPackSerializerContext#MSGPACK_addBeanTypeProperties} setting value for this session.<a name="line.62"></a> +<span class="sourceLineNo">063</span> */<a name="line.63"></a> +<span class="sourceLineNo">064</span> @Override /* SerializerSession */<a name="line.64"></a> +<span class="sourceLineNo">065</span> public final boolean isAddBeanTypeProperties() {<a name="line.65"></a> +<span class="sourceLineNo">066</span> return addBeanTypeProperties;<a name="line.66"></a> +<span class="sourceLineNo">067</span> }<a name="line.67"></a> +<span class="sourceLineNo">068</span><a name="line.68"></a> +<span class="sourceLineNo">069</span> @Override /*SerializerSession */<a name="line.69"></a> +<span class="sourceLineNo">070</span> public MsgPackOutputStream getOutputStream() throws Exception {<a name="line.70"></a> +<span class="sourceLineNo">071</span> Object output = getOutput();<a name="line.71"></a> +<span class="sourceLineNo">072</span> if (output instanceof MsgPackOutputStream)<a name="line.72"></a> +<span class="sourceLineNo">073</span> return (MsgPackOutputStream)output;<a name="line.73"></a> +<span class="sourceLineNo">074</span> return new MsgPackOutputStream(super.getOutputStream());<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>
