http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java b/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java index 1c4405d..56a9041 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java @@ -56,8 +56,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Location.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Location.java b/juneau-core/src/main/java/org/apache/juneau/http/Location.java index 5d37c25..fdf3c7a 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/Location.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/Location.java @@ -45,8 +45,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java b/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java index 2660354..c94a2cd 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java @@ -47,8 +47,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java b/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java index 408c073..148054a 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java @@ -26,8 +26,10 @@ import org.apache.juneau.json.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ @@ -81,7 +83,7 @@ public class MediaType implements Comparable<MediaType> { * </ul> * * @param s The media type string. Will be lowercased. - * <br>Returns <jk>null</jk> if input is null. + * Returns <jk>null</jk> if input is null. * @return A cached media type object. */ public static MediaType forString(String s) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java b/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java index 9ebf720..dd48a70 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java @@ -24,8 +24,10 @@ import org.apache.juneau.internal.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java b/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java index 26c8ce2..85d9408 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java @@ -53,8 +53,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java index 13594cd..dc60d54 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java @@ -40,8 +40,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java index 2b7287d..b944aa0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java @@ -42,8 +42,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Range.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Range.java b/juneau-core/src/main/java/org/apache/juneau/http/Range.java index 1c7cb9b..00248db 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/Range.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/Range.java @@ -118,8 +118,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Referer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Referer.java b/juneau-core/src/main/java/org/apache/juneau/http/Referer.java index e5757a5..3230a0a 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/Referer.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/Referer.java @@ -47,8 +47,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java b/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java index 747c814..60c76a0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java @@ -49,8 +49,10 @@ import org.apache.juneau.internal.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Server.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Server.java b/juneau-core/src/main/java/org/apache/juneau/http/Server.java index d484976..0325cf9 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/Server.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/Server.java @@ -47,8 +47,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java b/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java index e41213e..2510511 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java @@ -29,8 +29,10 @@ import org.apache.juneau.internal.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/TE.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/TE.java b/juneau-core/src/main/java/org/apache/juneau/http/TE.java index 7ed9855..c9de654 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/TE.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/TE.java @@ -75,8 +75,10 @@ import org.apache.juneau.internal.*; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java b/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java index da276f2..237fbce 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java @@ -47,8 +47,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java b/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java index dcbb896..6440a83 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java @@ -46,8 +46,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java b/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java index 0ccd015..6895e31 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java @@ -66,8 +66,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java b/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java index e8e4827..3b2db5b 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java @@ -42,8 +42,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Vary.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Vary.java b/juneau-core/src/main/java/org/apache/juneau/http/Vary.java index fc4bc41..aff07a2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/Vary.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/Vary.java @@ -61,8 +61,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Via.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Via.java b/juneau-core/src/main/java/org/apache/juneau/http/Via.java index 35e6131..575a813 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/Via.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/Via.java @@ -97,8 +97,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Warning.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Warning.java b/juneau-core/src/main/java/org/apache/juneau/http/Warning.java index ae37a66..ec081ed 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/Warning.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/Warning.java @@ -105,8 +105,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java b/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java index 08bfee7..7dad3a0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java +++ b/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java @@ -38,8 +38,10 @@ package org.apache.juneau.http; * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> - * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> - * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> + * <li class='jp'> + * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a> + * <li class='extlink'> + * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'> * Hypertext Transfer Protocol -- HTTP/1.1</a> * </ul> */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java index 18efcf9..d6d5ad2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java +++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java @@ -134,9 +134,12 @@ public abstract class ConfigFile implements Map<String,Section> { * <p> * The lines can be any of the following.... * <ul class='spaced-list'> - * <li><js>"# comment"</js> - A comment line. - * <li><js>"key=val"</js> - A key/value pair (equivalent to calling {@link #put(String,Object)}. - * <li><js>" foobar "</js> - Anything else (interpreted as a comment). + * <li> + * <js>"# comment"</js> - A comment line. + * <li> + * <js>"key=val"</js> - A key/value pair (equivalent to calling {@link #put(String,Object)}. + * <li> + * <js>" foobar "</js> - Anything else (interpreted as a comment). * </ul> * <p> * If the section does not exist, it will automatically be created. @@ -157,8 +160,10 @@ public abstract class ConfigFile implements Map<String,Section> { * <p> * Header comments can be of the following formats... * <ul class='spaced-list'> - * <li><js>"# comment"</js> - A comment line. - * <li><js>"comment"</js> - Anything else (will automatically be prefixed with <js>"# "</js>). + * <li> + * <js>"# comment"</js> - A comment line. + * <li> + * <js>"comment"</js> - Anything else (will automatically be prefixed with <js>"# "</js>). * </ul> * <p> * If the section does not exist, it will automatically be created. @@ -264,8 +269,10 @@ public abstract class ConfigFile implements Map<String,Section> { * <p> * The key can be in one of the following formats... * <ul class='spaced-list'> - * <li><js>"key"</js> - A value in the default section (i.e. defined above any <code>[section]</code> header). - * <li><js>"section/key"</js> - A value from the specified section. + * <li> + * <js>"key"</js> - A value in the default section (i.e. defined above any <code>[section]</code> header). + * <li> + * <js>"section/key"</js> - A value from the specified section. * </ul> * <p> * The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps). @@ -299,7 +306,7 @@ public abstract class ConfigFile implements Map<String,Section> { * types. * <p> * The array can be arbitrarily long to indicate arbitrarily complex data structures. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>Use the {@link #getObject(String, Class)} method instead if you don't need a parameterized map/collection. @@ -348,6 +355,7 @@ public abstract class ConfigFile implements Map<String,Section> { * Same as {@link #getObject(String, Type, Type...)} except optimized for a non-parameterized class. * <p> * This is the preferred parse method for simple types since you don't need to cast the results. + * * <h5 class='section'>Examples:</h5> * <p class='bcode'> * ConfigFile cf = <jk>new</jk> ConfigFileBuilder().build(<js>"MyConfig.cfg"</js>); @@ -566,8 +574,10 @@ public abstract class ConfigFile implements Map<String,Section> { * <p> * The key can be in one of the following formats... * <ul class='spaced-list'> - * <li><js>"key"</js> - A value in the default section (i.e. defined above any <code>[section]</code> header). - * <li><js>"section/key"</js> - A value from the specified section. + * <li> + * <js>"key"</js> - A value in the default section (i.e. defined above any <code>[section]</code> header). + * <li> + * <js>"section/key"</js> - A value from the specified section. * </ul> * * @param key The key. See {@link #getString(String)} for a description of the key. @@ -619,8 +629,10 @@ public abstract class ConfigFile implements Map<String,Section> { * * <h5 class='section'>Example:</h5> * <ul class='spaced-list'> - * <li><code><js>"100K"</js> => 1024000</code> - * <li><code><js>"100M"</js> => 104857600</code> + * <li> + * <code><js>"100K"</js> => 1024000</code> + * <li> + * <code><js>"100M"</js> => 104857600</code> * </ul> * * @param key The key. See {@link #getString(String)} for a description of the key. @@ -694,11 +706,15 @@ public abstract class ConfigFile implements Map<String,Section> { * <p> * The format of the entry depends on the data type of the value. * <ul class='spaced-list'> - * <li>Simple types (<code>String</code>, <code>Number</code>, <code>Boolean</code>, primitives) + * <li> + * Simple types (<code>String</code>, <code>Number</code>, <code>Boolean</code>, primitives) * are serialized as plain strings. - * <li>Arrays and collections of simple types are serialized as comma-delimited lists of plain strings. - * <li>Other types (e.g. beans) are serialized using the serializer registered with this config file. - * <li>Arrays and collections of other types are serialized as comma-delimited lists of serialized strings of + * <li> + * Arrays and collections of simple types are serialized as comma-delimited lists of plain strings. + * <li> + * Other types (e.g. beans) are serialized using the serializer registered with this config file. + * <li + * >Arrays and collections of other types are serialized as comma-delimited lists of serialized strings of * each entry. * </ul> * @@ -823,7 +839,7 @@ public abstract class ConfigFile implements Map<String,Section> { * Converts this config file section to the specified bean instance. * <p> * Key/value pairs in the config file section get copied as bean property values to the specified bean class. - * <p> + * * <h6 class='figure'>Example config file</h6> * <p class='bcode'> * <cs>[MyAddress]</cs> @@ -880,7 +896,7 @@ public abstract class ConfigFile implements Map<String,Section> { /** * Wraps a config file section inside a Java interface so that values in the section can be read and * write using getters and setters. - * <p> + * * <h6 class='figure'>Example config file</h6> * <p class='bcode'> * <cs>[MySection]</cs> @@ -1111,9 +1127,12 @@ public abstract class ConfigFile implements Map<String,Section> { * * The default {@link VarResolver} is registered with the following {@link Var StringVars}: * <ul class='spaced-list'> - * <li><code>$S{key}</code>,<code>$S{key,default}</code> - System properties. - * <li><code>$E{key}</code>,<code>$E{key,default}</code> - Environment variables. - * <li><code>$C{key}</code>,<code>$C{key,default}</code> - Values in this configuration file. + * <li> + * <code>$S{key}</code>,<code>$S{key,default}</code> - System properties. + * <li> + * <code>$E{key}</code>,<code>$E{key,default}</code> - Environment variables. + * <li> + * <code>$C{key}</code>,<code>$C{key,default}</code> - Values in this configuration file. * </ul> * * @return A new config file that resolves string variables. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java index 499dc37..39baf64 100644 --- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java @@ -224,22 +224,21 @@ public class ConfigFileBuilder { * <p> * Arguments can be any of the following... * <ul class='spaced-list'> - * <li>No arguments - * <br> - * Prints usage message. - * <li><code>createBatchEnvFile -configfile <configFile> -envfile <batchFile> [-verbose]</code> - * <br> - * Creates a batch file that will set each config file entry as an environment variable. - * <br> - * Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>) - * will be converted to underscores. - * <li><code>createShellEnvFile -configFile <configFile> -envFile <configFile> [-verbose]</code> + * <li> + * No arguments + * <br>Prints usage message. + * <li> + * <code>createBatchEnvFile -configfile <configFile> -envfile <batchFile> [-verbose]</code> + * <br>Creates a batch file that will set each config file entry as an environment variable. + * <br>Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>) + * will be converted to underscores. + * <li> + * <code>createShellEnvFile -configFile <configFile> -envFile <configFile> [-verbose]</code> * Creates a shell script that will set each config file entry as an environment variable. - * <br> - * Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>) + * <br>Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>) * will be converted to underscores. - * <br> - * <li><code>setVals -configFile <configFile> -vals [var1=val1 [var2=val2...]] [-verbose]</code> + * <li> + * <code>setVals -configFile <configFile> -vals [var1=val1 [var2=val2...]] [-verbose]</code> * Sets values in config files. * </ul> * <p> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/ini/package.html ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/package.html b/juneau-core/src/main/java/org/apache/juneau/ini/package.html index 290c43b..aeda8c4 100644 --- a/juneau-core/src/main/java/org/apache/juneau/ini/package.html +++ b/juneau-core/src/main/java/org/apache/juneau/ini/package.html @@ -228,9 +228,11 @@ Resolving config files can be retrieved through the following methods: </p> <ul class='spaced-list'> - <li>{@link org.apache.juneau.ini.ConfigFile#getResolving()} - Returns a config file that resolves a default + <li> + {@link org.apache.juneau.ini.ConfigFile#getResolving()} - Returns a config file that resolves a default set of variables. - <li>{@link org.apache.juneau.ini.ConfigFile#getResolving(VarResolver)} - Returns a config file that resolves + <li> + {@link org.apache.juneau.ini.ConfigFile#getResolving(VarResolver)} - Returns a config file that resolves a custom set of variables. </ul> <p> @@ -238,11 +240,14 @@ the following variables: </p> <ul class='spaced-list'> - <li><code>$S{key}</code>, <code>$S{key,default}</code> - System properties. - <li><code>$E{key}</code>, <code>$E{key,default}</code> - Environment variables. - <li><code>$C{key}</code>, <code>$C{key,default}</code> - Values in this configuration file. + <li> + <code>$S{key}</code>, <code>$S{key,default}</code> - System properties. + <li> + <code>$E{key}</code>, <code>$E{key,default}</code> - Environment variables. + <li> + <code>$C{key}</code>, <code>$C{key,default}</code> - Values in this configuration file. </ul> - <p> + <h6 class='topic'>Examples:</h6> <p class='bcode'> <cc>#--------------------------</cc> @@ -256,8 +261,7 @@ <p> Support for variables is extensible. You can add support for your own variables by implementing custom {@link org.apache.juneau.svl.VarResolver VarResolvers}. - <br> - For example, the microservice <code>Resource</code> class provides access to config files that + <br>For example, the microservice <code>Resource</code> class provides access to config files that can contain any of the following variables: </p> <ul> @@ -282,8 +286,7 @@ <p> If a config file contains sensitive information such as passwords, those values can be marked for encoding by appending <js>'*'</js> to the end of the key name. - <br> - If a marked and unencoded value is detected in the file during load, it will be encoded and saved immediately. + <br>If a marked and unencoded value is detected in the file during load, it will be encoded and saved immediately. </p> <p> For example, the following password is marked for encoding.... @@ -305,8 +308,7 @@ </p> <p> The default encoder is {@link org.apache.juneau.ini.XorEncoder} which is a simple XOR+Base64 encoder. - <br> - If desired, custom encoder can be used by implementing the {@link org.apache.juneau.ini.Encoder} + <br>If desired, custom encoder can be used by implementing the {@link org.apache.juneau.ini.Encoder} interface and creating your own <code>ConfigFileBuilder</code> using the {@link org.apache.juneau.ini.ConfigFileBuilder#encoder(Encoder)} method. </p> @@ -326,10 +328,14 @@ Subclasses are provided for listening for different kinds of events: </p> <ul class='spaced-list'> - <li>{@link org.apache.juneau.ini.ConfigFileListener} - Config file is saved, loaded, or modified. - <li>{@link org.apache.juneau.ini.SectionListener} - One or more entries in a section are modified. - <li>{@link org.apache.juneau.ini.EntryListener} - An individual entry is modified. + <li> + {@link org.apache.juneau.ini.ConfigFileListener} - Config file is saved, loaded, or modified. + <li> + {@link org.apache.juneau.ini.SectionListener} - One or more entries in a section are modified. + <li> + {@link org.apache.juneau.ini.EntryListener} - An individual entry is modified. </ul> + <h6 class="topic">Example:</h6> <p class='bcode'> <jc>// Get our config file using the default config manager</jc> @@ -355,8 +361,7 @@ The {@link org.apache.juneau.ini.ConfigFileBuilder} class contains a {@link org.apache.juneau.ini.ConfigFileBuilder#main(String[])} method that can be used to work with config files through a command-line prompt. - <br> - This is invoked as a normal Java command: + <br>This is invoked as a normal Java command: </p> <p class='bcode'> java -jar juneau.jar org.apache.juneau.ini.ConfigFileBuilder [args] @@ -365,21 +370,21 @@ Arguments can be any of the following... </p> <ul class='spaced-list'> - <li>No arguments - <br> - Prints usage message. - <li><code>createBatchEnvFile -configfile <configFile> -envfile <batchFile> [-verbose]</code> - <br> - Creates a batch file that will set each config file entry as an environment variable. - <br> - Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>) + <li> + No arguments + <br>Prints usage message. + <li> + <code>createBatchEnvFile -configfile <configFile> -envfile <batchFile> [-verbose]</code> + <br>Creates a batch file that will set each config file entry as an environment variable. + <br>Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>) will be converted to underscores. - <li><code>createShellEnvFile -configFile <configFile> -envFile <configFile> [-verbose]</code> + <li> + <code>createShellEnvFile -configFile <configFile> -envFile <configFile> [-verbose]</code> Creates a shell script that will set each config file entry as an environment variable. - <br> - Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>) - will be converted to underscores. - <li><code>setVals -configFile <configFile> -vals [var1=val1 [var2=val2...]] [-verbose]</code> + <br>Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>) + will be converted to underscores. + <li> + <code>setVals -configFile <configFile> -vals [var1=val1 [var2=val2...]] [-verbose]</code> Sets values in config files. </ul> <p> @@ -402,11 +407,9 @@ <p> The <code>org.apache.juneau.microservice.resources.ConfigResource</code> is a predefined REST interface that allows access to the config file used by a microservice. - <br> - The <code>juneau-examples-rest</code> project is a microservice that includes this resource + <br>The <code>juneau-examples-rest</code> project is a microservice that includes this resource at <code>http://localhost:10000/sample/config</code>. - <br> - The sample microservice uses the following config file <code>juneau-examples.cfg</code>: + <br>The sample microservice uses the following config file <code>juneau-examples.cfg</code>: </p> <p class='bcode'> <cc>#================================================================================ @@ -618,13 +621,10 @@ <p> In the previous example, an edit page was shown that allows you to edit config files through a REST interface. - <br> - Note that if only a single entry is modified in the config file, we only want to trigger + <br>Note that if only a single entry is modified in the config file, we only want to trigger listeners for that change, not trigger all listeners. - <br> - This is where the {@link org.apache.juneau.ini.ConfigFile#merge(ConfigFile)} method comes into play. - <br> - This method will copy the contents of one config file over to another config file, but only + <br>This is where the {@link org.apache.juneau.ini.ConfigFile#merge(ConfigFile)} method comes into play. + <br>This method will copy the contents of one config file over to another config file, but only trigger listeners when the values are different. </p> <p> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/internal/IdentityList.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/IdentityList.java b/juneau-core/src/main/java/org/apache/juneau/internal/IdentityList.java index b3db4ba..7ddf361 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/IdentityList.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/IdentityList.java @@ -17,10 +17,12 @@ import java.util.*; /** * Combination of a {@link LinkedList} and <code>IdentitySet</code>. * <ul class='spaced-list'> - * <li>Duplicate objects (by identity) will be skipped during insertion. - * <li>Order of insertion maintained. + * <li> + * Duplicate objects (by identity) will be skipped during insertion. + * <li> + * Order of insertion maintained. * </ul> - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This class is NOT thread safe, and is intended for use on small lists. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/internal/KeywordSet.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/KeywordSet.java b/juneau-core/src/main/java/org/apache/juneau/internal/KeywordSet.java index fda08a5..831efbc 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/KeywordSet.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/KeywordSet.java @@ -19,8 +19,10 @@ import static org.apache.juneau.internal.ThrowableUtils.*; * <p> * Keywords must be: * <ul class='spaced-list'> - * <li>2 or more characters in length. - * <li>Lowercase ASCII. + * <li> + * 2 or more characters in length. + * <li> + * Lowercase ASCII. * </ul> */ public final class KeywordSet { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java index e777a2c..14d5345 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java @@ -60,7 +60,7 @@ public final class StringUtils { * Parses a number from the specified reader stream. * * @param r The reader to parse the string from. - * @param type The number type to created. <br> + * @param type The number type to created. * Can be any of the following: * <ul> * <li> Integer @@ -107,7 +107,7 @@ public final class StringUtils { * Parses a number from the specified string. * * @param s The string to parse the number from. - * @param type The number type to created. <br> + * @param type The number type to created. * Can be any of the following: * <ul> * <li> Integer http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java index c86e207..e18a513 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java @@ -41,42 +41,61 @@ import org.apache.juneau.transform.*; * This parser handles all valid JSON syntax. * In addition, when strict mode is disable, the parser also handles the following: * <ul class='spaced-list'> - * <li> Javascript comments (both {@code /*} and {@code //}) are ignored. - * <li> Both single and double quoted strings. - * <li> Automatically joins concatenated strings (e.g. <code><js>"aaa"</js> + <js>'bbb'</js></code>). - * <li> Unquoted attributes. + * <li> + * Javascript comments (both {@code /*} and {@code //}) are ignored. + * <li> + * Both single and double quoted strings. + * <li> + * Automatically joins concatenated strings (e.g. <code><js>"aaa"</js> + <js>'bbb'</js></code>). + * <li> + * Unquoted attributes. * </ul> * Also handles negative, decimal, hexadecimal, octal, and double numbers, including exponential notation. * <p> * This parser handles the following input, and automatically returns the corresponding Java class. * <ul class='spaced-list'> - * <li> JSON objects (<js>"{...}"</js>) are converted to {@link ObjectMap ObjectMaps}. <br> + * <li> + * JSON objects (<js>"{...}"</js>) are converted to {@link ObjectMap ObjectMaps}. * <b>Note:</b> If a <code><xa>_type</xa>=<xs>'xxx'</xs></code> attribute is specified on the object, then an * attempt is made to convert the object to an instance of the specified Java bean class. * See the <code>beanTypeName</code> setting on the {@link PropertyStore} for more information about parsing * beans from JSON. - * <li> JSON arrays (<js>"[...]"</js>) are converted to {@link ObjectList ObjectLists}. - * <li> JSON string literals (<js>"'xyz'"</js>) are converted to {@link String Strings}. - * <li> JSON numbers (<js>"123"</js>, including octal/hexadecimal/exponential notation) are converted to + * <li> + * JSON arrays (<js>"[...]"</js>) are converted to {@link ObjectList ObjectLists}. + * <li> + * JSON string literals (<js>"'xyz'"</js>) are converted to {@link String Strings}. + * <li> + * JSON numbers (<js>"123"</js>, including octal/hexadecimal/exponential notation) are converted to * {@link Integer Integers}, {@link Long Longs}, {@link Float Floats}, or {@link Double Doubles} depending on * whether the number is decimal, and the size of the number. - * <li> JSON booleans (<js>"false"</js>) are converted to {@link Boolean Booleans}. - * <li> JSON nulls (<js>"null"</js>) are converted to <jk>null</jk>. - * <li> Input consisting of only whitespace or JSON comments are converted to <jk>null</jk>. + * <li> + * JSON booleans (<js>"false"</js>) are converted to {@link Boolean Booleans}. + * <li> + * JSON nulls (<js>"null"</js>) are converted to <jk>null</jk>. + * <li> + * Input consisting of only whitespace or JSON comments are converted to <jk>null</jk>. * </ul> * <p> * Input can be any of the following: * <ul class='spaced-list'> - * <li> <js>"{...}"</js> - Converted to a {@link ObjectMap} or an instance of a Java bean if a <xa>_type</xa> + * <li> + * <js>"{...}"</js> - Converted to a {@link ObjectMap} or an instance of a Java bean if a <xa>_type</xa> * attribute is present. - * <li> <js>"[...]"</js> - Converted to a {@link ObjectList}. - * <li> <js>"123..."</js> - Converted to a {@link Number} (either {@link Integer}, {@link Long}, {@link Float}, + * <li> + * <js>"[...]"</js> - Converted to a {@link ObjectList}. + * <li> + * <js>"123..."</js> - Converted to a {@link Number} (either {@link Integer}, {@link Long}, {@link Float}, * or {@link Double}). - * <li> <js>"true"</js>/<js>"false"</js> - Converted to a {@link Boolean}. - * <li> <js>"null"</js> - Returns <jk>null</jk>. - * <li> <js>"'xxx'"</js> - Converted to a {@link String}. - * <li> <js>"\"xxx\""</js> - Converted to a {@link String}. - * <li> <js>"'xxx' + \"yyy\""</js> - Converted to a concatenated {@link String}. + * <li> + * <js>"true"</js>/<js>"false"</js> - Converted to a {@link Boolean}. + * <li> + * <js>"null"</js> - Returns <jk>null</jk>. + * <li> + * <js>"'xxx'"</js> - Converted to a {@link String}. + * <li> + * <js>"\"xxx\""</js> - Converted to a {@link String}. + * <li> + * <js>"'xxx' + \"yyy\""</js> - Converted to a concatenated {@link String}. * </ul> * <p> * TIP: If you know you're parsing a JSON object or array, it can be easier to parse it using the http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonParserContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonParserContext.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonParserContext.java index 949b64e..a498f9e 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonParserContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonParserContext.java @@ -25,12 +25,15 @@ import org.apache.juneau.parser.*; * * <h6 class='topic'>Inherited configurable properties</h6> * <ul class='doctree'> - * <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> + * <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> + * </li> * </ul> */ public final class JsonParserContext extends ParserContext { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java index 031017d..e97e64f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java @@ -36,15 +36,23 @@ import org.apache.juneau.transform.*; * <p> * The conversion is as follows... * <ul class='spaced-list'> - * <li>Maps (e.g. {@link HashMap HashMaps}, {@link TreeMap TreeMaps}) are converted to JSON objects. - * <li>Collections (e.g. {@link HashSet HashSets}, {@link LinkedList LinkedLists}) and Java arrays are converted to + * <li> + * Maps (e.g. {@link HashMap HashMaps}, {@link TreeMap TreeMaps}) are converted to JSON objects. + * <li> + * Collections (e.g. {@link HashSet HashSets}, {@link LinkedList LinkedLists}) and Java arrays are converted to * JSON arrays. - * <li>{@link String Strings} are converted to JSON strings. - * <li>{@link Number Numbers} (e.g. {@link Integer}, {@link Long}, {@link Double}) are converted to JSON numbers. - * <li>{@link Boolean Booleans} are converted to JSON booleans. - * <li>{@code nulls} are converted to JSON nulls. - * <li>{@code arrays} are converted to JSON arrays. - * <li>{@code beans} are converted to JSON objects. + * <li> + * {@link String Strings} are converted to JSON strings. + * <li> + * {@link Number Numbers} (e.g. {@link Integer}, {@link Long}, {@link Double}) are converted to JSON numbers. + * <li> + * {@link Boolean Booleans} are converted to JSON booleans. + * <li> + * {@code nulls} are converted to JSON nulls. + * <li> + * {@code arrays} are converted to JSON arrays. + * <li> + * {@code beans} are converted to JSON objects. * </ul> * <p> * The types above are considered "JSON-primitive" object types. Any non-JSON-primitive object types are transformed @@ -69,8 +77,10 @@ import org.apache.juneau.transform.*; * <p> * The following direct subclasses are provided for convenience: * <ul class='spaced-list'> - * <li>{@link Simple} - Default serializer, single quotes, simple mode. - * <li>{@link SimpleReadable} - Default serializer, single quotes, simple mode, with whitespace. + * <li> + * {@link Simple} - Default serializer, single quotes, simple mode. + * <li> + * {@link SimpleReadable} - Default serializer, single quotes, simple mode, with whitespace. * </ul> * * <h5 class='section'>Example:</h5> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java index a7539fe1..a75e895 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java @@ -63,7 +63,7 @@ public class JsonSerializerBuilder extends SerializerBuilder { * <p> * If <jk>true</jk>, JSON attribute names will only be quoted when necessary. * Otherwise, they are always quoted. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>JSON_simpleMode</jsf>, value)</code>. @@ -100,7 +100,7 @@ public class JsonSerializerBuilder extends SerializerBuilder { * The JSON specification allows for either format. * However, if you're embedding JSON in an HTML script tag, this setting prevents confusion when trying to * serialize <xt><\/script></xt>. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>JSON_escapeSolidus</jsf>, value)</code>. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerContext.java index 354fab0..f15f6ce 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerContext.java @@ -25,13 +25,15 @@ import org.apache.juneau.serializer.*; * * <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> + * <ul> + * <li class='jc'> + * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a> * - Configurable properties common to all serializers. - * </ul> + * </ul> + * </li> * </ul> */ public final class JsonSerializerContext extends SerializerContext { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java index 620ccf1..466017a 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java @@ -20,7 +20,7 @@ import org.apache.juneau.serializer.*; /** * Specialized writer for serializing JSON. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This class is not intended for external use. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java b/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java index 3a361ce..451d236 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java @@ -24,7 +24,8 @@ import java.lang.annotation.*; * <p> * Can be used for the following: * <ul class='spaced-list'> - * <li>Wrap bean instances inside wrapper object (e.g. <code>{'wrapperAttr':bean}</code>). + * <li> + * Wrap bean instances inside wrapper object (e.g. <code>{'wrapperAttr':bean}</code>). * </ul> */ @Documented http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/package.html ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/package.html b/juneau-core/src/main/java/org/apache/juneau/json/package.html index b06dc5b..59f6db2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/package.html +++ b/juneau-core/src/main/java/org/apache/juneau/json/package.html @@ -84,31 +84,36 @@ <div class='topic'> <p> Juneau supports converting arbitrary POJOs to and from JSON using ultra-efficient serializers and parsers. - <br> - The JSON serializer converts POJOs directly to JSON without the need for intermediate DOM objects using a + <br>The JSON serializer converts POJOs directly to JSON without the need for intermediate DOM objects using a highly-efficient state machine. - <br> - Likewise, the JSON parser creates POJOs directly from JSON without the need for intermediate DOM objects. + <br>Likewise, the JSON parser creates POJOs directly from JSON without the need for intermediate DOM objects. </p> <p> Juneau can serialize and parse instances of any of the following POJO types: </p> <ul class='spaced-list'> - <li>Java primitives and primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>, + <li> + Java primitives and primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>, <code>Float</code>). - <li>Java Collections Framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything on + <li> + Java Collections Framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything on this list. - <li>Multi-dimensional arrays of any type on this list. - <li>Java Beans with properties of any type on this list. - <li>Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing + <li> + Multi-dimensional arrays of any type on this list. + <li> + Java Beans with properties of any type on this list. + <li> + Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing <code>toString()</code>, <code>fromString()</code>, <code>valueOf()</code>, <code>constructor(String)</code>). - <li>Non-serializable classes and properties with associated <code>PojoSwaps</code> that convert them to + <li> + Non-serializable classes and properties with associated <code>PojoSwaps</code> that convert them to serializable forms. </ul> <p> Refer to <a href='../../../../overview-summary.html#Core.PojoCategories' class='doclink'>POJO Categories</a> for a complete definition of supported POJOs. </p> + <h6 class='topic'>Prerequisites</h6> <p> The Juneau JSON serialization and parsing support does not require any external prerequisites. @@ -122,8 +127,7 @@ <p> The example shown here is from the Address Book resource located in the <code>org.apache.juneau.sample.war</code> application. - <br> - The POJO model consists of a <code>List</code> of <code>Person</code> beans, with each <code>Person</code> + <br>The POJO model consists of a <code>List</code> of <code>Person</code> beans, with each <code>Person</code> containing zero or more <code>Address</code> beans. </p> <p> @@ -153,10 +157,14 @@ The JSON data type produced depends on the Java object type being serialized. </p> <ul class='spaced-list'> - <li>Primitives and primitive objects are converted to JSON primitives. - <li>Beans and Maps are converted to JSON objects. - <li>Collections and arrays are converted to JSON arrays. - <li>Anything else is converted to JSON strings. + <li> + Primitives and primitive objects are converted to JSON primitives. + <li> + Beans and Maps are converted to JSON objects. + <li> + Collections and arrays are converted to JSON arrays. + <li> + Anything else is converted to JSON strings. </ul> <h6 class='topic'>Examples:</h6> @@ -206,13 +214,15 @@ In addition, swaps can be used to convert non-serializable POJOs into serializable forms, such as converting <code>Calendar</code> object to ISO8601 strings, or <code><jk>byte</jk>[]</code> arrays to Base-64 encoded strings. - <br> - These swaps can be associated at various levels: + <br>These swaps can be associated at various levels: </p> <ul class='spaced-list'> - <li>On serializer and parser instances to handle all objects of the class type globally. - <li>On classes through the <code><ja>@Bean</ja></code> annotation. - <li>On bean properties through the <code><ja>@BeanProperty</ja></code> annotations. + <li> + On serializer and parser instances to handle all objects of the class type globally. + <li> + On classes through the <code><ja>@Bean</ja></code> annotation. + <li> + On bean properties through the <code><ja>@BeanProperty</ja></code> annotations. </ul> <p> For more information about transforms, refer to <a class='doclink' @@ -227,27 +237,27 @@ <div class='topic'> <p> {@link org.apache.juneau.json.JsonSerializer} is the class used to convert POJOs to JSON. - <br> - {@link org.apache.juneau.json.JsonSchemaSerializer} is the class used to generate JSON-Schema from POJOs. + <br>{@link org.apache.juneau.json.JsonSchemaSerializer} is the class used to generate JSON-Schema from POJOs. </p> <p> The JSON serializer includes several configurable settings. - <br> - Static reusable instances of Json serializers are provided with commonly-used settings: + <br>Static reusable instances of Json serializers are provided with commonly-used settings: </p> <ul class='spaced-list'> - <li>{@link org.apache.juneau.json.JsonSerializer#DEFAULT} - All default settings - <li>{@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX} - Single quotes, only quote attributes when + <li> + {@link org.apache.juneau.json.JsonSerializer#DEFAULT} - All default settings + <li> + {@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX} - Single quotes, only quote attributes when necessary. - <li>{@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX_READABLE} - Readable output. + <li> + {@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX_READABLE} - Readable output. </ul> + <h6 class='topic'>Notes about examples</h6> <p> The examples shown in this document will use single-quote, readable settings. - <br> - For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples. - <br> - In the real world, you'll typically want to use standard bean getters and setters. + <br>For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples. + <br>In the real world, you'll typically want to use standard bean getters and setters. </p> <p> To start off simple, we'll begin with the following simplified bean and build upon it. @@ -307,26 +317,26 @@ The {@link org.apache.juneau.annotation.Bean @Bean} and {@link org.apache.juneau.annotation.BeanProperty @BeanProperty} annotations are used to customize the behavior of beans across the entire framework. - <br> - They have various uses: + <br>They have various uses: </p> <ul class='spaced-list'> - <li>Hiding bean properties. - <li>Specifying the ordering of bean properties. - <li>Overriding the names of bean properties. - <li>Associating swaps at both the class and property level (to convert non-serializable POJOs to + <li> + Hiding bean properties. + <li> + Specifying the ordering of bean properties. + <li> + Overriding the names of bean properties. + <li> + Associating swaps at both the class and property level (to convert non-serializable POJOs to serializable forms). </ul> <p> For example, we now add a <code>birthDate</code> property, and associate a swap with it to transform it to an ISO8601 date-time string in GMT time. - <br> - We'll also add a couple of <code>URI</code> properties. - <br> - By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you want - them serialized. - <br> - Using swaps, we can convert them to standardized string forms. + <br>We'll also add a couple of <code>URI</code> properties. + <br>By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you + want them serialized. + <br>Using swaps, we can convert them to standardized string forms. </p> <p class='bcode'> <jk>public class</jk> Person { @@ -376,16 +386,17 @@ <p> Another useful feature is the {@link org.apache.juneau.annotation.Bean#propertyNamer()} annotation that allows you to plug in your own logic for determining bean property names. - <br> - The {@link org.apache.juneau.PropertyNamerDLC} is an example of an alternate property namer. + <br>The {@link org.apache.juneau.PropertyNamerDLC} is an example of an alternate property namer. It converts bean property names to lowercase-dashed format. </p> + <h6 class='topic'>Example:</h6> <p class='bcode'> <ja>@Bean</ja>(propertyNamer=PropertyNamerDLC.<jk>class</jk>) <jk>public class</jk> Person { ... </p> + <h6 class='figure'>Results</h6> <p class='bcode'> { @@ -484,10 +495,8 @@ <p> Juneau provides the {@link org.apache.juneau.json.JsonSchemaSerializer} class for generating JSON-Schema documents that describe the output generated by the {@link org.apache.juneau.json.JsonSerializer} class. - <br> - This class shares the same properties as <code>JsonSerializer</code>. - <br> - For convenience the {@link org.apache.juneau.json.JsonSerializer#getSchemaSerializer()} method has been + <br>This class shares the same properties as <code>JsonSerializer</code>. + <br>For convenience the {@link org.apache.juneau.json.JsonSerializer#getSchemaSerializer()} method has been added for creating instances of schema serializers from the regular serializer instance. </p> <p> @@ -555,6 +564,7 @@ <jc>// Get the JSON Schema corresponding to the JSON generated above.</jc> String jsonSchema = s.serialize(p); </p> + <h6 class='figure'>Results</h6> <p class='bcode'> { @@ -635,18 +645,15 @@ <div class='topic'> <p> The JSON serializer is designed to be used against POJO tree structures. - <br> - It expects that there not be loops in the POJO model (e.g. children with references to parents, etc...). - <br> - If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to + <br>It expects that there not be loops in the POJO model (e.g. children with references to parents, etc...). + <br>If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to be thrown (if {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_maxDepth} is not reached first). </p> <p> If you still want to use the JSON serializer on such models, Juneau provides the {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_detectRecursions} setting. - <br> - It tells the serializer to look for instances of an object in the current branch of the tree and skip + <br>It tells the serializer to look for instances of an object in the current branch of the tree and skip serialization when a duplicate is encountered. </p> <p> @@ -697,8 +704,7 @@ </p> <p> Recursion detection introduces a performance penalty of around 20%. - <br> - For this reason the setting is disabled by default. + <br>For this reason the setting is disabled by default. </p> </div> @@ -711,8 +717,10 @@ See the following classes for all configurable properties that can be used on this serializer: </p> <ul class='spaced-list'> - <li>{@link org.apache.juneau.BeanContext} - Bean context properties. - <li>{@link org.apache.juneau.json.JsonSerializerContext} - Serializer context properties. + <li> + {@link org.apache.juneau.BeanContext} - Bean context properties. + <li> + {@link org.apache.juneau.json.JsonSerializerContext} - Serializer context properties. </ul> </div> @@ -722,10 +730,10 @@ <h3 class='topic' onclick='toggle(this)'>2.6 - Other notes</h3> <div class='topic'> <ul class='spaced-list'> - <li>Like all other Juneau serializers, the JSON serializer is thread safe and maintains an internal cache + <li> + Like all other Juneau serializers, the JSON serializer is thread safe and maintains an internal cache of bean classes encountered. - <br> - For performance reasons, it's recommended that serializers be reused whenever possible instead of + <br>For performance reasons, it's recommended that serializers be reused whenever possible instead of always creating new instances. </ul> </div> @@ -743,11 +751,16 @@ The JSON parser supports ALL valid JSON, including: </p> <ul class='spaced-list'> - <li>Javascript comments. - <li>Single or double quoted values. - <li>Quoted (strict) or unquoted (non-strict) attributes. - <li>JSON fragments (such as string, numeric, or boolean primitive values). - <li>Concatenated strings. + <li> + Javascript comments. + <li> + Single or double quoted values. + <li> + Quoted (strict) or unquoted (non-strict) attributes. + <li> + JSON fragments (such as string, numeric, or boolean primitive values). + <li> + Concatenated strings. </ul> <p> A static reusable instance of <code>JsonParser</code> is also provided for convenience: @@ -757,8 +770,7 @@ </ul> <p> Let's build upon the previous example and parse the generated JSON back into the original bean. - <br> - We start with the JSON that was generated. + <br>We start with the JSON that was generated. </p> <p class='bcode'> <jc>// Use serializer with readable output, simple mode.</jc> @@ -847,8 +859,7 @@ <div class='topic'> <p> The JSON parser is not limited to parsing back into the original bean classes. - <br> - If the bean classes are not available on the parsing side, the parser can also be used to + <br>If the bean classes are not available on the parsing side, the parser can also be used to parse into a generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive objects. </p> @@ -856,8 +867,7 @@ You can parse into any <code>Map</code> type (e.g. <code>HashMap</code>, <code>TreeMap</code>), but using {@link org.apache.juneau.ObjectMap} is recommended since it has many convenience methods for converting values to various types. - <br> - The same is true when parsing collections. You can use any Collection (e.g. <code>HashSet</code>, + <br>The same is true when parsing collections. You can use any Collection (e.g. <code>HashSet</code>, <code>LinkedList</code>) or array (e.g. <code>Object[]</code>, <code>String[]</code>, <code>String[][]</code>), but using {@link org.apache.juneau.ObjectList} is recommended. </p> @@ -902,8 +912,7 @@ </p> <p> What we end up with is the exact same output. - <br> - Even the numbers and booleans are preserved because they are parsed into <code>Number</code> and + <br>Even the numbers and booleans are preserved because they are parsed into <code>Number</code> and <code>Boolean</code> objects when parsing into generic models. </p> <p class='bcode'> @@ -955,8 +964,7 @@ <p> As a general rule, parsing into beans is often more efficient than parsing into generic models. - <br> - And working with beans is often less error prone than working with generic models. + <br>And working with beans is often less error prone than working with generic models. </p> </div> @@ -969,8 +977,10 @@ See the following classes for all configurable properties that can be used on this parser: </p> <ul class='spaced-list'> - <li>{@link org.apache.juneau.BeanContext} - Bean context properties. - <li>{@link org.apache.juneau.json.JsonParserContext} - Serializer context properties. + <li> + {@link org.apache.juneau.BeanContext} - Bean context properties. + <li> + {@link org.apache.juneau.json.JsonParserContext} - Serializer context properties. </ul> </div> @@ -980,10 +990,10 @@ <h3 class='topic' onclick='toggle(this)'>3.3 - Other notes</h3> <div class='topic'> <ul class='spaced-list'> - <li>Like all other Juneau parsers, the JSON parser is thread safe and maintains an internal cache of bean + <li> + Like all other Juneau parsers, the JSON parser is thread safe and maintains an internal cache of bean classes encountered. - <br> - For performance reasons, it's recommended that parser be reused whenever possible instead of always + <br>For performance reasons, it's recommended that parser be reused whenever possible instead of always creating new instances. </ul> </div> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java index 13e52ad..2411636 100644 --- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java +++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java @@ -19,7 +19,7 @@ import java.io.*; /** * Specialized input stream for parsing MessagePack streams. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This class is not intended for external use. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java index 778a9f7..1760da6 100644 --- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java +++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java @@ -20,7 +20,7 @@ import java.util.concurrent.atomic.*; /** * Specialized output stream for serializing MessagePack streams. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This class is not intended for external use. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserContext.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserContext.java index aa83954..e221779 100644 --- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserContext.java @@ -25,12 +25,15 @@ import org.apache.juneau.parser.*; * * <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> + * <ul> + * <li class='jc'> + * <a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> * - Configurable properties common to all parsers. - * </ul> + * </ul> + * </li> * </ul> */ public final class MsgPackParserContext extends ParserContext { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerContext.java index 93348da..f0c6bb0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerContext.java @@ -25,13 +25,15 @@ import org.apache.juneau.serializer.*; * * <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 MsgPackSerializerContext extends SerializerContext { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/parser/Parser.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/Parser.java b/juneau-core/src/main/java/org/apache/juneau/parser/Parser.java index f646040..22a4a5b 100644 --- a/juneau-core/src/main/java/org/apache/juneau/parser/Parser.java +++ b/juneau-core/src/main/java/org/apache/juneau/parser/Parser.java @@ -110,13 +110,14 @@ import org.apache.juneau.utils.*; * <tr><th>JSON type</th><th>Class type</th></tr> * <tr><td>object</td><td>{@link ObjectMap}</td></tr> * <tr><td>array</td><td>{@link ObjectList}</td></tr> - * <tr><td>number</td><td>{@link Number} <br>(depending on length and format, could be {@link Integer}, + * <tr><td>number</td><td>{@link Number}<br>(depending on length and format, could be {@link Integer}, * {@link Double}, {@link Float}, etc...)</td></tr> * <tr><td>boolean</td><td>{@link Boolean}</td></tr> * <tr><td>string</td><td>{@link String}</td></tr> * </table> * - * <a id='SupportedTypes'></a><h6 class='topic'>Supported types</h6> + * <a id='SupportedTypes'></a> + * <h6 class='topic'>Supported types</h6> * <p> * Several of the methods below take {@link Type} parameters to identify the type of object to create. * Any of the following types can be passed in to these methods... @@ -255,7 +256,7 @@ public abstract class Parser extends CoreObject { * <code>Map</code> classes are assumed to be followed by zero or two meta objects indicating the key and value types. * <p> * The array can be arbitrarily long to indicate arbitrarily complex data structures. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>Use the {@link #parse(Object, Class)} method instead if you don't need a parameterized map/collection. @@ -306,6 +307,7 @@ public abstract class Parser extends CoreObject { * Same as {@link #parse(Object, Type, Type...)} except optimized for a non-parameterized class. * <p> * This is the preferred parse method for simple types since you don't need to cast the results. + * * <h5 class='section'>Examples:</h5> * <p class='bcode'> * ReaderParser p = JsonParser.<jsf>DEFAULT</jsf>; @@ -405,7 +407,8 @@ public abstract class Parser extends CoreObject { * <p> * Used in the following locations: * <ul class='spaced-list'> - * <li>The various character-based constructors in {@link ObjectMap} (e.g. + * <li> + * The various character-based constructors in {@link ObjectMap} (e.g. * {@link ObjectMap#ObjectMap(CharSequence,Parser)}). * </ul> * @@ -454,7 +457,8 @@ public abstract class Parser extends CoreObject { * <p> * Used in the following locations: * <ul class='spaced-list'> - * <li>The various character-based constructors in {@link ObjectList} (e.g. + * <li> + * The various character-based constructors in {@link ObjectList} (e.g. * {@link ObjectList#ObjectList(CharSequence,Parser)}. * </ul> * @@ -506,7 +510,8 @@ public abstract class Parser extends CoreObject { * <p> * Used in the following locations: * <ul class='spaced-list'> - * <li>Used to parse argument strings in the {@link PojoIntrospector#invokeMethod(Method, Reader)} method. + * <li> + * Used to parse argument strings in the {@link PojoIntrospector#invokeMethod(Method, Reader)} method. * </ul> * * @param input The input. Subclasses can support different input types. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/parser/ParserBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/ParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/parser/ParserBuilder.java index 9a8ee52..0f61126 100644 --- a/juneau-core/src/main/java/org/apache/juneau/parser/ParserBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/parser/ParserBuilder.java @@ -63,7 +63,7 @@ public class ParserBuilder extends CoreObjectBuilder { * <p> * If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to * the POJO. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>PARSER_trimStrings</jsf>, value)</code>. @@ -115,7 +115,7 @@ public class ParserBuilder extends CoreObjectBuilder { * </td> * </tr> * </table> - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>PARSER_strict</jsf>,value)</code>. @@ -151,7 +151,7 @@ public class ParserBuilder extends CoreObjectBuilder { * The character set to use for converting <code>InputStreams</code> and byte arrays to readers. * <p> * Used when passing in input streams and byte arrays to {@link Parser#parse(Object, Class)}. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>PARSER_inputStreamCharset</jsf>, value)</code>. @@ -180,7 +180,7 @@ public class ParserBuilder extends CoreObjectBuilder { * Used when passing in files to {@link Parser#parse(Object, Class)}. * <p> * <js>"default"</js> can be used to indicate the JVM default file system charset. - * <p> + * * <h5 class='section'>Notes:</h5> * <ul> * <li>This is equivalent to calling <code>property(<jsf>PARSER_fileCharset</jsf>,value)</code>. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroup.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroup.java b/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroup.java index 65dcb94..f429b6f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroup.java +++ b/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroup.java @@ -25,10 +25,14 @@ import org.apache.juneau.http.*; * <p> * 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> * * <h6 class='topic'>Match ordering</h6>
