http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/parser/package.html ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/package.html b/juneau-core/src/main/java/org/apache/juneau/parser/package.html index f60953c..142ac00 100644 --- a/juneau-core/src/main/java/org/apache/juneau/parser/package.html +++ b/juneau-core/src/main/java/org/apache/juneau/parser/package.html @@ -71,8 +71,7 @@ <div class='topic'> <p> The parser API is designed to be easily extensible by developers. - <br> - If you are writing your own parser, you will typically subclass directly from either + <br>If you are writing your own parser, you will typically subclass directly from either {@link org.apache.juneau.parser.ReaderParser} or {@link org.apache.juneau.parser.InputStreamParser}. </p> @@ -89,10 +88,14 @@ <p> The <code>ParserGroup</code> class provides the following features: <ul class='spaced-list'> - <li>Finds parsers based on HTTP <code>Content-Type</code> header values. - <li>Sets common properties on all parsers in a single method call. - <li>Locks all parsers in a single method call. - <li>Clones existing groups and all parsers within the group in a single method call. + <li> + Finds parsers based on HTTP <code>Content-Type</code> header values. + <li> + Sets common properties on all parsers in a single method call. + <li> + Locks all parsers in a single method call. + <li> + Clones existing groups and all parsers within the group in a single method call. </ul> <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/Body.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/Body.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/Body.java index c896bf4..5dd7b25 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/Body.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/Body.java @@ -23,7 +23,7 @@ import org.apache.juneau.serializer.*; /** * Annotation applied to Java method arguments of interface proxies to denote that they are the HTTP body of the * request. - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>) @@ -36,17 +36,22 @@ import org.apache.juneau.serializer.*; * <p> * The argument can be any of the following types: * <ul class='spaced-list'> - * <li>Any serializable POJO - Converted to text using the {@link Serializer} registered with the + * <li> + * Any serializable POJO - Converted to text using the {@link Serializer} registered with the * <code>RestClient</code>. - * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource. - * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource. - * <li><code>HttpEntity</code> - Bypass Juneau serialization and pass HttpEntity directly to HttpClient. - * <li><code>NameValuePairs</code> - Converted to a URL-encoded FORM post. + * <li> + * {@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource. + * <li> + * {@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource. + * <li> + * <code>HttpEntity</code> - Bypass Juneau serialization and pass HttpEntity directly to HttpClient. + * <li> + * <code>NameValuePairs</code> - Converted to a URL-encoded FORM post. * </ul> * <p> * The annotation can also be applied to a bean property field or getter when the argument is annotated with * {@link RequestBean @RequestBean}: - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>) @@ -64,9 +69,10 @@ import org.apache.juneau.serializer.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ @Documented http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/FormData.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/FormData.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/FormData.java index 1468d12..7f7f6e3 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/FormData.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/FormData.java @@ -23,7 +23,7 @@ import org.apache.juneau.urlencoding.*; /** * Annotation applied to Java method arguments of interface proxies to denote that they are FORM post parameters on the * request. - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>) @@ -65,7 +65,7 @@ import org.apache.juneau.urlencoding.*; * <p> * The annotation can also be applied to a bean property field or getter when the argument is annotated with * {@link RequestBean @RequestBean}: - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>) @@ -127,9 +127,10 @@ import org.apache.juneau.urlencoding.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ @Documented @@ -148,8 +149,10 @@ public @interface FormData { * <p> * A blank value (the default) has the following behavior: * <ul class='spaced-list'> - * <li>If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean, + * <li> + * If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean, * then it's the equivalent to <js>"*"</js> which will cause the value to be serialized as name/value pairs. + * * <h6 class='figure'>Example:</h6> * <p class='bcode'> * <jc>// When used on a remote method parameter</jc> @@ -169,8 +172,10 @@ public @interface FormData { * Map<String,Object> getFoo(); * } * </p> - * <br> - * <li>If used on a request bean method, uses the bean property name. + * </li> + * <li> + * If used on a request bean method, uses the bean property name. + * * <h6 class='figure'>Example:</h6> * <p class='bcode'> * <jk>public interface</jk> MyRequestBean { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java index 1beafaa..36849d2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java @@ -25,9 +25,10 @@ import org.apache.juneau.urlencoding.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ @Documented http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/Header.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/Header.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/Header.java index 5d2ebee..e7c4f18 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/Header.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/Header.java @@ -23,7 +23,7 @@ import org.apache.juneau.urlencoding.*; /** * Annotation applied to Java method arguments of interface proxies to denote that they are serialized as an HTTP * header value. - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>) @@ -54,7 +54,7 @@ import org.apache.juneau.urlencoding.*; * <p> * The annotation can also be applied to a bean property field or getter when the argument is annotated with * {@link RequestBean @RequestBean}: - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>) @@ -100,8 +100,7 @@ import org.apache.juneau.urlencoding.*; * <p> * The {@link #name()} and {@link #value()} elements are synonyms for specifying the header name. * Only one should be used. - * <br> - * The following annotations are fully equivalent: + * <br>The following annotations are fully equivalent: * <p> * <p class='bcode'> * <ja>@Header</ja>(name=<js>"Foo"</js>) @@ -111,9 +110,10 @@ import org.apache.juneau.urlencoding.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ @Documented @@ -132,8 +132,10 @@ public @interface Header { * <p> * A blank value (the default) has the following behavior: * <ul class='spaced-list'> - * <li>If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean, + * <li> + * If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean, * then it's the equivalent to <js>"*"</js> which will cause the value to be serialized as name/value pairs. + * * <h6 class='figure'>Example:</h6> * <p class='bcode'> * <jc>// When used on a remote method parameter</jc> @@ -153,8 +155,10 @@ public @interface Header { * Map<String,Object> getFoo(); * } * </p> - * <br> - * <li>If used on a request bean method, uses the bean property name. + * </li> + * <li> + * If used on a request bean method, uses the bean property name. + * * <h6 class='figure'>Example:</h6> * <p class='bcode'> * <jk>public interface</jk> MyRequestBean { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java index 071c076..b039ff0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java @@ -25,9 +25,10 @@ import org.apache.juneau.urlencoding.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ @Documented http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/Path.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/Path.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/Path.java index 8144c0b..bb8c08c 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/Path.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/Path.java @@ -22,7 +22,7 @@ import org.apache.juneau.urlencoding.*; /** * Annotation applied to Java method arguments of interface proxies to denote that they are path variables on the request. - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>) @@ -52,7 +52,7 @@ import org.apache.juneau.urlencoding.*; * <p> * The annotation can also be applied to a bean property field or getter when the argument is annotated with * {@link RequestBean @RequestBean}: - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>) @@ -98,8 +98,7 @@ import org.apache.juneau.urlencoding.*; * <p> * The {@link #name()} and {@link #value()} elements are synonyms for specifying the path variable name. * Only one should be used. - * <br> - * The following annotations are fully equivalent: + * <br>The following annotations are fully equivalent: * <p> * <p class='bcode'> * <ja>@Path</ja>(name=<js>"foo"</js>) @@ -109,9 +108,10 @@ import org.apache.juneau.urlencoding.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ @Documented @@ -130,8 +130,10 @@ public @interface Path { * <p> * A blank value (the default) has the following behavior: * <ul class='spaced-list'> - * <li>If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean, + * <li> + * If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean, * then it's the equivalent to <js>"*"</js> which will cause the value to be treated as name/value pairs. + * * <h6 class='figure'>Example:</h6> * <p class='bcode'> * <jc>// When used on a remote method parameter</jc> @@ -151,8 +153,10 @@ public @interface Path { * Map<String,Object> getPathVars(); * } * </p> - * <br> - * <li>If used on a request bean method, uses the bean property name. + * </li> + * <li> + * If used on a request bean method, uses the bean property name. + * * <h6 class='figure'>Example:</h6> * <p class='bcode'> * <jk>public interface</jk> MyRequestBean { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/Query.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/Query.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/Query.java index 97dbfbb..a43f4e5 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/Query.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/Query.java @@ -23,7 +23,7 @@ import org.apache.juneau.urlencoding.*; /** * Annotation applied to Java method arguments of interface proxies to denote that they are QUERY parameters on the * request. - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>) @@ -64,7 +64,7 @@ import org.apache.juneau.urlencoding.*; * <p> * The annotation can also be applied to a bean property field or getter when the argument is annotated with * {@link RequestBean @RequestBean}: - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>) @@ -115,9 +115,7 @@ import org.apache.juneau.urlencoding.*; * <p> * The {@link #name()} and {@link #value()} elements are synonyms for specifying the parameter name. * Only one should be used. - * <br> - * The following annotations are fully equivalent: - * <p> + * <br>The following annotations are fully equivalent: * <p class='bcode'> * <ja>@Query</ja>(name=<js>"foo"</js>) * @@ -126,9 +124,10 @@ import org.apache.juneau.urlencoding.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ @Documented @@ -147,8 +146,10 @@ public @interface Query { * <p> * A blank value (the default) has the following behavior: * <ul class='spaced-list'> - * <li>If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean, + * <li> + * If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean, * then it's the equivalent to <js>"*"</js> which will cause the value to be serialized as name/value pairs. + * * <h6 class='figure'>Example:</h6> * <p class='bcode'> * <jc>// When used on a remote method parameter</jc> @@ -168,8 +169,10 @@ public @interface Query { * Map<String,Object> getFoo(); * } * </p> - * <br> - * <li>If used on a request bean method, uses the bean property name. + * </li> + * <li> + * If used on a request bean method, uses the bean property name. + * * <h6 class='figure'>Example:</h6> * <p class='bcode'> * <jk>public interface</jk> MyRequestBean { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java index cec1aea..be70654 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java @@ -25,9 +25,10 @@ import org.apache.juneau.urlencoding.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ @Documented http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java index 911f4f7..fd9f8e2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java @@ -35,9 +35,10 @@ import java.lang.annotation.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ @Documented @@ -74,7 +75,8 @@ public @interface RemoteMethod { * <p> * Possible values: * <ul> - * <li>{@link ReturnValue#BODY} (default) - The body of the HTTP response converted to a POJO. + * <li> + * {@link ReturnValue#BODY} (default) - The body of the HTTP response converted to a POJO. * <br>The return type on the Java method can be any of the following: * <ul> * <li><jk>void</jk> - Don't parse any response. Note that the method will still throw an exception if an @@ -86,7 +88,8 @@ public @interface RemoteMethod { * <li>{@link Reader} - Returns access to the raw reader of the response. * <li>{@link InputStream} - Returns access to the raw input stream of the response. * </ul> - * <li>{@link ReturnValue#HTTP_STATUS} - The HTTP status code on the response. + * <li> + * {@link ReturnValue#HTTP_STATUS} - The HTTP status code on the response. * <br>The return type on the Java method can be any of the following: * <ul> * <li><jk>int</jk>/<code>Integer</code> - The HTTP response code. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java index 00f58dd..394c6ba 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java @@ -22,9 +22,10 @@ import org.apache.juneau.urlencoding.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ public class RemoteMethodArg { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/Remoteable.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/Remoteable.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/Remoteable.java index 788a04e..73e8b8c 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/Remoteable.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/Remoteable.java @@ -19,13 +19,13 @@ import java.lang.annotation.*; /** * Identifies a remote proxy interface against a REST interface. - * <p> * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ @Documented http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java index 461cc1d..5931ff8 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java @@ -27,9 +27,10 @@ import java.util.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ public class RemoteableMeta { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java index 3c71cf9..0495438 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java @@ -26,9 +26,10 @@ import java.util.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ public class RemoteableMethodMeta { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/RequestBean.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/RequestBean.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/RequestBean.java index 5c46a90..605f8b1 100644 --- a/juneau-core/src/main/java/org/apache/juneau/remoteable/RequestBean.java +++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/RequestBean.java @@ -22,7 +22,7 @@ import org.apache.juneau.urlencoding.*; /** * Annotation applied to Java method arguments of interface proxies to denote a bean with remoteable annotations. - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>) @@ -83,9 +83,10 @@ import org.apache.juneau.urlencoding.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface - * proxies against 3rd-party REST interfaces</a> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> + * <li class='link'> + * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a> * </ul> */ @Documented http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java index 489a01c..a699b2b 100644 --- a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java @@ -64,7 +64,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * Abort serialization if specified depth is reached in the POJO tree. * If this depth is exceeded, an exception is thrown. * This prevents stack overflows from occurring when trying to serialize models with recursive references. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_maxDepth</jsf>, value)</code>. @@ -90,7 +90,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * <p> * The initial indentation level at the root. * Useful when constructing document fragments that need to be indented at a certain level. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_initialDepth</jsf>, value)</code>. @@ -124,7 +124,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * For example, if a model contains the links A->B->C->A, then the JSON generated will look like * the following when <jsf>SERIALIZER_ignoreRecursions</jsf> is <jk>true</jk>... * <code>{A:{B:{C:null}}}</code> - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_detectRecursions</jsf>, value)</code>. @@ -152,10 +152,9 @@ public class SerializerBuilder extends CoreObjectBuilder { * Used in conjunction with {@link SerializerContext#SERIALIZER_detectRecursions}. * Setting is ignored if <jsf>SERIALIZER_detectRecursions</jsf> is <jk>false</jk>. * <p> - * If <jk>true</jk>, when we encounter the same object when serializing a tree, - * we set the value to <jk>null</jk>. + * If <jk>true</jk>, when we encounter the same object when serializing a tree, we set the value to <jk>null</jk>. * Otherwise, an exception is thrown. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_ignoreRecursions</jsf>, value)</code>. @@ -181,7 +180,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * </ul> * <p> * If <jk>true</jk>, newlines and indentation and spaces are added to the output to improve readability. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_useWhitespace</jsf>, value)</code>. @@ -215,7 +214,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * </ul> * <p> * Specifies the maximum indentation level in the serialized document. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_maxIndent</jsf>, value)</code>. @@ -244,7 +243,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * This is used to recreate the correct objects during parsing if the object types cannot be inferred. * For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined from * the value type. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_addBeanTypeProperties</jsf>, value)</code>. @@ -270,7 +269,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * </ul> * <p> * This is the character used for quoting attributes and values. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_quoteChar</jsf>, value)</code>. @@ -304,7 +303,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * </ul> * <p> * If <jk>true</jk>, null bean values will not be serialized to the output. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimNullProperties</jsf>, value)</code>. @@ -333,7 +332,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * </ul> * <p> * If <jk>true</jk>, empty list values will not be serialized to the output. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimEmptyCollections</jsf>, value)</code>. @@ -363,7 +362,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * </ul> * <p> * If <jk>true</jk>, empty map values will not be serialized to the output. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimEmptyMaps</jsf>, value)</code>. @@ -392,7 +391,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * </ul> * <p> * If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being serialized. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimStrings</jsf>, value)</code>. @@ -417,12 +416,12 @@ public class SerializerBuilder extends CoreObjectBuilder { * </ul> * <p> * Bean used for resolution of URIs to absolute or root-relative form. - * <p> + * * <h6 class='figure'>Example:</h6> * <p class='bcode'> * <js>"{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}"</js> * </p> - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_uriContext</jsf>, value)</code>. @@ -462,7 +461,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * <li>{@link UriResolution#NONE} * - Don't do any URL resolution. * </ul> - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_uriResolution</jsf>, value)</code>. @@ -500,7 +499,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * <li>{@link UriRelativity#PATH_INFO} * - Relative URIs should be considered relative to the request URI. * </ul> - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_uriRelativity</jsf>, value)</code>. @@ -523,7 +522,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * <li><b>Default:</b> <jk>false</jk> * <li><b>Session-overridable:</b> <jk>true</jk> * </ul> - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_sortCollections</jsf>, value)</code>. @@ -547,6 +546,7 @@ public class SerializerBuilder extends CoreObjectBuilder { * <li><b>Default:</b> <jk>false</jk> * <li><b>Session-overridable:</b> <jk>true</jk> * </ul> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_sortMaps</jsf>, value)</code>. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerContext.java index f316fac..0afd2b4 100644 --- a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerContext.java @@ -70,7 +70,7 @@ public class SerializerContext extends BeanContext { * For example, if a model contains the links A->B->C->A, then the JSON generated will look like * the following when <jsf>SERIALIZER_ignoreRecursions</jsf> is <jk>true</jk>... * <code>{A:{B:{C:null}}}</code> - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>Checking for recursion can cause a small performance penalty. @@ -177,7 +177,8 @@ public class SerializerContext extends BeanContext { * <p> * Note that enabling this setting has the following effects on parsing: * <ul class='spaced-list'> - * <li>Map entries with <jk>null</jk> values will be lost. + * <li> + * Map entries with <jk>null</jk> values will be lost. * </ul> */ public static final String SERIALIZER_trimNullProperties = "Serializer.trimNullProperties"; @@ -196,8 +197,10 @@ public class SerializerContext extends BeanContext { * <p> * Note that enabling this setting has the following effects on parsing: * <ul class='spaced-list'> - * <li>Map entries with empty list values will be lost. - * <li>Bean properties with empty list values will not be set. + * <li> + * Map entries with empty list values will be lost. + * <li> + * Bean properties with empty list values will not be set. * </ul> */ public static final String SERIALIZER_trimEmptyCollections = "Serializer.trimEmptyLists"; @@ -216,7 +219,8 @@ public class SerializerContext extends BeanContext { * <p> * Note that enabling this setting has the following effects on parsing: * <ul class='spaced-list'> - * <li>Bean properties with empty map values will not be set. + * <li> + * Bean properties with empty map values will not be set. * </ul> */ public static final String SERIALIZER_trimEmptyMaps = "Serializer.trimEmptyMaps"; @@ -246,7 +250,7 @@ public class SerializerContext extends BeanContext { * </ul> * <p> * Bean used for resolution of URIs to absolute or root-relative form. - * <p> + * * <h6 class='figure'>Example:</h6> * <p class='bcode'> * <js>"{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}"</js> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroup.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroup.java b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroup.java index 0c1cf0e..2a6d3bb 100644 --- a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroup.java +++ b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroup.java @@ -25,10 +25,14 @@ import org.apache.juneau.http.*; * <p> * Provides the following features: * <ul class='spaced-list'> - * <li>Finds serializers based on HTTP <code>Accept</code> header values. - * <li>Sets common properties on all serializers in a single method call. - * <li>Locks all serializers in a single method call. - * <li>Clones existing groups and all serializers within the group in a single method call. + * <li> + * Finds serializers based on HTTP <code>Accept</code> header values. + * <li> + * Sets common properties on all serializers in a single method call. + * <li> + * Locks all serializers in a single method call. + * <li> + * Clones existing groups and all serializers within the group in a single method call. * </ul> * * <h6 class='topic'>Match ordering</h6> @@ -116,8 +120,7 @@ public final class SerializerGroup { * <p> * The general idea behind having the serializer resolution be a two-step process is so that the matched media type * can be passed in to the {@link WriterSerializer#doSerialize(SerializerSession, Object)} method. - * <br> - * For example... + * <br>For example... * <p class='bcode'> * String acceptHeaderValue = request.getHeader(<js>"Accept"</js>); * String matchingMediaType = group.findMatch(acceptHeaderValue); http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerSession.java index 80aa351..f75d3c2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerSession.java @@ -31,10 +31,14 @@ import org.apache.juneau.transform.*; * <p> * Used by serializers for the following purposes: * <ul class='spaced-list'> - * <li>Keeping track of how deep it is in a model for indentation purposes. - * <li>Ensuring infinite loops don't occur by setting a limit on how deep to traverse a model. - * <li>Ensuring infinite loops don't occur from loops in the model (when detectRecursions is enabled. - * <li>Allowing serializer properties to be overridden on method calls. + * <li> + * Keeping track of how deep it is in a model for indentation purposes. + * <li> + * Ensuring infinite loops don't occur by setting a limit on how deep to traverse a model. + * <li> + * Ensuring infinite loops don't occur from loops in the model (when detectRecursions is enabled. + * <li> + * Allowing serializer properties to be overridden on method calls. * </ul> * <p> * This class is NOT thread safe. It is meant to be discarded after one-time use. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/WriterSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/WriterSerializer.java b/juneau-core/src/main/java/org/apache/juneau/serializer/WriterSerializer.java index 699eb74..bb0491f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/serializer/WriterSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/serializer/WriterSerializer.java @@ -29,8 +29,10 @@ import org.apache.juneau.utils.*; * This class is typically the parent class of all character-based serializers. * It has 2 abstract methods to implement... * <ul class='spaced-list'> - * <li>{@link #createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType, UriContext)} - * <li>{@link #doSerialize(SerializerSession, Object)} + * <li> + * {@link #createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType, UriContext)} + * <li> + * {@link #doSerialize(SerializerSession, Object)} * </ul> * * <h6 class='topic'>@Produces annotation</h6> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/package.html ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/package.html b/juneau-core/src/main/java/org/apache/juneau/serializer/package.html index fc85f8b..ac50911 100644 --- a/juneau-core/src/main/java/org/apache/juneau/serializer/package.html +++ b/juneau-core/src/main/java/org/apache/juneau/serializer/package.html @@ -71,8 +71,7 @@ <div class='topic'> <p> The serialization API is designed to be easily extensible by developers. - <br> - If you are writing your own serializer, you will typically subclass directly from either + <br>If you are writing your own serializer, you will typically subclass directly from either {@link org.apache.juneau.serializer.WriterSerializer} or {@link org.apache.juneau.serializer.OutputStreamSerializer}. </p> @@ -89,11 +88,16 @@ <h6 class='topic'>Features</h6> <p> The <code>SerializerGroup</code> class provides the following features: + </p> <ul class='spaced-list'> - <li>Finds serializers based on HTTP <code>Accept</code> header values. - <li>Sets common properties on all serializers in a single method call. - <li>Locks all serializers in a single method call. - <li>Clones existing groups and all serializers within the group in a single method call. + <li> + Finds serializers based on HTTP <code>Accept</code> header values. + <li> + Sets common properties on all serializers in a single method call. + <li> + Locks all serializers in a single method call. + <li> + Clones existing groups and all serializers within the group in a single method call. </ul> <p> @@ -110,8 +114,7 @@ <p> Defining a new serializer is quite simple if you subclass directly from {@link org.apache.juneau.serializer.WriterSerializer} or {@link org.apache.juneau.serializer.OutputStreamSerializer}. - <br> - In each case, you simply need to implement a single method and specify a + <br>In each case, you simply need to implement a single method and specify a {@link org.apache.juneau.annotation.Produces} annotation. </p> <p> @@ -133,8 +136,7 @@ <p> Serializer that take advantage of the entire {@link org.apache.juneau.CoreObject} interface to be able to serialize arbitrary beans and POJOs is considerably more complex and outside the scope of this document. - <br> - If developing such a serializer, the best course of action would be to replicate what occurs in the + <br>If developing such a serializer, the best course of action would be to replicate what occurs in the {@link org.apache.juneau.json.JsonSerializer} class. </p> </div> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java index f4dfb85..74dd512 100644 --- a/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java @@ -60,7 +60,7 @@ public class SoapXmlSerializerBuilder extends XmlSerializerBuilder { * <li><b>Data type:</b> <code>String</code> * <li><b>Default:</b> <js>"http://www.w3.org/2003/05/soap-envelope";</js> * </ul> - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>SOAPXML_SOAPAction</jsf>, value)</code>. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerContext.java index 6d33b92..0746c19 100644 --- a/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerContext.java @@ -29,13 +29,15 @@ package org.apache.juneau.soap; * * <h6 class='topic'>Inherited configurable properties</h6> * <ul class='doctree'> - * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> + * <li class='jc'> + * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> * - Properties associated with handling beans on serializers and parsers. - * <ul> - * <li class='jc'><a class="doclink" - * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a> - * - Configurable properties common to all serializers. - * </ul> + * <ul> + * <li class='jc'> + * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a> + * - Configurable properties common to all serializers. + * </ul> + * </li> * </ul> */ public final class SoapXmlSerializerContext { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/svl/VarResolver.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/VarResolver.java b/juneau-core/src/main/java/org/apache/juneau/svl/VarResolver.java index aa9cceb..f4d8cc9 100644 --- a/juneau-core/src/main/java/org/apache/juneau/svl/VarResolver.java +++ b/juneau-core/src/main/java/org/apache/juneau/svl/VarResolver.java @@ -23,8 +23,7 @@ import org.apache.juneau.svl.vars.*; * Utility class for resolving variables of the form <js>"$X{key}"</js> in strings. * <p> * Variables are of the form <code>$X{key}</code>, where <code>X</code> can consist of zero or more ASCII characters. - * <br> - * The variable key can contain anything, even nested variables that get recursively resolved. + * <br>The variable key can contain anything, even nested variables that get recursively resolved. * <p> * Variables are defined through the {@link VarResolverBuilder#vars(Class[])} method. * <p> @@ -83,7 +82,7 @@ import org.apache.juneau.svl.vars.*; * <p> * Var resolvers can be cloned by using the {@link #builder()} method. * Cloning a resolver will copy it's {@link Var} class names and context objects. - * <p> + * * <h5 class='section'>Example:</h5> * <p class='bcode'> * <jc>// Create a resolver that copies the default resolver and adds $C and $ARG vars.</jc> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/svl/package.html ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/package.html b/juneau-core/src/main/java/org/apache/juneau/svl/package.html index e282e01..de1b9ac 100644 --- a/juneau-core/src/main/java/org/apache/juneau/svl/package.html +++ b/juneau-core/src/main/java/org/apache/juneau/svl/package.html @@ -132,54 +132,72 @@ </p> <p> The following shows the class hierarchy of the {@link org.apache.juneau.svl.Var} class and all current - predefined implementations. + predefined implementations. </p> <ul class='doctree'> - <li class='jac'>{@link org.apache.juneau.svl.Var} - Superclass of all vars. + <li class='jac'> + {@link org.apache.juneau.svl.Var} + - Superclass of all vars. <ul> - <li class='jac'>{@link org.apache.juneau.svl.SimpleVar} - Superclass of all vars that return strings. + <li class='jac'> + {@link org.apache.juneau.svl.SimpleVar} + - Superclass of all vars that return strings. <ul> - <li class='jac'>{@link org.apache.juneau.svl.DefaultingVar} + <li class='jac'> + {@link org.apache.juneau.svl.DefaultingVar} - Variables that define a default value if the resolve method returns null. <ul> - <li class='jac'>{@link org.apache.juneau.svl.MapVar} + <li class='jac'> + {@link org.apache.juneau.svl.MapVar} - Variables that pull values from maps. <ul> - <li class='jc'>{@link org.apache.juneau.svl.vars.SystemPropertiesVar} + <li class='jc'> + {@link org.apache.juneau.svl.vars.SystemPropertiesVar} - Resolves system properties. </ul> </li> - <li class='jc'>{@link org.apache.juneau.svl.vars.ArgsVar} + <li class='jc'> + {@link org.apache.juneau.svl.vars.ArgsVar} - Resolves variables from an {@link org.apache.juneau.utils.Args} object. - <li class='jc'>{@link org.apache.juneau.svl.vars.ConfigFileVar} + <li class='jc'> + {@link org.apache.juneau.svl.vars.ConfigFileVar} - Resolves variables from a {@link org.apache.juneau.ini.ConfigFile} object. - <li class='jc'>{@link org.apache.juneau.svl.vars.EnvVariablesVar} + <li class='jc'> + {@link org.apache.juneau.svl.vars.EnvVariablesVar} - Resolves environment variables. - <li class='jc'>{@link org.apache.juneau.svl.vars.ManifestFileVar} + <li class='jc'> + {@link org.apache.juneau.svl.vars.ManifestFileVar} - Resolves variables from a {@link org.apache.juneau.utils.ManifestFile} object. - <li class='jc'>{@link org.apache.juneau.rest.vars.ServletInitParamVar} + <li class='jc'> + {@link org.apache.juneau.rest.vars.ServletInitParamVar} - Resolves servlet initialization parameters. </ul> </li> - <li class='jac'>{@link org.apache.juneau.svl.MultipartVar} + <li class='jac'> + {@link org.apache.juneau.svl.MultipartVar} - Variables that consist of 2 or more comma-delimited arguments. <ul> - <li class='jc'>{@link org.apache.juneau.rest.vars.LocalizationVar} + <li class='jc'> + {@link org.apache.juneau.rest.vars.LocalizationVar} - Resolves localized strings for an HTTP request. </ul> </li> - <li class='jc'>{@link org.apache.juneau.rest.vars.RequestVar} + <li class='jc'> + {@link org.apache.juneau.rest.vars.RequestVar} - Resolves specialized HTTP request values. - <li class='jc'>{@link org.apache.juneau.rest.vars.UrlEncodeVar} + <li class='jc'> + {@link org.apache.juneau.rest.vars.UrlEncodeVar} - URL-encodes the value inside the variable. </ul> </li> - <li class='jac'>{@link org.apache.juneau.svl.StreamedVar} + <li class='jac'> + {@link org.apache.juneau.svl.StreamedVar} - Superclass of all vars that stream their value to writers. <ul> - <li class='jc'>{@link org.apache.juneau.rest.vars.SerializedRequestAttrVar} - - Resolves HTTP request attribute values passed through a - {@link org.apache.juneau.serializer.Serializer}. + <li class='jc'> + {@link org.apache.juneau.rest.vars.SerializedRequestAttrVar} + - Resolves HTTP request attribute values passed through a + {@link org.apache.juneau.serializer.Serializer}. </ul> </li> </ul> @@ -196,9 +214,11 @@ Two methods are provided for resolving variables: </p> <ul class='doctree'> - <li class='jm'>{@link org.apache.juneau.svl.VarResolver#resolve(String)} + <li class='jm'> + {@link org.apache.juneau.svl.VarResolver#resolve(String)} - Resolves variables and returns the results as a simple string. - <li class='jm'>{@link org.apache.juneau.svl.VarResolver#resolveTo(String,Writer)} + <li class='jm'> + {@link org.apache.juneau.svl.VarResolver#resolveTo(String,Writer)} - Resolves variables and sends results to a writer. </ul> <p> @@ -248,6 +268,7 @@ method. Cloning a resolver will copy it's {@link org.apache.juneau.svl.Var} class names and context objects. </p> + <h6 class='topic'>Example:</h6> <p class='bcode'> <jc>// Create a resolver that copies the default resolver and adds $C and $ARG vars.</jc> @@ -261,16 +282,18 @@ <h3 class='topic' onclick='toggle(this)'>1.3 - Other Notes</h3> <div class='topic'> <ul class='spaced-list'> - <li>The escape character <js>'\'</js> can be used when necessary to escape the following characters: + <li> + The escape character <js>'\'</js> can be used when necessary to escape the following characters: <code>$ , { }</code> - <li><b>WARNING:</b> It is possible to cause {@link java.lang.StackOverflowError StackOverflowErrors} if + <li> + <b>WARNING:</b> It is possible to cause {@link java.lang.StackOverflowError StackOverflowErrors} if your nested variables result in a recursive loop (e.g. the environment variable <code>'MYPROPERTY'</code> has the value <code>'$E{MYPROPERTY}'</code>). So don't do that! - <li>As a general rule, this class tries to be as efficient as possible by not creating new strings when not + <li> + As a general rule, this class tries to be as efficient as possible by not creating new strings when not needed. - <br> - For example, calling the resolve method on a string that doesn't contain variables (e.g. + <br>For example, calling the resolve method on a string that doesn't contain variables (e.g. <code>resolver.resolve(<js>"foobar"</js>)</code>) will simply be a no-op and return the same string. </ul> </div> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/svl/vars/IfVar.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/vars/IfVar.java b/juneau-core/src/main/java/org/apache/juneau/svl/vars/IfVar.java index 922fb99..b5600b5 100644 --- a/juneau-core/src/main/java/org/apache/juneau/svl/vars/IfVar.java +++ b/juneau-core/src/main/java/org/apache/juneau/svl/vars/IfVar.java @@ -26,11 +26,9 @@ import org.apache.juneau.svl.*; * </ul> * <p> * The boolean argument is any string. - * <br> - * The following values are interpreted as <jk>true</jk>: <js>"true"</js>,<js>"TRUE"</js>,<js>"t"</js>, + * <br>The following values are interpreted as <jk>true</jk>: <js>"true"</js>,<js>"TRUE"</js>,<js>"t"</js>, * <js>"T"</js>,<js>"1"</js>. - * <br> - * All else are interpreted as <jk>false</jk> + * <br>All else are interpreted as <jk>false</jk> * * <h5 class='section'>Example:</h5> * <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transform/PojoSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transform/PojoSwap.java b/juneau-core/src/main/java/org/apache/juneau/transform/PojoSwap.java index e6384fe..14e89ee 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transform/PojoSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transform/PojoSwap.java @@ -36,8 +36,7 @@ import org.apache.juneau.serializer.*; * <p> * <code>PojoSwaps</code> are associated with instances of {@link BeanContext BeanContexts} by passing the swap * class to the {@link CoreObjectBuilder#pojoSwaps(Class...)} method. - * <br> - * When associated with a bean context, fields of the specified type will automatically be converted when the + * <br>When associated with a bean context, fields of the specified type will automatically be converted when the * {@link BeanMap#get(Object)} or {@link BeanMap#put(String, Object)} methods are called. * <p> * <code>PojoSwaps</code> have two parameters: @@ -45,11 +44,9 @@ import org.apache.juneau.serializer.*; * <li>{@code <T>} - The normal representation of an object. * <li>{@code <S>} - The swapped representation of an object. * </ol> - * <br> - * {@link Serializer Serializers} use swaps to convert objects of type T into objects of type S, and on calls to + * <br>{@link Serializer Serializers} use swaps to convert objects of type T into objects of type S, and on calls to * {@link BeanMap#get(Object)}. - * <br> - * {@link Parser Parsers} use swaps to convert objects of type S into objects of type T, and on calls to + * <br>{@link Parser Parsers} use swaps to convert objects of type S into objects of type T, and on calls to * {@link BeanMap#put(String,Object)}. * * <h6 class='topic'>Subtypes</h6> @@ -74,13 +71,20 @@ import org.apache.juneau.serializer.*; * JSON (or language-specific equivalent). * The list of valid transformed types are as follows... * <ul class='spaced-list'> - * <li>{@link String} - * <li>{@link Number} - * <li>{@link Boolean} - * <li>{@link Collection} containing anything on this list. - * <li>{@link Map} containing anything on this list. - * <li>A java bean with properties of anything on this list. - * <li>An array of anything on this list. + * <li> + * {@link String} + * <li> + * {@link Number} + * <li> + * {@link Boolean} + * <li> + * {@link Collection} containing anything on this list. + * <li> + * {@link Map} containing anything on this list. + * <li> + * A java bean with properties of anything on this list. + * <li> + * An array of anything on this list. * </ul> * * <h6 class='topic'>Normal Class Type {@code <T>}</h6> @@ -143,13 +147,20 @@ public abstract class PojoSwap<T,S> { * <p> * The object must be converted into one of the following serializable types: * <ul class='spaced-list'> - * <li>{@link String} - * <li>{@link Number} - * <li>{@link Boolean} - * <li>{@link Collection} containing anything on this list. - * <li>{@link Map} containing anything on this list. - * <li>A java bean with properties of anything on this list. - * <li>An array of anything on this list. + * <li> + * {@link String} + * <li> + * {@link Number} + * <li> + * {@link Boolean} + * <li> + * {@link Collection} containing anything on this list. + * <li> + * {@link Map} containing anything on this list. + * <li> + * A java bean with properties of anything on this list. + * <li> + * An array of anything on this list. * </ul> * * @param session The bean session to use to get the class meta. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transform/SurrogateSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transform/SurrogateSwap.java b/juneau-core/src/main/java/org/apache/juneau/transform/SurrogateSwap.java index a547340..69f3dfe 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transform/SurrogateSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transform/SurrogateSwap.java @@ -49,14 +49,17 @@ import org.apache.juneau.serializer.*; * <p> * Surrogate classes must conform to the following: * <ul class='spaced-list'> - * <li>It must have a one or more public constructors that take in a single parameter whose type is the normal types. + * <li> + * It must have a one or more public constructors that take in a single parameter whose type is the normal types. * (It is possible to define a class as a surrogate for multiple class types by using multiple constructors with * different parameter types). - * <li>It optionally can have a public static method that takes in a single parameter whose type is the transformed + * <li> + * It optionally can have a public static method that takes in a single parameter whose type is the transformed * type and returns an instance of the normal type. * This is called the un-transform method. * The method can be called anything. - * <li>If an un-transform method is present, the class must also contain a no-arg constructor (so that the + * <li> + * If an un-transform method is present, the class must also contain a no-arg constructor (so that the * transformed class can be instantiated by the parser before being converted into the normal class by the * un-transform method). * </ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transform/package.html ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transform/package.html b/juneau-core/src/main/java/org/apache/juneau/transform/package.html index a51c2e8..124bc10 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transform/package.html +++ b/juneau-core/src/main/java/org/apache/juneau/transform/package.html @@ -79,8 +79,10 @@ These classes are: </p> <ul class='spaced-list'> - <li>{@link org.apache.juneau.transform.BeanFilter} - Transforms that alter the way beans are handled. - <li>{@link org.apache.juneau.transform.PojoSwap} - Transforms that swap non-serializable POJOs with + <li> + {@link org.apache.juneau.transform.BeanFilter} - Transforms that alter the way beans are handled. + <li> + {@link org.apache.juneau.transform.PojoSwap} - Transforms that swap non-serializable POJOs with serializable POJOs during serialization (and optionally vis-versa during parsing). <ol> <li>{@link org.apache.juneau.transform.StringSwap} - Convenience subclass for swaps that convert @@ -94,14 +96,22 @@ Transforms are added to serializers and parsers in a variety of ways: </p> <ul class='spaced-list'> - <li>{@link org.apache.juneau.serializer.SerializerBuilder#beanFilters(Class[])} / {@link org.apache.juneau.serializer.SerializerBuilder#pojoSwaps(Class[])} - On serializers. - <li>{@link org.apache.juneau.serializer.SerializerGroupBuilder#beanFilters(Class[])} / {@link org.apache.juneau.serializer.SerializerGroupBuilder#pojoSwaps(Class[])} - On groups of serializers. - <li>{@link org.apache.juneau.parser.ParserBuilder#beanFilters(Class[])} / {@link org.apache.juneau.parser.ParserBuilder#pojoSwaps(Class[])} - On parsers. - <li>{@link org.apache.juneau.parser.ParserGroupBuilder#beanFilters(Class[])} / {@link org.apache.juneau.parser.ParserGroupBuilder#pojoSwaps(Class[])} - On groups of parsers. - <li>{@link org.apache.juneau.rest.client.RestClientBuilder#beanFilters(Class[])} / {@link org.apache.juneau.rest.client.RestClientBuilder#pojoSwaps(Class[])} - On the serializer and parser registered on a REST client. - <li>{@link org.apache.juneau.rest.annotation.RestResource#beanFilters() @RestResource.beanFilters()} / {@link org.apache.juneau.rest.annotation.RestResource#pojoSwaps() @RestResource.pojoSwaps()}- On all serializers and parsers defined on a REST servlet. - <li>{@link org.apache.juneau.rest.annotation.RestMethod#beanFilters() @RestMethod.beanFilters()} / {@link org.apache.juneau.rest.annotation.RestMethod#pojoSwaps() @RestMethod.pojoSwaps()} - On all serializers and parsers defined on a method in a REST servlet. - <li>{@link org.apache.juneau.rest.jaxrs.JuneauProvider#beanFilters() @JuneauProvider.beanFilters()} / {@link org.apache.juneau.rest.jaxrs.JuneauProvider#pojoSwaps() @JuneauProvider.pojoSwaps()} - On all serializers and parsers defined on a JAX-RS provider. + <li> + {@link org.apache.juneau.serializer.SerializerBuilder#beanFilters(Class[])} / {@link org.apache.juneau.serializer.SerializerBuilder#pojoSwaps(Class[])} - On serializers. + <li> + {@link org.apache.juneau.serializer.SerializerGroupBuilder#beanFilters(Class[])} / {@link org.apache.juneau.serializer.SerializerGroupBuilder#pojoSwaps(Class[])} - On groups of serializers. + <li> + {@link org.apache.juneau.parser.ParserBuilder#beanFilters(Class[])} / {@link org.apache.juneau.parser.ParserBuilder#pojoSwaps(Class[])} - On parsers. + <li> + {@link org.apache.juneau.parser.ParserGroupBuilder#beanFilters(Class[])} / {@link org.apache.juneau.parser.ParserGroupBuilder#pojoSwaps(Class[])} - On groups of parsers. + <li> + {@link org.apache.juneau.rest.client.RestClientBuilder#beanFilters(Class[])} / {@link org.apache.juneau.rest.client.RestClientBuilder#pojoSwaps(Class[])} - On the serializer and parser registered on a REST client. + <li> + {@link org.apache.juneau.rest.annotation.RestResource#beanFilters() @RestResource.beanFilters()} / {@link org.apache.juneau.rest.annotation.RestResource#pojoSwaps() @RestResource.pojoSwaps()}- On all serializers and parsers defined on a REST servlet. + <li> + {@link org.apache.juneau.rest.annotation.RestMethod#beanFilters() @RestMethod.beanFilters()} / {@link org.apache.juneau.rest.annotation.RestMethod#pojoSwaps() @RestMethod.pojoSwaps()} - On all serializers and parsers defined on a method in a REST servlet. + <li> + {@link org.apache.juneau.rest.jaxrs.JuneauProvider#beanFilters() @JuneauProvider.beanFilters()} / {@link org.apache.juneau.rest.jaxrs.JuneauProvider#pojoSwaps() @JuneauProvider.pojoSwaps()} - On all serializers and parsers defined on a JAX-RS provider. </ul> <p> Swaps can also be associated with classes through the {@link org.apache.juneau.annotation.Pojo#swap @Pojo.swap()} annotation. @@ -116,10 +126,14 @@ They can be used for the following purposes: </p> <ul class='spaced-list'> - <li>Include or exclude which properties are exposed in beans, or the order those properties are serialized. - <li>Define property-namers for customizing bean property names. - <li>Define bean subtypes. - <li>Define bean interface classes. + <li> + Include or exclude which properties are exposed in beans, or the order those properties are serialized. + <li> + Define property-namers for customizing bean property names. + <li> + Define bean subtypes. + <li> + Define bean interface classes. </ul> <p> It should be noted that the {@link org.apache.juneau.annotation.Bean @Bean} annotation provides equivalent @@ -127,8 +141,7 @@ However, the <code>BeanFilter</code> class allows you to provide the same features when you do not have access to the source code. <p> - <h5 class='topic'>Examples</h5> - + <h6 class='topic'>Explicitly specify which properties are visible on a bean class</h6> <p class='bcode'> <jc>// Define bean filter that orders properties by "age" then "name"</jc> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java index 498a8b7..805fbd7 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java @@ -30,7 +30,7 @@ import org.apache.juneau.transform.*; * <h6 class='topic'>Behavior-specific subclasses</h6> * <p> * The following direct subclasses are provided for convenience to the following formats: - * <ul class='spaced-list'> + * <ul> * <li>{@link ToString} - To {@link String Strings} using the {@code Date.toString()} method. * <li>{@link ISO8601DT} - To ISO8601 date-time strings. * <li>{@link ISO8601DTZ} - Same as {@link ISO8601DT}, except always serializes in GMT. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java index 94b27b1..1bb74bb 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java @@ -30,7 +30,7 @@ import org.apache.juneau.transform.*; * <h6 class='topic'>Behavior-specific subclasses</h6> * <p> * The following direct subclasses are provided for convenience to the following formats: - * <ul class='spaced-list'> + * <ul> * <li>{@link ToString} - To {@link String Strings} using the {@code Date.toString()} method. * <li>{@link ISO8601DT} - To ISO8601 date-time strings. * <li>{@link ISO8601DTZ} - Same as {@link ISO8601DT}, except always serializes in GMT. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java index b8e9011..73f31e4 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java @@ -39,7 +39,7 @@ import org.apache.juneau.xml.*; * <h6 class='topic'>Behavior-specific subclasses</h6> * <p> * The following direct subclasses are provided for convenience: - * <ul class='spaced-list'> + * <ul> * <li>{@link Json} - Parses JSON text. * <li>{@link Xml} - Parses XML text. * <li>{@link Html} - Parses HTML text. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java index 2dcf520..b3ee739 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java @@ -64,7 +64,7 @@ public class UonParserBuilder extends ParserBuilder { * <p> * Specify <jk>true</jk> if URI encoded characters should be decoded, <jk>false</jk> if they've already been * decoded before being passed to this parser. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>UON_decodeChars</jsf>, value)</code>. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java index 49764ee..7cf666b 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java @@ -26,12 +26,15 @@ import org.apache.juneau.urlencoding.*; * * <h6 class='topic'>Inherited configurable properties</h6> * <ul class='doctree'> - * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> + * <li class='jc'> + * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> * - Properties associated with handling beans on serializers and parsers. - * <ul> - * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> - * - Configurable properties common to all parsers. - * </ul> + * <ul> + * <li class='jc'> + * <a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> + * - Configurable properties common to all parsers. + * </ul> + * </li> * </ul> */ public class UonParserContext extends ParserContext { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java index 3eb3c03..c516626 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java @@ -67,7 +67,7 @@ public class UonSerializerBuilder extends SerializerBuilder { * If <jk>true</jk>, non-valid URI characters will be converted to <js>"%xx"</js> sequences. * Set to <jk>false</jk> if parameter value is being passed to some other code that will already perform * URL-encoding of non-valid URI characters. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>UON_encodeChars</jsf>, value)</code>. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java index 685408f..15ca313 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java @@ -26,13 +26,15 @@ import org.apache.juneau.urlencoding.*; * * <h6 class='topic'>Inherited configurable properties</h6> * <ul class='doctree'> - * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> + * <li class='jc'> + * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> * - Properties associated with handling beans on serializers and parsers. - * <ul> - * <li class='jc'><a class="doclink" - * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a> - * - Configurable properties common to all serializers. - * </ul> + * <ul> + * <li class='jc'> + * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a> + * - Configurable properties common to all serializers. + * </ul> + * </li> * </ul> */ public class UonSerializerContext extends SerializerContext { @@ -89,21 +91,19 @@ public class UonSerializerContext extends SerializerContext { * Specifies the format to use for URL GET parameter keys and values. * <p> * The possible values are: - * <ul> - * <li><js>"UON"</js> (default) - Use UON notation for values. - * <br> - * String values such as <js>"(foo='bar')"</js> will end up being quoted and escaped to <js>"'(foo=bar~'baz~')'"</js>. - * <br> - * Boolean strings (<js>"true"</js>/<js>"false"</js>) and numeric values (<js>"123"</js>) will also end up + * <ul class='spaced-list'> + * <li> + * <js>"UON"</js> (default) - Use UON notation for values. + * <br>String values such as <js>"(foo='bar')"</js> will end up being quoted and escaped to <js>"'(foo=bar~'baz~')'"</js>. + * <br>Boolean strings (<js>"true"</js>/<js>"false"</js>) and numeric values (<js>"123"</js>) will also end up * quoted (<js>"'true'"</js>, <js>"'false'"</js>, <js>"'123'"</js>. - * <li><js>"PLAINTEXT"</js> (default) - Serialize as plain text. - * <br> - * Strings will never be quoted or escaped. - * <br> - * Note that this can cause errors during parsing if you're using the URL-encoding parser to parse + * <li> + * <js>"PLAINTEXT"</js> (default) - Serialize as plain text. + * <br>Strings will never be quoted or escaped. + * <br>Note that this can cause errors during parsing if you're using the URL-encoding parser to parse * the results since UON constructs won't be differentiable. - * <br> - * However, this is not an issue if you're simply creating queries or form posts against 3rd-party interfaces. + * <br>However, this is not an issue if you're simply creating queries or form posts against 3rd-party + * interfaces. * </ul> */ public static final String UON_paramFormat = "UonSerializer.paramFormat"; http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/uon/UonWriter.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonWriter.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonWriter.java index b107af3..0476fa0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonWriter.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonWriter.java @@ -20,7 +20,7 @@ import org.apache.juneau.serializer.*; /** * Specialized writer for serializing UON-encoded text. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This class is not intended for external use.
