http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/src-html/org/apache/juneau/json/JsonWriter.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/json/JsonWriter.html b/content/site/apidocs/src-html/org/apache/juneau/json/JsonWriter.html index 1a7557c..eb2c3d1 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/json/JsonWriter.html +++ b/content/site/apidocs/src-html/org/apache/juneau/json/JsonWriter.html @@ -22,244 +22,247 @@ <span class="sourceLineNo">014</span><a name="line.14"></a> <span class="sourceLineNo">015</span>import java.io.*;<a name="line.15"></a> <span class="sourceLineNo">016</span><a name="line.16"></a> -<span class="sourceLineNo">017</span>import org.apache.juneau.internal.*;<a name="line.17"></a> -<span class="sourceLineNo">018</span>import org.apache.juneau.serializer.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>/**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * Specialized writer for serializing JSON.<a name="line.21"></a> -<span class="sourceLineNo">022</span> * <p><a name="line.22"></a> -<span class="sourceLineNo">023</span> * <h5 class='section'>Notes:</h5><a name="line.23"></a> -<span class="sourceLineNo">024</span> * <ul><a name="line.24"></a> -<span class="sourceLineNo">025</span> * <li>This class is not intended for external use.<a name="line.25"></a> -<span class="sourceLineNo">026</span> * </ul><a name="line.26"></a> -<span class="sourceLineNo">027</span> */<a name="line.27"></a> -<span class="sourceLineNo">028</span>public final class JsonWriter extends SerializerWriter {<a name="line.28"></a> -<span class="sourceLineNo">029</span><a name="line.29"></a> -<span class="sourceLineNo">030</span> private final boolean laxMode, escapeSolidus;<a name="line.30"></a> -<span class="sourceLineNo">031</span><a name="line.31"></a> -<span class="sourceLineNo">032</span> // Characters that trigger special handling of serializing attribute values.<a name="line.32"></a> -<span class="sourceLineNo">033</span> private static final AsciiSet<a name="line.33"></a> -<span class="sourceLineNo">034</span> encodedChars = new AsciiSet("\n\t\b\f\r'\"\\"),<a name="line.34"></a> -<span class="sourceLineNo">035</span> encodedChars2 = new AsciiSet("\n\t\b\f\r'\"\\/");<a name="line.35"></a> -<span class="sourceLineNo">036</span><a name="line.36"></a> -<span class="sourceLineNo">037</span> private static final KeywordSet reservedWords = new KeywordSet(<a name="line.37"></a> -<span class="sourceLineNo">038</span> "arguments","break","case","catch","class","const","continue","debugger","default","delete",<a name="line.38"></a> -<span class="sourceLineNo">039</span> "do","else","enum","eval","export","extends","false","finally","for","function","if",<a name="line.39"></a> -<span class="sourceLineNo">040</span> "implements","import","in","instanceof","interface","let","new","null","package",<a name="line.40"></a> -<span class="sourceLineNo">041</span> "private","protected","public","return","static","super","switch","this","throw",<a name="line.41"></a> -<span class="sourceLineNo">042</span> "true","try","typeof","var","void","while","with","undefined","yield"<a name="line.42"></a> -<span class="sourceLineNo">043</span> );<a name="line.43"></a> -<span class="sourceLineNo">044</span><a name="line.44"></a> +<span class="sourceLineNo">017</span>import org.apache.juneau.*;<a name="line.17"></a> +<span class="sourceLineNo">018</span>import org.apache.juneau.internal.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.serializer.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>/**<a name="line.21"></a> +<span class="sourceLineNo">022</span> * Specialized writer for serializing JSON.<a name="line.22"></a> +<span class="sourceLineNo">023</span> * <p><a name="line.23"></a> +<span class="sourceLineNo">024</span> * <h5 class='section'>Notes:</h5><a name="line.24"></a> +<span class="sourceLineNo">025</span> * <ul><a name="line.25"></a> +<span class="sourceLineNo">026</span> * <li>This class is not intended for external use.<a name="line.26"></a> +<span class="sourceLineNo">027</span> * </ul><a name="line.27"></a> +<span class="sourceLineNo">028</span> */<a name="line.28"></a> +<span class="sourceLineNo">029</span>public final class JsonWriter extends SerializerWriter {<a name="line.29"></a> +<span class="sourceLineNo">030</span><a name="line.30"></a> +<span class="sourceLineNo">031</span> private final boolean laxMode, escapeSolidus;<a name="line.31"></a> +<span class="sourceLineNo">032</span><a name="line.32"></a> +<span class="sourceLineNo">033</span> // Characters that trigger special handling of serializing attribute values.<a name="line.33"></a> +<span class="sourceLineNo">034</span> private static final AsciiSet<a name="line.34"></a> +<span class="sourceLineNo">035</span> encodedChars = new AsciiSet("\n\t\b\f\r'\"\\"),<a name="line.35"></a> +<span class="sourceLineNo">036</span> encodedChars2 = new AsciiSet("\n\t\b\f\r'\"\\/");<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> private static final KeywordSet reservedWords = new KeywordSet(<a name="line.38"></a> +<span class="sourceLineNo">039</span> "arguments","break","case","catch","class","const","continue","debugger","default","delete",<a name="line.39"></a> +<span class="sourceLineNo">040</span> "do","else","enum","eval","export","extends","false","finally","for","function","if",<a name="line.40"></a> +<span class="sourceLineNo">041</span> "implements","import","in","instanceof","interface","let","new","null","package",<a name="line.41"></a> +<span class="sourceLineNo">042</span> "private","protected","public","return","static","super","switch","this","throw",<a name="line.42"></a> +<span class="sourceLineNo">043</span> "true","try","typeof","var","void","while","with","undefined","yield"<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> // Characters that represent attribute name characters that don't trigger quoting.<a name="line.46"></a> -<span class="sourceLineNo">047</span> // These are actually more strict than the actual Javascript specification, but<a name="line.47"></a> -<span class="sourceLineNo">048</span> // can be narrowed in the future if necessary.<a name="line.48"></a> -<span class="sourceLineNo">049</span> // For example, we quote attributes that start with $ even though we don't need to.<a name="line.49"></a> -<span class="sourceLineNo">050</span> private static final AsciiSet validAttrChars = new AsciiSet("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_");<a name="line.50"></a> -<span class="sourceLineNo">051</span> private static final AsciiSet validFirstAttrChars = new AsciiSet("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_");<a name="line.51"></a> -<span class="sourceLineNo">052</span><a name="line.52"></a> -<span class="sourceLineNo">053</span> private final AsciiSet ec;<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> * Constructor.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * @param out The writer being wrapped.<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @param useWhitespace If <jk>true</jk>, tabs and spaces will be used in output.<a name="line.58"></a> -<span class="sourceLineNo">059</span> * @param escapeSolidus If <jk>true</jk>, forward slashes should be escaped in the output.<a name="line.59"></a> -<span class="sourceLineNo">060</span> * @param quoteChar The quote character to use (i.e. <js>'\''</js> or <js>'"'</js>)<a name="line.60"></a> -<span class="sourceLineNo">061</span> * @param laxMode If <jk>true</jk>, JSON attributes will only be quoted when necessary.<a name="line.61"></a> -<span class="sourceLineNo">062</span> * @param trimStrings If <jk>true</jk>, strings will be trimmed before being serialized.<a name="line.62"></a> -<span class="sourceLineNo">063</span> * @param relativeUriBase The base (e.g. <js>https://localhost:9443/contextPath"</js>) for relative URIs (e.g. <js>"my/path"</js>).<a name="line.63"></a> -<span class="sourceLineNo">064</span> * @param absolutePathUriBase The base (e.g. <js>https://localhost:9443"</js>) for relative URIs with absolute paths (e.g. <js>"/contextPath/my/path"</js>).<a name="line.64"></a> -<span class="sourceLineNo">065</span> */<a name="line.65"></a> -<span class="sourceLineNo">066</span> protected JsonWriter(Writer out, boolean useWhitespace, boolean escapeSolidus, char quoteChar, boolean laxMode, boolean trimStrings, String relativeUriBase, String absolutePathUriBase) {<a name="line.66"></a> -<span class="sourceLineNo">067</span> super(out, useWhitespace, trimStrings, quoteChar, relativeUriBase, absolutePathUriBase);<a name="line.67"></a> -<span class="sourceLineNo">068</span> this.laxMode = laxMode;<a name="line.68"></a> -<span class="sourceLineNo">069</span> this.escapeSolidus = escapeSolidus;<a name="line.69"></a> -<span class="sourceLineNo">070</span> this.ec = escapeSolidus ? encodedChars2 : encodedChars;<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> /**<a name="line.73"></a> -<span class="sourceLineNo">074</span> * Serializes the specified object as a JSON string value.<a name="line.74"></a> -<span class="sourceLineNo">075</span> * @param s The object being serialized.<a name="line.75"></a> -<span class="sourceLineNo">076</span> * @return This object (for method chaining).<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @throws IOException Should never happen.<a name="line.77"></a> -<span class="sourceLineNo">078</span> */<a name="line.78"></a> -<span class="sourceLineNo">079</span> public JsonWriter stringValue(String s) throws IOException {<a name="line.79"></a> -<span class="sourceLineNo">080</span> if (s == null)<a name="line.80"></a> -<span class="sourceLineNo">081</span> return this;<a name="line.81"></a> -<span class="sourceLineNo">082</span> boolean doConvert = false;<a name="line.82"></a> -<span class="sourceLineNo">083</span> for (int i = 0; i < s.length() && ! doConvert; i++) {<a name="line.83"></a> -<span class="sourceLineNo">084</span> char c = s.charAt(i);<a name="line.84"></a> -<span class="sourceLineNo">085</span> doConvert |= ec.contains(c);<a name="line.85"></a> -<span class="sourceLineNo">086</span> }<a name="line.86"></a> -<span class="sourceLineNo">087</span> q();<a name="line.87"></a> -<span class="sourceLineNo">088</span> if (! doConvert) {<a name="line.88"></a> -<span class="sourceLineNo">089</span> out.append(s);<a name="line.89"></a> -<span class="sourceLineNo">090</span> } else {<a name="line.90"></a> -<span class="sourceLineNo">091</span> for (int i = 0; i < s.length(); i++) {<a name="line.91"></a> -<span class="sourceLineNo">092</span> char c = s.charAt(i);<a name="line.92"></a> -<span class="sourceLineNo">093</span> if (ec.contains(c)) {<a name="line.93"></a> -<span class="sourceLineNo">094</span> if (c == '\n')<a name="line.94"></a> -<span class="sourceLineNo">095</span> out.append('\\').append('n');<a name="line.95"></a> -<span class="sourceLineNo">096</span> else if (c == '\t')<a name="line.96"></a> -<span class="sourceLineNo">097</span> out.append('\\').append('t');<a name="line.97"></a> -<span class="sourceLineNo">098</span> else if (c == '\b')<a name="line.98"></a> -<span class="sourceLineNo">099</span> out.append('\\').append('b');<a name="line.99"></a> -<span class="sourceLineNo">100</span> else if (c == '\f')<a name="line.100"></a> -<span class="sourceLineNo">101</span> out.append('\\').append('f');<a name="line.101"></a> -<span class="sourceLineNo">102</span> else if (c == quoteChar)<a name="line.102"></a> -<span class="sourceLineNo">103</span> out.append('\\').append(quoteChar);<a name="line.103"></a> -<span class="sourceLineNo">104</span> else if (c == '\\')<a name="line.104"></a> -<span class="sourceLineNo">105</span> out.append('\\').append('\\');<a name="line.105"></a> -<span class="sourceLineNo">106</span> else if (c == '/' && escapeSolidus)<a name="line.106"></a> -<span class="sourceLineNo">107</span> out.append('\\').append('/');<a name="line.107"></a> -<span class="sourceLineNo">108</span> else if (c != '\r')<a name="line.108"></a> -<span class="sourceLineNo">109</span> out.append(c);<a name="line.109"></a> -<span class="sourceLineNo">110</span> } else {<a name="line.110"></a> -<span class="sourceLineNo">111</span> out.append(c);<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> q();<a name="line.115"></a> -<span class="sourceLineNo">116</span> return this;<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> /**<a name="line.119"></a> -<span class="sourceLineNo">120</span> * Serializes the specified object as a JSON attribute name.<a name="line.120"></a> -<span class="sourceLineNo">121</span> * @param s The object being serialized.<a name="line.121"></a> -<span class="sourceLineNo">122</span> * @return This object (for method chaining).<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @throws IOException Should never happen.<a name="line.123"></a> -<span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> public JsonWriter attr(String s) throws IOException {<a name="line.125"></a> -<span class="sourceLineNo">126</span> /*<a name="line.126"></a> -<span class="sourceLineNo">127</span> * Converts a Java string to an acceptable JSON attribute name. If<a name="line.127"></a> -<span class="sourceLineNo">128</span> * useStrictJson is false, then quotes will only be used if the attribute<a name="line.128"></a> -<span class="sourceLineNo">129</span> * name consists of only alphanumeric characters.<a name="line.129"></a> -<span class="sourceLineNo">130</span> */<a name="line.130"></a> -<span class="sourceLineNo">131</span> boolean doConvert = trimStrings || ! laxMode; // Always convert when not in lax mode.<a name="line.131"></a> -<span class="sourceLineNo">132</span><a name="line.132"></a> -<span class="sourceLineNo">133</span> // If the attribute is null, it must always be printed as null without quotes.<a name="line.133"></a> -<span class="sourceLineNo">134</span> // Technically, this isn't part of the JSON spec, but it does allow for null key values.<a name="line.134"></a> -<span class="sourceLineNo">135</span> if (s == null) {<a name="line.135"></a> -<span class="sourceLineNo">136</span> s = "null";<a name="line.136"></a> -<span class="sourceLineNo">137</span> doConvert = false;<a name="line.137"></a> -<span class="sourceLineNo">138</span><a name="line.138"></a> -<span class="sourceLineNo">139</span> } else {<a name="line.139"></a> -<span class="sourceLineNo">140</span><a name="line.140"></a> -<span class="sourceLineNo">141</span> // Look for characters that would require the attribute to be quoted.<a name="line.141"></a> -<span class="sourceLineNo">142</span> // All possible numbers should be caught here.<a name="line.142"></a> -<span class="sourceLineNo">143</span> if (! doConvert) {<a name="line.143"></a> -<span class="sourceLineNo">144</span> for (int i = 0; i < s.length() && ! doConvert; i++) {<a name="line.144"></a> -<span class="sourceLineNo">145</span> char c = s.charAt(i);<a name="line.145"></a> -<span class="sourceLineNo">146</span> doConvert |= ! (i == 0 ? validFirstAttrChars.contains(c) : validAttrChars.contains(c));<a name="line.146"></a> -<span class="sourceLineNo">147</span> }<a name="line.147"></a> -<span class="sourceLineNo">148</span> }<a name="line.148"></a> -<span class="sourceLineNo">149</span><a name="line.149"></a> -<span class="sourceLineNo">150</span> // Reserved words and blanks must be quoted.<a name="line.150"></a> -<span class="sourceLineNo">151</span> if (! doConvert) {<a name="line.151"></a> -<span class="sourceLineNo">152</span> if (s.isEmpty() || reservedWords.contains(s))<a name="line.152"></a> -<span class="sourceLineNo">153</span> doConvert = true;<a name="line.153"></a> -<span class="sourceLineNo">154</span> }<a name="line.154"></a> -<span class="sourceLineNo">155</span> }<a name="line.155"></a> -<span class="sourceLineNo">156</span><a name="line.156"></a> -<span class="sourceLineNo">157</span> // If no conversion necessary, just print the attribute as-is.<a name="line.157"></a> -<span class="sourceLineNo">158</span> if (doConvert)<a name="line.158"></a> -<span class="sourceLineNo">159</span> stringValue(s);<a name="line.159"></a> -<span class="sourceLineNo">160</span> else<a name="line.160"></a> -<span class="sourceLineNo">161</span> out.append(s);<a name="line.161"></a> -<span class="sourceLineNo">162</span><a name="line.162"></a> -<span class="sourceLineNo">163</span> return this;<a name="line.163"></a> -<span class="sourceLineNo">164</span> }<a name="line.164"></a> +<span class="sourceLineNo">046</span><a name="line.46"></a> +<span class="sourceLineNo">047</span> // Characters that represent attribute name characters that don't trigger quoting.<a name="line.47"></a> +<span class="sourceLineNo">048</span> // These are actually more strict than the actual Javascript specification, but<a name="line.48"></a> +<span class="sourceLineNo">049</span> // can be narrowed in the future if necessary.<a name="line.49"></a> +<span class="sourceLineNo">050</span> // For example, we quote attributes that start with $ even though we don't need to.<a name="line.50"></a> +<span class="sourceLineNo">051</span> private static final AsciiSet validAttrChars = new AsciiSet("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_");<a name="line.51"></a> +<span class="sourceLineNo">052</span> private static final AsciiSet validFirstAttrChars = new AsciiSet("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_");<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> private final AsciiSet ec;<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> * Constructor.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param out The writer being wrapped.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @param useWhitespace If <jk>true</jk>, tabs and spaces will be used in output.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @param escapeSolidus If <jk>true</jk>, forward slashes should be escaped in the output.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @param quoteChar The quote character to use (i.e. <js>'\''</js> or <js>'"'</js>)<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @param laxMode If <jk>true</jk>, JSON attributes will only be quoted when necessary.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @param trimStrings If <jk>true</jk>, strings will be trimmed before being serialized.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @param relativeUriBase The base (e.g. <js>https://localhost:9443/contextPath"</js>) for relative URIs (e.g. <js>"my/path"</js>).<a name="line.64"></a> +<span class="sourceLineNo">065</span> * @param absolutePathUriBase The base (e.g. <js>https://localhost:9443"</js>) for relative URIs with absolute paths (e.g. <js>"/contextPath/my/path"</js>).<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @param uriContext The URI context.<a name="line.66"></a> +<span class="sourceLineNo">067</span> * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.<a name="line.67"></a> +<span class="sourceLineNo">068</span> */<a name="line.68"></a> +<span class="sourceLineNo">069</span> protected JsonWriter(Writer out, boolean useWhitespace, boolean escapeSolidus, char quoteChar, boolean laxMode, boolean trimStrings, String relativeUriBase, String absolutePathUriBase, UriContext uriContext) {<a name="line.69"></a> +<span class="sourceLineNo">070</span> super(out, useWhitespace, trimStrings, quoteChar, relativeUriBase, absolutePathUriBase, uriContext);<a name="line.70"></a> +<span class="sourceLineNo">071</span> this.laxMode = laxMode;<a name="line.71"></a> +<span class="sourceLineNo">072</span> this.escapeSolidus = escapeSolidus;<a name="line.72"></a> +<span class="sourceLineNo">073</span> this.ec = escapeSolidus ? encodedChars2 : encodedChars;<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> /**<a name="line.76"></a> +<span class="sourceLineNo">077</span> * Serializes the specified object as a JSON string value.<a name="line.77"></a> +<span class="sourceLineNo">078</span> * @param s The object being serialized.<a name="line.78"></a> +<span class="sourceLineNo">079</span> * @return This object (for method chaining).<a name="line.79"></a> +<span class="sourceLineNo">080</span> * @throws IOException Should never happen.<a name="line.80"></a> +<span class="sourceLineNo">081</span> */<a name="line.81"></a> +<span class="sourceLineNo">082</span> public JsonWriter stringValue(String s) throws IOException {<a name="line.82"></a> +<span class="sourceLineNo">083</span> if (s == null)<a name="line.83"></a> +<span class="sourceLineNo">084</span> return this;<a name="line.84"></a> +<span class="sourceLineNo">085</span> boolean doConvert = false;<a name="line.85"></a> +<span class="sourceLineNo">086</span> for (int i = 0; i < s.length() && ! doConvert; i++) {<a name="line.86"></a> +<span class="sourceLineNo">087</span> char c = s.charAt(i);<a name="line.87"></a> +<span class="sourceLineNo">088</span> doConvert |= ec.contains(c);<a name="line.88"></a> +<span class="sourceLineNo">089</span> }<a name="line.89"></a> +<span class="sourceLineNo">090</span> q();<a name="line.90"></a> +<span class="sourceLineNo">091</span> if (! doConvert) {<a name="line.91"></a> +<span class="sourceLineNo">092</span> out.append(s);<a name="line.92"></a> +<span class="sourceLineNo">093</span> } else {<a name="line.93"></a> +<span class="sourceLineNo">094</span> for (int i = 0; i < s.length(); i++) {<a name="line.94"></a> +<span class="sourceLineNo">095</span> char c = s.charAt(i);<a name="line.95"></a> +<span class="sourceLineNo">096</span> if (ec.contains(c)) {<a name="line.96"></a> +<span class="sourceLineNo">097</span> if (c == '\n')<a name="line.97"></a> +<span class="sourceLineNo">098</span> out.append('\\').append('n');<a name="line.98"></a> +<span class="sourceLineNo">099</span> else if (c == '\t')<a name="line.99"></a> +<span class="sourceLineNo">100</span> out.append('\\').append('t');<a name="line.100"></a> +<span class="sourceLineNo">101</span> else if (c == '\b')<a name="line.101"></a> +<span class="sourceLineNo">102</span> out.append('\\').append('b');<a name="line.102"></a> +<span class="sourceLineNo">103</span> else if (c == '\f')<a name="line.103"></a> +<span class="sourceLineNo">104</span> out.append('\\').append('f');<a name="line.104"></a> +<span class="sourceLineNo">105</span> else if (c == quoteChar)<a name="line.105"></a> +<span class="sourceLineNo">106</span> out.append('\\').append(quoteChar);<a name="line.106"></a> +<span class="sourceLineNo">107</span> else if (c == '\\')<a name="line.107"></a> +<span class="sourceLineNo">108</span> out.append('\\').append('\\');<a name="line.108"></a> +<span class="sourceLineNo">109</span> else if (c == '/' && escapeSolidus)<a name="line.109"></a> +<span class="sourceLineNo">110</span> out.append('\\').append('/');<a name="line.110"></a> +<span class="sourceLineNo">111</span> else if (c != '\r')<a name="line.111"></a> +<span class="sourceLineNo">112</span> out.append(c);<a name="line.112"></a> +<span class="sourceLineNo">113</span> } else {<a name="line.113"></a> +<span class="sourceLineNo">114</span> out.append(c);<a name="line.114"></a> +<span class="sourceLineNo">115</span> }<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> q();<a name="line.118"></a> +<span class="sourceLineNo">119</span> return this;<a name="line.119"></a> +<span class="sourceLineNo">120</span> }<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> * Serializes the specified object as a JSON attribute name.<a name="line.123"></a> +<span class="sourceLineNo">124</span> * @param s The object being serialized.<a name="line.124"></a> +<span class="sourceLineNo">125</span> * @return This object (for method chaining).<a name="line.125"></a> +<span class="sourceLineNo">126</span> * @throws IOException Should never happen.<a name="line.126"></a> +<span class="sourceLineNo">127</span> */<a name="line.127"></a> +<span class="sourceLineNo">128</span> public JsonWriter attr(String s) throws IOException {<a name="line.128"></a> +<span class="sourceLineNo">129</span> /*<a name="line.129"></a> +<span class="sourceLineNo">130</span> * Converts a Java string to an acceptable JSON attribute name. If<a name="line.130"></a> +<span class="sourceLineNo">131</span> * useStrictJson is false, then quotes will only be used if the attribute<a name="line.131"></a> +<span class="sourceLineNo">132</span> * name consists of only alphanumeric characters.<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> boolean doConvert = trimStrings || ! laxMode; // Always convert when not in lax mode.<a name="line.134"></a> +<span class="sourceLineNo">135</span><a name="line.135"></a> +<span class="sourceLineNo">136</span> // If the attribute is null, it must always be printed as null without quotes.<a name="line.136"></a> +<span class="sourceLineNo">137</span> // Technically, this isn't part of the JSON spec, but it does allow for null key values.<a name="line.137"></a> +<span class="sourceLineNo">138</span> if (s == null) {<a name="line.138"></a> +<span class="sourceLineNo">139</span> s = "null";<a name="line.139"></a> +<span class="sourceLineNo">140</span> doConvert = false;<a name="line.140"></a> +<span class="sourceLineNo">141</span><a name="line.141"></a> +<span class="sourceLineNo">142</span> } else {<a name="line.142"></a> +<span class="sourceLineNo">143</span><a name="line.143"></a> +<span class="sourceLineNo">144</span> // Look for characters that would require the attribute to be quoted.<a name="line.144"></a> +<span class="sourceLineNo">145</span> // All possible numbers should be caught here.<a name="line.145"></a> +<span class="sourceLineNo">146</span> if (! doConvert) {<a name="line.146"></a> +<span class="sourceLineNo">147</span> for (int i = 0; i < s.length() && ! doConvert; i++) {<a name="line.147"></a> +<span class="sourceLineNo">148</span> char c = s.charAt(i);<a name="line.148"></a> +<span class="sourceLineNo">149</span> doConvert |= ! (i == 0 ? validFirstAttrChars.contains(c) : validAttrChars.contains(c));<a name="line.149"></a> +<span class="sourceLineNo">150</span> }<a name="line.150"></a> +<span class="sourceLineNo">151</span> }<a name="line.151"></a> +<span class="sourceLineNo">152</span><a name="line.152"></a> +<span class="sourceLineNo">153</span> // Reserved words and blanks must be quoted.<a name="line.153"></a> +<span class="sourceLineNo">154</span> if (! doConvert) {<a name="line.154"></a> +<span class="sourceLineNo">155</span> if (s.isEmpty() || reservedWords.contains(s))<a name="line.155"></a> +<span class="sourceLineNo">156</span> doConvert = true;<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> // If no conversion necessary, just print the attribute as-is.<a name="line.160"></a> +<span class="sourceLineNo">161</span> if (doConvert)<a name="line.161"></a> +<span class="sourceLineNo">162</span> stringValue(s);<a name="line.162"></a> +<span class="sourceLineNo">163</span> else<a name="line.163"></a> +<span class="sourceLineNo">164</span> out.append(s);<a name="line.164"></a> <span class="sourceLineNo">165</span><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> // Overridden methods<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 /* SerializerWriter */<a name="line.171"></a> -<span class="sourceLineNo">172</span> public JsonWriter cr(int depth) throws IOException {<a name="line.172"></a> -<span class="sourceLineNo">173</span> super.cr(depth);<a name="line.173"></a> -<span class="sourceLineNo">174</span> return this;<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> @Override /* SerializerWriter */<a name="line.177"></a> -<span class="sourceLineNo">178</span> public JsonWriter appendln(int indent, String text) throws IOException {<a name="line.178"></a> -<span class="sourceLineNo">179</span> super.appendln(indent, text);<a name="line.179"></a> -<span class="sourceLineNo">180</span> return this;<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> @Override /* SerializerWriter */<a name="line.183"></a> -<span class="sourceLineNo">184</span> public JsonWriter appendln(String text) throws IOException {<a name="line.184"></a> -<span class="sourceLineNo">185</span> super.appendln(text);<a name="line.185"></a> -<span class="sourceLineNo">186</span> return this;<a name="line.186"></a> -<span class="sourceLineNo">187</span> }<a name="line.187"></a> -<span class="sourceLineNo">188</span><a name="line.188"></a> -<span class="sourceLineNo">189</span> @Override /* SerializerWriter */<a name="line.189"></a> -<span class="sourceLineNo">190</span> public JsonWriter append(int indent, String text) throws IOException {<a name="line.190"></a> -<span class="sourceLineNo">191</span> super.append(indent, text);<a name="line.191"></a> -<span class="sourceLineNo">192</span> return this;<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> @Override /* SerializerWriter */<a name="line.195"></a> -<span class="sourceLineNo">196</span> public JsonWriter append(int indent, char c) throws IOException {<a name="line.196"></a> -<span class="sourceLineNo">197</span> super.append(indent, c);<a name="line.197"></a> -<span class="sourceLineNo">198</span> return this;<a name="line.198"></a> -<span class="sourceLineNo">199</span> }<a name="line.199"></a> -<span class="sourceLineNo">200</span><a name="line.200"></a> -<span class="sourceLineNo">201</span> @Override /* SerializerWriter */<a name="line.201"></a> -<span class="sourceLineNo">202</span> public JsonWriter s() throws IOException {<a name="line.202"></a> -<span class="sourceLineNo">203</span> super.s();<a name="line.203"></a> -<span class="sourceLineNo">204</span> return this;<a name="line.204"></a> -<span class="sourceLineNo">205</span> }<a name="line.205"></a> -<span class="sourceLineNo">206</span><a name="line.206"></a> -<span class="sourceLineNo">207</span> @Override /* SerializerWriter */<a name="line.207"></a> -<span class="sourceLineNo">208</span> public JsonWriter q() throws IOException {<a name="line.208"></a> -<span class="sourceLineNo">209</span> super.q();<a name="line.209"></a> -<span class="sourceLineNo">210</span> return this;<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> @Override /* SerializerWriter */<a name="line.213"></a> -<span class="sourceLineNo">214</span> public JsonWriter i(int indent) throws IOException {<a name="line.214"></a> -<span class="sourceLineNo">215</span> super.i(indent);<a name="line.215"></a> -<span class="sourceLineNo">216</span> return this;<a name="line.216"></a> -<span class="sourceLineNo">217</span> }<a name="line.217"></a> -<span class="sourceLineNo">218</span><a name="line.218"></a> -<span class="sourceLineNo">219</span> @Override /* SerializerWriter */<a name="line.219"></a> -<span class="sourceLineNo">220</span> public JsonWriter nl() throws IOException {<a name="line.220"></a> -<span class="sourceLineNo">221</span> super.nl();<a name="line.221"></a> -<span class="sourceLineNo">222</span> return this;<a name="line.222"></a> -<span class="sourceLineNo">223</span> }<a name="line.223"></a> -<span class="sourceLineNo">224</span><a name="line.224"></a> -<span class="sourceLineNo">225</span> @Override /* SerializerWriter */<a name="line.225"></a> -<span class="sourceLineNo">226</span> public JsonWriter append(Object text) throws IOException {<a name="line.226"></a> -<span class="sourceLineNo">227</span> super.append(text);<a name="line.227"></a> -<span class="sourceLineNo">228</span> return this;<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> @Override /* SerializerWriter */<a name="line.231"></a> -<span class="sourceLineNo">232</span> public JsonWriter append(String text) throws IOException {<a name="line.232"></a> -<span class="sourceLineNo">233</span> super.append(text);<a name="line.233"></a> -<span class="sourceLineNo">234</span> return this;<a name="line.234"></a> -<span class="sourceLineNo">235</span> }<a name="line.235"></a> -<span class="sourceLineNo">236</span><a name="line.236"></a> -<span class="sourceLineNo">237</span> @Override /* SerializerWriter */<a name="line.237"></a> -<span class="sourceLineNo">238</span> public JsonWriter appendIf(boolean b, String text) throws IOException {<a name="line.238"></a> -<span class="sourceLineNo">239</span> super.appendIf(b, text);<a name="line.239"></a> -<span class="sourceLineNo">240</span> return this;<a name="line.240"></a> -<span class="sourceLineNo">241</span> }<a name="line.241"></a> -<span class="sourceLineNo">242</span><a name="line.242"></a> -<span class="sourceLineNo">243</span> @Override /* SerializerWriter */<a name="line.243"></a> -<span class="sourceLineNo">244</span> public JsonWriter appendIf(boolean b, char c) throws IOException {<a name="line.244"></a> -<span class="sourceLineNo">245</span> super.appendIf(b, c);<a name="line.245"></a> -<span class="sourceLineNo">246</span> return this;<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> @Override /* SerializerWriter */<a name="line.249"></a> -<span class="sourceLineNo">250</span> public JsonWriter append(char c) throws IOException {<a name="line.250"></a> -<span class="sourceLineNo">251</span> super.append(c);<a name="line.251"></a> -<span class="sourceLineNo">252</span> return this;<a name="line.252"></a> -<span class="sourceLineNo">253</span> }<a name="line.253"></a> -<span class="sourceLineNo">254</span>}<a name="line.254"></a> +<span class="sourceLineNo">166</span> return this;<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><a name="line.169"></a> +<span class="sourceLineNo">170</span> //--------------------------------------------------------------------------------<a name="line.170"></a> +<span class="sourceLineNo">171</span> // Overridden methods<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> @Override /* SerializerWriter */<a name="line.174"></a> +<span class="sourceLineNo">175</span> public JsonWriter cr(int depth) throws IOException {<a name="line.175"></a> +<span class="sourceLineNo">176</span> super.cr(depth);<a name="line.176"></a> +<span class="sourceLineNo">177</span> return this;<a name="line.177"></a> +<span class="sourceLineNo">178</span> }<a name="line.178"></a> +<span class="sourceLineNo">179</span><a name="line.179"></a> +<span class="sourceLineNo">180</span> @Override /* SerializerWriter */<a name="line.180"></a> +<span class="sourceLineNo">181</span> public JsonWriter appendln(int indent, String text) throws IOException {<a name="line.181"></a> +<span class="sourceLineNo">182</span> super.appendln(indent, text);<a name="line.182"></a> +<span class="sourceLineNo">183</span> return this;<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> @Override /* SerializerWriter */<a name="line.186"></a> +<span class="sourceLineNo">187</span> public JsonWriter appendln(String text) throws IOException {<a name="line.187"></a> +<span class="sourceLineNo">188</span> super.appendln(text);<a name="line.188"></a> +<span class="sourceLineNo">189</span> return this;<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 /* SerializerWriter */<a name="line.192"></a> +<span class="sourceLineNo">193</span> public JsonWriter append(int indent, String text) throws IOException {<a name="line.193"></a> +<span class="sourceLineNo">194</span> super.append(indent, text);<a name="line.194"></a> +<span class="sourceLineNo">195</span> return this;<a name="line.195"></a> +<span class="sourceLineNo">196</span> }<a name="line.196"></a> +<span class="sourceLineNo">197</span><a name="line.197"></a> +<span class="sourceLineNo">198</span> @Override /* SerializerWriter */<a name="line.198"></a> +<span class="sourceLineNo">199</span> public JsonWriter append(int indent, char c) throws IOException {<a name="line.199"></a> +<span class="sourceLineNo">200</span> super.append(indent, c);<a name="line.200"></a> +<span class="sourceLineNo">201</span> return this;<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> @Override /* SerializerWriter */<a name="line.204"></a> +<span class="sourceLineNo">205</span> public JsonWriter s() throws IOException {<a name="line.205"></a> +<span class="sourceLineNo">206</span> super.s();<a name="line.206"></a> +<span class="sourceLineNo">207</span> return this;<a name="line.207"></a> +<span class="sourceLineNo">208</span> }<a name="line.208"></a> +<span class="sourceLineNo">209</span><a name="line.209"></a> +<span class="sourceLineNo">210</span> @Override /* SerializerWriter */<a name="line.210"></a> +<span class="sourceLineNo">211</span> public JsonWriter q() throws IOException {<a name="line.211"></a> +<span class="sourceLineNo">212</span> super.q();<a name="line.212"></a> +<span class="sourceLineNo">213</span> return this;<a name="line.213"></a> +<span class="sourceLineNo">214</span> }<a name="line.214"></a> +<span class="sourceLineNo">215</span><a name="line.215"></a> +<span class="sourceLineNo">216</span> @Override /* SerializerWriter */<a name="line.216"></a> +<span class="sourceLineNo">217</span> public JsonWriter i(int indent) throws IOException {<a name="line.217"></a> +<span class="sourceLineNo">218</span> super.i(indent);<a name="line.218"></a> +<span class="sourceLineNo">219</span> return this;<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> @Override /* SerializerWriter */<a name="line.222"></a> +<span class="sourceLineNo">223</span> public JsonWriter nl() throws IOException {<a name="line.223"></a> +<span class="sourceLineNo">224</span> super.nl();<a name="line.224"></a> +<span class="sourceLineNo">225</span> return this;<a name="line.225"></a> +<span class="sourceLineNo">226</span> }<a name="line.226"></a> +<span class="sourceLineNo">227</span><a name="line.227"></a> +<span class="sourceLineNo">228</span> @Override /* SerializerWriter */<a name="line.228"></a> +<span class="sourceLineNo">229</span> public JsonWriter append(Object text) throws IOException {<a name="line.229"></a> +<span class="sourceLineNo">230</span> super.append(text);<a name="line.230"></a> +<span class="sourceLineNo">231</span> return this;<a name="line.231"></a> +<span class="sourceLineNo">232</span> }<a name="line.232"></a> +<span class="sourceLineNo">233</span><a name="line.233"></a> +<span class="sourceLineNo">234</span> @Override /* SerializerWriter */<a name="line.234"></a> +<span class="sourceLineNo">235</span> public JsonWriter append(String text) throws IOException {<a name="line.235"></a> +<span class="sourceLineNo">236</span> super.append(text);<a name="line.236"></a> +<span class="sourceLineNo">237</span> return this;<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> @Override /* SerializerWriter */<a name="line.240"></a> +<span class="sourceLineNo">241</span> public JsonWriter appendIf(boolean b, String text) throws IOException {<a name="line.241"></a> +<span class="sourceLineNo">242</span> super.appendIf(b, text);<a name="line.242"></a> +<span class="sourceLineNo">243</span> return this;<a name="line.243"></a> +<span class="sourceLineNo">244</span> }<a name="line.244"></a> +<span class="sourceLineNo">245</span><a name="line.245"></a> +<span class="sourceLineNo">246</span> @Override /* SerializerWriter */<a name="line.246"></a> +<span class="sourceLineNo">247</span> public JsonWriter appendIf(boolean b, char c) throws IOException {<a name="line.247"></a> +<span class="sourceLineNo">248</span> super.appendIf(b, c);<a name="line.248"></a> +<span class="sourceLineNo">249</span> return this;<a name="line.249"></a> +<span class="sourceLineNo">250</span> }<a name="line.250"></a> +<span class="sourceLineNo">251</span><a name="line.251"></a> +<span class="sourceLineNo">252</span> @Override /* SerializerWriter */<a name="line.252"></a> +<span class="sourceLineNo">253</span> public JsonWriter append(char c) throws IOException {<a name="line.253"></a> +<span class="sourceLineNo">254</span> super.append(c);<a name="line.254"></a> +<span class="sourceLineNo">255</span> return this;<a name="line.255"></a> +<span class="sourceLineNo">256</span> }<a name="line.256"></a> +<span class="sourceLineNo">257</span>}<a name="line.257"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializer.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializer.html b/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializer.html index 01dfca8..9ee8a94 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializer.html +++ b/content/site/apidocs/src-html/org/apache/juneau/msgpack/MsgPackSerializer.html @@ -219,8 +219,8 @@ <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> @Override /* Serializer */<a name="line.213"></a> -<span class="sourceLineNo">214</span> public MsgPackSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.214"></a> -<span class="sourceLineNo">215</span> return new MsgPackSerializerSession(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.215"></a> +<span class="sourceLineNo">214</span> public MsgPackSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {<a name="line.214"></a> +<span class="sourceLineNo">215</span> return new MsgPackSerializerSession(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);<a name="line.215"></a> <span class="sourceLineNo">216</span> }<a name="line.216"></a> <span class="sourceLineNo">217</span><a name="line.217"></a> <span class="sourceLineNo">218</span> @Override /* Serializer */<a name="line.218"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/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 ba7673a..490ef74 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 @@ -44,44 +44,46 @@ <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">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">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 serializer, 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">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">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> +<span class="sourceLineNo">049</span> * @param uriContext The URI context.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.<a name="line.50"></a> +<span class="sourceLineNo">051</span> */<a name="line.51"></a> +<span class="sourceLineNo">052</span> protected MsgPackSerializerSession(MsgPackSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {<a name="line.52"></a> +<span class="sourceLineNo">053</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);<a name="line.53"></a> +<span class="sourceLineNo">054</span> if (op == null || op.isEmpty()) {<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> addBeanTypeProperties = op.getBoolean(MSGPACK_addBeanTypeProperties, ctx.addBeanTypeProperties);<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><a name="line.60"></a> +<span class="sourceLineNo">061</span> /**<a name="line.61"></a> +<span class="sourceLineNo">062</span> * Returns 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> * @return The {@link MsgPackSerializerContext#MSGPACK_addBeanTypeProperties} 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> @Override /* SerializerSession */<a name="line.66"></a> +<span class="sourceLineNo">067</span> public final boolean isAddBeanTypeProperties() {<a name="line.67"></a> +<span class="sourceLineNo">068</span> return addBeanTypeProperties;<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> @Override /*SerializerSession */<a name="line.71"></a> +<span class="sourceLineNo">072</span> public MsgPackOutputStream getOutputStream() throws Exception {<a name="line.72"></a> +<span class="sourceLineNo">073</span> Object output = getOutput();<a name="line.73"></a> +<span class="sourceLineNo">074</span> if (output instanceof MsgPackOutputStream)<a name="line.74"></a> +<span class="sourceLineNo">075</span> return (MsgPackOutputStream)output;<a name="line.75"></a> +<span class="sourceLineNo">076</span> return new MsgPackOutputStream(super.getOutputStream());<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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormData.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormData.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormData.html index 2bc46be..e047810 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormData.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormData.html @@ -52,20 +52,29 @@ <span class="sourceLineNo">044</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.44"></a> <span class="sourceLineNo">045</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.45"></a> <span class="sourceLineNo">046</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * </ul><a name="line.47"></a> -<span class="sourceLineNo">048</span> */<a name="line.48"></a> -<span class="sourceLineNo">049</span>@Documented<a name="line.49"></a> -<span class="sourceLineNo">050</span>@Target(PARAMETER)<a name="line.50"></a> -<span class="sourceLineNo">051</span>@Retention(RUNTIME)<a name="line.51"></a> -<span class="sourceLineNo">052</span>@Inherited<a name="line.52"></a> -<span class="sourceLineNo">053</span>public @interface FormData {<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> * The form post parameter name.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * Can be blank if the value is an instance of <code>NameValuePairs</code> or <code>Map&lt;String,Object&gt;</code>.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> String value() default "";<a name="line.59"></a> -<span class="sourceLineNo">060</span>}<a name="line.60"></a> +<span class="sourceLineNo">047</span> * <li>A bean - Individual name-value pairs.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.48"></a> +<span class="sourceLineNo">049</span> * </ul><a name="line.49"></a> +<span class="sourceLineNo">050</span> */<a name="line.50"></a> +<span class="sourceLineNo">051</span>@Documented<a name="line.51"></a> +<span class="sourceLineNo">052</span>@Target(PARAMETER)<a name="line.52"></a> +<span class="sourceLineNo">053</span>@Retention(RUNTIME)<a name="line.53"></a> +<span class="sourceLineNo">054</span>@Inherited<a name="line.54"></a> +<span class="sourceLineNo">055</span>public @interface FormData {<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> * The form post parameter name.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * <p><a name="line.59"></a> +<span class="sourceLineNo">060</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.60"></a> +<span class="sourceLineNo">061</span> * for the following data types:<a name="line.61"></a> +<span class="sourceLineNo">062</span> * <ul><a name="line.62"></a> +<span class="sourceLineNo">063</span> * <li><code>NameValuePairs</code><a name="line.63"></a> +<span class="sourceLineNo">064</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.64"></a> +<span class="sourceLineNo">065</span> * <li>A bean<a name="line.65"></a> +<span class="sourceLineNo">066</span> * </ul><a name="line.66"></a> +<span class="sourceLineNo">067</span> */<a name="line.67"></a> +<span class="sourceLineNo">068</span> String value() default "*";<a name="line.68"></a> +<span class="sourceLineNo">069</span>}<a name="line.69"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormDataIfNE.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormDataIfNE.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormDataIfNE.html index 29671d1..ef34674 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormDataIfNE.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormDataIfNE.html @@ -36,10 +36,17 @@ <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> * The form post parameter name.<a name="line.30"></a> -<span class="sourceLineNo">031</span> * Can be blank if the value is an instance of <code>NameValuePairs</code> or <code>Map&lt;String,Object&gt;</code>.<a name="line.31"></a> -<span class="sourceLineNo">032</span> */<a name="line.32"></a> -<span class="sourceLineNo">033</span> String value() default "";<a name="line.33"></a> -<span class="sourceLineNo">034</span>}<a name="line.34"></a> +<span class="sourceLineNo">031</span> * <p><a name="line.31"></a> +<span class="sourceLineNo">032</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.32"></a> +<span class="sourceLineNo">033</span> * for the following data types:<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <ul><a name="line.34"></a> +<span class="sourceLineNo">035</span> * <li><code>NameValuePairs</code><a name="line.35"></a> +<span class="sourceLineNo">036</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.36"></a> +<span class="sourceLineNo">037</span> * <li>A bean<a name="line.37"></a> +<span class="sourceLineNo">038</span> * </ul><a name="line.38"></a> +<span class="sourceLineNo">039</span> */<a name="line.39"></a> +<span class="sourceLineNo">040</span> String value() default "*";<a name="line.40"></a> +<span class="sourceLineNo">041</span>}<a name="line.41"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/src-html/org/apache/juneau/remoteable/Header.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/Header.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Header.html index bbdb72b..1ce0782 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/Header.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Header.html @@ -45,23 +45,33 @@ <span class="sourceLineNo">037</span> * <p><a name="line.37"></a> <span class="sourceLineNo">038</span> * The argument can be any of the following types:<a name="line.38"></a> <span class="sourceLineNo">039</span> * <ul class='spaced-list'><a name="line.39"></a> -<span class="sourceLineNo">040</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.40"></a> -<span class="sourceLineNo">041</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.41"></a> -<span class="sourceLineNo">042</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.42"></a> -<span class="sourceLineNo">043</span> * </ul><a name="line.43"></a> -<span class="sourceLineNo">044</span> */<a name="line.44"></a> -<span class="sourceLineNo">045</span>@Documented<a name="line.45"></a> -<span class="sourceLineNo">046</span>@Target(PARAMETER)<a name="line.46"></a> -<span class="sourceLineNo">047</span>@Retention(RUNTIME)<a name="line.47"></a> -<span class="sourceLineNo">048</span>@Inherited<a name="line.48"></a> -<span class="sourceLineNo">049</span>public @interface Header {<a name="line.49"></a> -<span class="sourceLineNo">050</span><a name="line.50"></a> -<span class="sourceLineNo">051</span> /**<a name="line.51"></a> -<span class="sourceLineNo">052</span> * The HTTP header name.<a name="line.52"></a> -<span class="sourceLineNo">053</span> * Can be blank if the value is an instance of <code>Map&lt;String,Object&gt;</code>.<a name="line.53"></a> -<span class="sourceLineNo">054</span> */<a name="line.54"></a> -<span class="sourceLineNo">055</span> String value() default "";<a name="line.55"></a> -<span class="sourceLineNo">056</span>}<a name="line.56"></a> +<span class="sourceLineNo">040</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <li>A bean - Individual name-value pairs.<a name="line.44"></a> +<span class="sourceLineNo">045</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * </ul><a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span>@Documented<a name="line.48"></a> +<span class="sourceLineNo">049</span>@Target(PARAMETER)<a name="line.49"></a> +<span class="sourceLineNo">050</span>@Retention(RUNTIME)<a name="line.50"></a> +<span class="sourceLineNo">051</span>@Inherited<a name="line.51"></a> +<span class="sourceLineNo">052</span>public @interface Header {<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> * The HTTP header name.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> +<span class="sourceLineNo">057</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.57"></a> +<span class="sourceLineNo">058</span> * for the following data types:<a name="line.58"></a> +<span class="sourceLineNo">059</span> * <ul><a name="line.59"></a> +<span class="sourceLineNo">060</span> * <li><code>NameValuePairs</code><a name="line.60"></a> +<span class="sourceLineNo">061</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.61"></a> +<span class="sourceLineNo">062</span> * <li>A bean<a name="line.62"></a> +<span class="sourceLineNo">063</span> * </ul><a name="line.63"></a> +<span class="sourceLineNo">064</span> */<a name="line.64"></a> +<span class="sourceLineNo">065</span> String value() default "*";<a name="line.65"></a> +<span class="sourceLineNo">066</span>}<a name="line.66"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/src-html/org/apache/juneau/remoteable/HeaderIfNE.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/HeaderIfNE.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/HeaderIfNE.html index b0b89d6..570655c 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/HeaderIfNE.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/HeaderIfNE.html @@ -36,10 +36,17 @@ <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> * The HTTP header name.<a name="line.30"></a> -<span class="sourceLineNo">031</span> * Can be blank if the value is an instance of <code>Map&lt;String,Object&gt;</code>.<a name="line.31"></a> -<span class="sourceLineNo">032</span> */<a name="line.32"></a> -<span class="sourceLineNo">033</span> String value();<a name="line.33"></a> -<span class="sourceLineNo">034</span>}<a name="line.34"></a> +<span class="sourceLineNo">031</span> * <p><a name="line.31"></a> +<span class="sourceLineNo">032</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.32"></a> +<span class="sourceLineNo">033</span> * for the following data types:<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <ul><a name="line.34"></a> +<span class="sourceLineNo">035</span> * <li><code>NameValuePairs</code><a name="line.35"></a> +<span class="sourceLineNo">036</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.36"></a> +<span class="sourceLineNo">037</span> * <li>A bean<a name="line.37"></a> +<span class="sourceLineNo">038</span> * </ul><a name="line.38"></a> +<span class="sourceLineNo">039</span> */<a name="line.39"></a> +<span class="sourceLineNo">040</span> String value() default "*";<a name="line.40"></a> +<span class="sourceLineNo">041</span>}<a name="line.41"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/src-html/org/apache/juneau/remoteable/Path.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/Path.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Path.html new file mode 100644 index 0000000..8915564 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Path.html @@ -0,0 +1,135 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> +<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> +<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> +<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> +<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> +<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> +<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> +<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> +<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> +<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> +<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> +<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> +<span class="sourceLineNo">013</span>package org.apache.juneau.remoteable;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import static java.lang.annotation.ElementType.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import static java.lang.annotation.RetentionPolicy.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.urlencoding.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>/**<a name="line.22"></a> +<span class="sourceLineNo">023</span> * Annotation applied to Java method arguments of interface proxies to denote that they are path variables on the request.<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * <h5 class='section'>Example:</h5><a name="line.25"></a> +<span class="sourceLineNo">026</span> * <p class='bcode'><a name="line.26"></a> +<span class="sourceLineNo">027</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <jk>public interface</jk> MyProxy {<a name="line.28"></a> +<span class="sourceLineNo">029</span> *<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod1/{foo}"</js>)<a name="line.30"></a> +<span class="sourceLineNo">031</span> * String myProxyMethod1(<ja>@Path</ja>(<js>"foo"</js>)</ja> String foo);<a name="line.31"></a> +<span class="sourceLineNo">032</span> * }<a name="line.32"></a> +<span class="sourceLineNo">033</span> * </p><a name="line.33"></a> +<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> +<span class="sourceLineNo">035</span> * The argument can be any of the following types:<a name="line.35"></a> +<span class="sourceLineNo">036</span> * <ul class='spaced-list'><a name="line.36"></a> +<span class="sourceLineNo">037</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.38"></a> +<span class="sourceLineNo">039</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <li>A bean - Individual name-value pairs.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * </ul><a name="line.43"></a> +<span class="sourceLineNo">044</span>*/<a name="line.44"></a> +<span class="sourceLineNo">045</span>@Documented<a name="line.45"></a> +<span class="sourceLineNo">046</span>@Target(PARAMETER)<a name="line.46"></a> +<span class="sourceLineNo">047</span>@Retention(RUNTIME)<a name="line.47"></a> +<span class="sourceLineNo">048</span>@Inherited<a name="line.48"></a> +<span class="sourceLineNo">049</span>public @interface Path {<a name="line.49"></a> +<span class="sourceLineNo">050</span><a name="line.50"></a> +<span class="sourceLineNo">051</span> /**<a name="line.51"></a> +<span class="sourceLineNo">052</span> * The path parameter name.<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> +<span class="sourceLineNo">054</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.54"></a> +<span class="sourceLineNo">055</span> * for the following data types:<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <ul><a name="line.56"></a> +<span class="sourceLineNo">057</span> * <li><code>NameValuePairs</code><a name="line.57"></a> +<span class="sourceLineNo">058</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.58"></a> +<span class="sourceLineNo">059</span> * <li>A bean<a name="line.59"></a> +<span class="sourceLineNo">060</span> * </ul><a name="line.60"></a> +<span class="sourceLineNo">061</span> */<a name="line.61"></a> +<span class="sourceLineNo">062</span> String value() default "*";<a name="line.62"></a> +<span class="sourceLineNo">063</span>}<a name="line.63"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/src-html/org/apache/juneau/remoteable/Query.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/Query.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Query.html index 703a681..e3bcb51 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/Query.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Query.html @@ -48,24 +48,35 @@ <span class="sourceLineNo">040</span> * <p><a name="line.40"></a> <span class="sourceLineNo">041</span> * The argument can be any of the following types:<a name="line.41"></a> <span class="sourceLineNo">042</span> * <ul class='spaced-list'><a name="line.42"></a> -<span class="sourceLineNo">043</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.43"></a> -<span class="sourceLineNo">044</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.45"></a> -<span class="sourceLineNo">046</span> * <li>{@link String} - Treated as a query string.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * </ul><a name="line.47"></a> -<span class="sourceLineNo">048</span>*/<a name="line.48"></a> -<span class="sourceLineNo">049</span>@Documented<a name="line.49"></a> -<span class="sourceLineNo">050</span>@Target(PARAMETER)<a name="line.50"></a> -<span class="sourceLineNo">051</span>@Retention(RUNTIME)<a name="line.51"></a> -<span class="sourceLineNo">052</span>@Inherited<a name="line.52"></a> -<span class="sourceLineNo">053</span>public @interface Query {<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> * The query parameter name.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * Can be blank if the value is an instance of <code>Map&lt;String,Object&gt;</code> or <code>String</code>.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> String value() default "";<a name="line.59"></a> -<span class="sourceLineNo">060</span>}<a name="line.60"></a> +<span class="sourceLineNo">043</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <li>A bean - Individual name-value pairs.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.48"></a> +<span class="sourceLineNo">049</span> * <li>{@link String} - Treated as a query string.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * </ul><a name="line.50"></a> +<span class="sourceLineNo">051</span>*/<a name="line.51"></a> +<span class="sourceLineNo">052</span>@Documented<a name="line.52"></a> +<span class="sourceLineNo">053</span>@Target(PARAMETER)<a name="line.53"></a> +<span class="sourceLineNo">054</span>@Retention(RUNTIME)<a name="line.54"></a> +<span class="sourceLineNo">055</span>@Inherited<a name="line.55"></a> +<span class="sourceLineNo">056</span>public @interface Query {<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> * The query parameter name.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <p><a name="line.60"></a> +<span class="sourceLineNo">061</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.61"></a> +<span class="sourceLineNo">062</span> * for the following data types:<a name="line.62"></a> +<span class="sourceLineNo">063</span> * <ul><a name="line.63"></a> +<span class="sourceLineNo">064</span> * <li><code>String</code> - A complete query string.<a name="line.64"></a> +<span class="sourceLineNo">065</span> * <li><code>NameValuePairs</code><a name="line.65"></a> +<span class="sourceLineNo">066</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.66"></a> +<span class="sourceLineNo">067</span> * <li>A bean<a name="line.67"></a> +<span class="sourceLineNo">068</span> * </ul><a name="line.68"></a> +<span class="sourceLineNo">069</span> */<a name="line.69"></a> +<span class="sourceLineNo">070</span> String value() default "*";<a name="line.70"></a> +<span class="sourceLineNo">071</span>}<a name="line.71"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/src-html/org/apache/juneau/remoteable/QueryIfNE.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/QueryIfNE.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/QueryIfNE.html index 46941c5..e4a2556 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/QueryIfNE.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/QueryIfNE.html @@ -36,10 +36,18 @@ <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> * The query parameter name.<a name="line.30"></a> -<span class="sourceLineNo">031</span> * Can be blank if the value is an instance of <code>Map&lt;String,Object&gt;</code> or <code>String</code>.<a name="line.31"></a> -<span class="sourceLineNo">032</span> */<a name="line.32"></a> -<span class="sourceLineNo">033</span> String value();<a name="line.33"></a> -<span class="sourceLineNo">034</span>}<a name="line.34"></a> +<span class="sourceLineNo">031</span> * <p><a name="line.31"></a> +<span class="sourceLineNo">032</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.32"></a> +<span class="sourceLineNo">033</span> * for the following data types:<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <ul><a name="line.34"></a> +<span class="sourceLineNo">035</span> * <li><code>String</code> - A complete query string.<a name="line.35"></a> +<span class="sourceLineNo">036</span> * <li><code>NameValuePairs</code><a name="line.36"></a> +<span class="sourceLineNo">037</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.37"></a> +<span class="sourceLineNo">038</span> * <li>A bean<a name="line.38"></a> +<span class="sourceLineNo">039</span> * </ul><a name="line.39"></a> +<span class="sourceLineNo">040</span> */<a name="line.40"></a> +<span class="sourceLineNo">041</span> String value() default "*";<a name="line.41"></a> +<span class="sourceLineNo">042</span>}<a name="line.42"></a>
