You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/06/26 00:41:16 UTC
[01/23] incubator-juneau git commit: Clean up javadocs.
Repository: incubator-juneau
Updated Branches:
refs/heads/master 542fb4866 -> 5c4762eed
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-releng/eclipse-preferences/user-dictionary.txt
----------------------------------------------------------------------
diff --git a/juneau-releng/eclipse-preferences/user-dictionary.txt b/juneau-releng/eclipse-preferences/user-dictionary.txt
index 4db9ef8..d70844a 100644
--- a/juneau-releng/eclipse-preferences/user-dictionary.txt
+++ b/juneau-releng/eclipse-preferences/user-dictionary.txt
@@ -71,3 +71,345 @@ serializers
mybeans
serializer
foobar
+metadata
+scratchpads
+int
+serializable
+overridable
+arg
+introspector
+specs
+subpackages
+config
+timezone
+genericized
+hashmap
+dyna
+souped
+impl
+struct
+prev
+covariant
+superclasses
+nutshell
+multi
+args
+enum
+bm
+metas
+op
+classloader
+swappable
+unswap
+init
+enums
+charset
+stateless
+typecasting
+accessor
+iterable
+lowercase
+def
+decapitalize
+cacheable
+classpath
+ps
+bc
+hashcode
+scratchpad
+appendable
+uri
+relativize
+relativizes
+relativized
+mod
+javadocs
+subtypes
+doctree
+mytype
+jackson
+params
+jane
+doe
+hyperlink
+codepoint
+sublink
+jp
+rel
+hreflang
+en
+em
+logo
+timestamp
+xhtml
+src
+marshalling
+namespaces
+sq
+janesmith
+namespace
+xmlabbrev
+bognar
+barry
+caceres
+mpeg
+div
+xmlns
+fín
+cognos
+dataset
+barack
+obama
+george
+ds
+abbr
+coords
+bdi
+bdo
+dir
+blockquote
+br
+col
+colgroup
+datalist
+dd
+del
+dfn
+dl
+dt
+fieldset
+figcaption
+hr
+iframe
+img
+kbd
+keygen
+li
+nav
+noscript
+ol
+optgroup
+param
+pre
+rb
+rp
+rt
+rtc
+samp
+tbody
+td
+textarea
+tfoot
+th
+thead
+tr
+ul
+var
+wbr
+attr
+xxx
+readonly
+usemap
+pragma
+ordinality
+playback
+onmouseover
+mydiv
+myform
+mytable
+ref
+htmldoc
+req
+csv
+ssv
+tsv
+http
+https
+ws
+wss
+urlencoded
+www
+templating
+payload
+multipart
+discriminator
+spec
+docs
+website
+gzip
+nls
+hyperlinks
+stylesheet
+css
+subclassed
+outerdata
+subtype
+htdocs
+metamodel
+metamodels
+costas
+billy
+barney
+dvi
+jpeg
+extlink
+qvalue
+utf
+unicode
+iso
+deflate
+qvalues
+danish
+da
+gb
+maxage
+revalidate
+min
+waitangi
+maori
+mi
+octets
+resp
+pos
+nov
+gif
+byteranges
+orig
+gatewayed
+revalidating
+validator
+xyzzy
+thu
+dec
+org
+webmaster
+oct
+inbound
+lowercased
+outbound
+referer
+sic
+libwww
+demoted
+chunked
+websocket
+firefox
+gecko
+rv
+mozilla
+uncacheable
+fred
+pseudonym
+firewall
+ricky
+ethel
+lucy
+mertz
+pseudonyms
+val
+datatype
+cf
+configfile
+envfile
+vals
+batchfile
+unencoded
+duper
+println
+generics
+mkdirs
+locales
+myobject
+com
+iterables
+superinterfaces
+tee
+javascript
+aaa
+bbb
+yyy
+xyz
+birthdate
+fixint
+fixmap
+fixarray
+fixstr
+ext
+uint
+fixext
+str
+neg
+fixnum
+endian
+cont
+msgpack
+myproxy
+mymethod
+pojo
+parsable
+instanceof
+vars
+myproperty
+mf
+reconstitute
+yyyy
+uon
+anywhereville
+differentiable
+ultra
+colspan
+seg
+pp
+andandand
+ororor
+zzz
+fico
+cmd
+ls
+pb
+ns
+losslessly
+lossless
+ab
+addr
+microservices
+traversable
+queryable
+introspectable
+cookbook
+pg
+servlets
+centric
+aug
+discoverable
+zipped
+jetty
+subpath
+cp
+ca
+cm
+globalizable
+hussein
+jul
+rd
+crawford
+tumblr
+blog
+sql
+rs
+concat
+ss
+se
+cloudant
+apr
+feb
+jan
+sept
+jun
+iter
+onload
+lang
+etag
+throwables
+callable
+urlencoding
[04/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java
index e7d1e4c..f2397b7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java
@@ -23,8 +23,8 @@ import org.apache.juneau.json.*;
import org.apache.juneau.parser.*;
/**
- * Provides the ability to perform standard REST operations (GET, PUT, POST, DELETE) against
- * nodes in a POJO model. Nodes in the POJO model are addressed using URLs.
+ * Provides the ability to perform standard REST operations (GET, PUT, POST, DELETE) against nodes in a POJO model.
+ * Nodes in the POJO model are addressed using URLs.
* <p>
* A POJO model is defined as a tree model where nodes consist of consisting of the following:
* <ul class='spaced-list'>
@@ -35,12 +35,16 @@ import org.apache.juneau.parser.*;
* <p>
* Leaves of the tree can be any type of object.
* <p>
- * Use {@link #get(String) get()} to retrieve an element from a JSON tree.<br>
- * Use {@link #put(String,Object) put()} to create (or overwrite) an element in a JSON tree.<br>
- * Use {@link #post(String,Object) post()} to add an element to a list in a JSON tree.<br>
- * Use {@link #delete(String) delete()} to remove an element from a JSON tree.<br>
+ * Use {@link #get(String) get()} to retrieve an element from a JSON tree.
+ * <br>
+ * Use {@link #put(String,Object) put()} to create (or overwrite) an element in a JSON tree.
+ * <br>
+ * Use {@link #post(String,Object) post()} to add an element to a list in a JSON tree.
+ * <br>
+ * Use {@link #delete(String) delete()} to remove an element from a JSON tree.
* <p>
- * Leading slashes in URLs are ignored. So <js>"/xxx/yyy/zzz"</js> and <js>"xxx/yyy/zzz"</js> are considered identical.
+ * Leading slashes in URLs are ignored.
+ * So <js>"/xxx/yyy/zzz"</js> and <js>"xxx/yyy/zzz"</js> are considered identical.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -102,8 +106,9 @@ import org.apache.juneau.parser.*;
* );
* johnSmith.put(<js>"additionalInfo/medicalInfo"</js>, medicalInfo);
* <p>
- * In the special case of collections/arrays of maps/beans, a special XPath-like selector notation
- * can be used in lieu of index numbers on GET requests to return a map/bean with a specified attribute value.<br>
+ * In the special case of collections/arrays of maps/beans, a special XPath-like selector notation can be used in lieu
+ * of index numbers on GET requests to return a map/bean with a specified attribute value.
+ * <br>
* The syntax is {@code @attr=val}, where attr is the attribute name on the child map, and val is the matching value.
*
* <h5 class='section'>Example:</h5>
@@ -155,7 +160,7 @@ public final class PojoRest {
}
/**
- * Call this method to prevent the root object from being overwritten on put("", xxx); calls.
+ * Call this method to prevent the root object from being overwritten on <code>put("", xxx);</code> calls.
*
* @return This object (for method chaining).
*/
@@ -223,7 +228,6 @@ public final class PojoRest {
* If null or blank, returns the root.
* @param def The default value if addressed item does not exist.
* @param <T> The specified object type.
- *
* @return The addressed element, or null if that element does not exist in the tree.
*/
public <T> T get(Class<T> type, String url, T def) {
@@ -461,30 +465,33 @@ public final class PojoRest {
* </ul>
* <p>
* As a rule, use the simplest format needed to uniquely resolve a method.
- * @param args The arguments to pass as parameters to the method.<br>
- * These will automatically be converted to the appropriate object type if possible.<br>
+ * @param args The arguments to pass as parameters to the method.
+ * These will automatically be converted to the appropriate object type if possible.
* This must be an array, like a JSON array.
* @return The returned object from the method call.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is inaccessible.
+ * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
+ * the underlying constructor is inaccessible.
* @throws IllegalArgumentException If one of the following occurs:
- * <ul class='spaced-list'>
- * <li>The number of actual and formal parameters differ.
- * <li>An unwrapping conversion for primitive arguments fails.
- * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion.
- * <li>The constructor pertains to an enum type.
- * </ul>
+ * <ul class='spaced-list'>
+ * <li>The number of actual and formal parameters differ.
+ * <li>An unwrapping conversion for primitive arguments fails.
+ * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
+ * conversion.
+ * <li>The constructor pertains to an enum type.
+ * </ul>
* @throws InvocationTargetException If the underlying constructor throws an exception.
* @throws ParseException If the input contains a syntax error or is malformed.
* @throws NoSuchMethodException
* @throws IOException
*/
- public Object invokeMethod(String url, String method, String args) throws InvocationTargetException, IllegalArgumentException, IllegalAccessException, ParseException, NoSuchMethodException, IOException {
+ public Object invokeMethod(String url, String method, String args) throws InvocationTargetException,
+ IllegalArgumentException, IllegalAccessException, ParseException, NoSuchMethodException, IOException {
return new PojoIntrospector(get(url), parser).invokeMethod(method, args);
}
/**
- * Returns the list of available methods that can be passed to the {@link #invokeMethod(String, String, String)} for the object
- * addressed by the specified URL.
+ * Returns the list of available methods that can be passed to the {@link #invokeMethod(String, String, String)}
+ * for the object addressed by the specified URL.
*
* @param url The URL.
* @return The list of methods.
@@ -543,7 +550,7 @@ public final class PojoRest {
* </ul>
*
* @param url The URL of the element being added to.
- * <br>If <jk>null</jk> or blank, the root itself (assuming it's one of the types specified above) is added to.
+ * If <jk>null</jk> or blank, the root itself (assuming it's one of the types specified above) is added to.
* @param val The value being added.
* @return The URL of the element that was added.
*/
@@ -554,7 +561,7 @@ public final class PojoRest {
/**
* Remove an element from a POJO model.
* <p>
- * qIf the element does not exist, no action is taken.
+ * If the element does not exist, no action is taken.
*
* @param url The URL of the element being deleted.
* If <jk>null</jk> or blank, the root itself is deleted.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java
index 318ec02..8e7569b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java
@@ -24,9 +24,12 @@ import org.apache.juneau.*;
* <p>
* The status code is an HTTP-equivalent code. It will be one of the following:
* <ul class='spaced-list'>
- * <li>{@link HttpURLConnection#HTTP_BAD_REQUEST HTTP_BAD_REQUEST} - Attempting to do something impossible.
- * <li>{@link HttpURLConnection#HTTP_NOT_FOUND HTTP_NOT_FOUND} - Attempting to access a non-existent node in the tree.
- * <li>{@link HttpURLConnection#HTTP_FORBIDDEN HTTP_FORBIDDEN} - Attempting to overwrite the root object.
+ * <li>{@link HttpURLConnection#HTTP_BAD_REQUEST HTTP_BAD_REQUEST}
+ * - Attempting to do something impossible.
+ * <li>{@link HttpURLConnection#HTTP_NOT_FOUND HTTP_NOT_FOUND}
+ * - Attempting to access a non-existent node in the tree.
+ * <li>{@link HttpURLConnection#HTTP_FORBIDDEN HTTP_FORBIDDEN}
+ * - Attempting to overwrite the root object.
* </ul>
*/
public final class PojoRestException extends FormattedRuntimeException {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/ProcBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/ProcBuilder.java b/juneau-core/src/main/java/org/apache/juneau/utils/ProcBuilder.java
index d44831f..6cdf495 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/ProcBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/ProcBuilder.java
@@ -72,11 +72,11 @@ public class ProcBuilder {
/**
* Command arguments if the specified matcher matches.
- * Can be used for specifying os-specific commands.
+ * Can be used for specifying OS-specific commands.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
- * ProcessBuilder pb = ProcessBuilder
+ * ProcBuilder pb = ProcBuilder
* .create()
* .commandIf(<jsf>WINDOWS</jsf>, <js>"cmd /c dir"</js>)
* .commandIf(<jsf>UNIX</jsf>, <js>"bash -c ls"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/SearchArgs.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/SearchArgs.java b/juneau-core/src/main/java/org/apache/juneau/utils/SearchArgs.java
index b44297a..e8371da 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/SearchArgs.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/SearchArgs.java
@@ -40,6 +40,7 @@ public class SearchArgs {
/**
* Creates a new builder for {@link SearchArgs}
+ *
* @return A new builder for {@link SearchArgs}
*/
public static Builder builder() {
@@ -72,7 +73,7 @@ public class SearchArgs {
* Whitespace is trimmed from column names and search tokens.
*
* @param searchTerms The search terms string.
- * Can be <jk>null</jk>.
+ * Can be <jk>null</jk>.
* @return This object (for method chaining).
*/
public Builder search(String searchTerms) {
@@ -117,7 +118,7 @@ public class SearchArgs {
* Empty view columns imply view all columns.
*
* @param columns The columns being viewed.
- * Can be <jk>null</jk>.
+ * Can be <jk>null</jk>.
* @return This object (for method chaining).
*/
public Builder view(String columns) {
@@ -157,7 +158,7 @@ public class SearchArgs {
* Whitespace is trimmed from column names.
*
* @param sortArgs The columns to sort by.
- * Can be <jk>null</jk>.
+ * Can be <jk>null</jk>.
* @return This object (for method chaining).
*/
public Builder sort(String sortArgs) {
@@ -175,7 +176,7 @@ public class SearchArgs {
* Note that the order of the sort is important.
*
* @param sortArgs The columns to sort by.
- * Can be <jk>null</jk>.
+ * Can be <jk>null</jk>.
* @return This object (for method chaining).
*/
public Builder sort(Collection<String> sortArgs) {
@@ -205,7 +206,7 @@ public class SearchArgs {
* Specifies the number of rows to return.
*
* @param limit The number of rows to return.
- * If <code><=0</code>, all rows should be returned.
+ * If <code><=0</code>, all rows should be returned.
* @return This object (for method chaining).
*/
public Builder limit(int limit) {
@@ -279,7 +280,7 @@ public class SearchArgs {
* The first-row position.
*
* @return The zero-indexed row number of the first row to display.
- * Default is <code>0</code>
+ * Default is <code>0</code>
*/
public int getPosition() {
return position;
@@ -289,7 +290,7 @@ public class SearchArgs {
* The number of rows to return.
*
* @return The number of rows to return in the result.
- * Default is <code>0</code> which means return all rows.
+ * Default is <code>0</code> which means return all rows.
*/
public int getLimit() {
return limit;
@@ -301,7 +302,7 @@ public class SearchArgs {
* Used in conjunction with {@link #getSearch()} to specify whether case-insensitive searches should be performed.
*
* @return The number of rows to return in the result.
- * Default is <jk>false</jk>.
+ * Default is <jk>false</jk>.
*/
public boolean isIgnoreCase() {
return ignoreCase;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/StringObject.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/StringObject.java b/juneau-core/src/main/java/org/apache/juneau/utils/StringObject.java
index 169d20e..7198b26 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/StringObject.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/StringObject.java
@@ -40,6 +40,7 @@ public class StringObject implements CharSequence, Writable {
/**
* Constructor.
+ *
* @param s The serializer to use to serialize the object.
* @param o The object to be serialized.
*/
@@ -50,6 +51,7 @@ public class StringObject implements CharSequence, Writable {
/**
* Constructor with default serializer {@link JsonSerializer#DEFAULT_LAX}
+ *
* @param o The object to be serialized.
*/
public StringObject(Object o) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/ZipFileList.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/ZipFileList.java b/juneau-core/src/main/java/org/apache/juneau/utils/ZipFileList.java
index 17bcd6c..9d6d6f9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/ZipFileList.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/ZipFileList.java
@@ -17,12 +17,11 @@ import java.util.*;
import java.util.zip.*;
/**
- * Utility class for representing the contents of a zip file as a list of entries
- * whose contents don't resolve until serialize time.
+ * Utility class for representing the contents of a zip file as a list of entries whose contents don't resolve until
+ * serialization time.
* <p>
- * Generally associated with <code>RestServlets</code> using the <code>responseHandlers</code>
- * annotation so that REST methods can easily create ZIP file responses by simply returning instances
- * of this class.
+ * Generally associated with <code>RestServlets</code> using the <code>responseHandlers</code> annotation so that
+ * REST methods can easily create ZIP file responses by simply returning instances of this class.
*/
@SuppressWarnings("serial")
public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/Namespace.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/Namespace.java b/juneau-core/src/main/java/org/apache/juneau/xml/Namespace.java
index d8f4a76..dc775e6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/Namespace.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/Namespace.java
@@ -17,8 +17,8 @@ import org.apache.juneau.annotation.*;
/**
* Represents a simple namespace mapping between a simple name and URI.
* <p>
- * In general, the simple name will be used as the XML prefix mapping unless
- * there are conflicts or prefix remappings in the serializer.
+ * In general, the simple name will be used as the XML prefix mapping unless there are conflicts or prefix
+ * re-mappings in the serializer.
*/
@Bean(sort=true)
public final class Namespace implements Comparable<Namespace> {
@@ -67,8 +67,8 @@ public final class Namespace implements Comparable<Namespace> {
}
/**
- * For performance reasons, equality is always based on identity, since
- * the {@link NamespaceFactory} class ensures no duplicate name+uri pairs.
+ * For performance reasons, equality is always based on identity, since the {@link NamespaceFactory} class ensures
+ * no duplicate name+uri pairs.
*/
@Override /* Object */
public boolean equals(Object o) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java b/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java
index 52fe1ea..31f9cc7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java
@@ -24,7 +24,7 @@ import org.apache.juneau.parser.*;
* <p>
* For performance reasons, {@link Namespace} objects are stored in {@link IdentityList IdentityLists}.
* For this to work property, namespaces with the same name and URI must only be represented by a single
- * {@link Namespace} instance.
+ * {@link Namespace} instance.
* This factory class ensures this identity uniqueness.
*/
public final class NamespaceFactory {
@@ -32,8 +32,8 @@ public final class NamespaceFactory {
private static ConcurrentHashMap<String,Namespace> cache = new ConcurrentHashMap<String,Namespace>();
/**
- * Get the {@link Namespace} with the specified name and URI, and create a new one
- * if this is the first time it's been encountered.
+ * Get the {@link Namespace} with the specified name and URI, and create a new one if this is the first time it's
+ * been encountered.
*
* @param name The namespace name. See {@link Namespace#getName()}.
* @param uri The namespace URI. See {@link Namespace#getUri()}.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
index ed7ebb8..ad489fa 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
@@ -20,7 +20,8 @@ import org.apache.juneau.*;
import org.apache.juneau.xml.annotation.*;
/**
- * Metadata on beans specific to the XML serializers and parsers pulled from the {@link Xml @Xml} annotation on the class.
+ * Metadata on beans specific to the XML serializers and parsers pulled from the {@link Xml @Xml} annotation on the
+ * class.
*/
public class XmlBeanMeta extends BeanMetaExtended {
@@ -250,7 +251,8 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* Returns bean property meta with the specified name.
* This is identical to calling {@link BeanMeta#getPropertyMeta(String)} except it first retrieves
- * the bean property meta based on the child name (e.g. a property whose name is "people", but whose child name is "person").
+ * the bean property meta based on the child name (e.g. a property whose name is "people", but whose child name is
+ * "person").
*
* @param fieldName The bean property name.
* @return The property metadata.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
index 5e869cf..ad34afb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
@@ -18,7 +18,8 @@ import org.apache.juneau.*;
import org.apache.juneau.xml.annotation.*;
/**
- * Metadata on bean properties specific to the XML serializers and parsers pulled from the {@link Xml @Xml} annotation on the bean property.
+ * Metadata on bean properties specific to the XML serializers and parsers pulled from the {@link Xml @Xml} annotation
+ * on the bean property.
*/
public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
@@ -61,8 +62,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
* <li>{@link Xml#prefix()} annotation defined on bean interface packages.
* </ol>
*
- * @return The namespace associated with this bean property, or <jk>null</jk> if no namespace is
- * associated with it.
+ * @return The namespace associated with this bean property, or <jk>null</jk> if no namespace is associated with it.
*/
public Namespace getNamespace() {
return namespace;
@@ -105,7 +105,8 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
String cen = xml.childName();
if ((! cen.isEmpty()) && (! isCollection))
- throw new BeanRuntimeException(cmProperty.getInnerClass(), "Annotation error on property ''{0}''. @Xml.childName can only be specified on collections and arrays.", name);
+ throw new BeanRuntimeException(cmProperty.getInnerClass(),
+ "Annotation error on property ''{0}''. @Xml.childName can only be specified on collections and arrays.", name);
if (xmlFormat == XmlFormat.COLLAPSED) {
if (isCollection) {
@@ -116,7 +117,8 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
if (cen == null || cen.isEmpty())
cen = name;
} else {
- throw new BeanRuntimeException(cmBean.getInnerClass(), "Annotation error on property ''{0}''. @Xml.format=COLLAPSED can only be specified on collections and arrays.", name);
+ throw new BeanRuntimeException(cmBean.getInnerClass(),
+ "Annotation error on property ''{0}''. @Xml.format=COLLAPSED can only be specified on collections and arrays.", name);
}
if (cen.isEmpty() && isCollection)
cen = cmProperty.getDictionaryName();
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlClassMeta.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
index 8624c43..395bc80 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
@@ -23,7 +23,8 @@ import org.apache.juneau.internal.*;
import org.apache.juneau.xml.annotation.*;
/**
- * Metadata on classes specific to the XML serializers and parsers pulled from the {@link Xml @Xml} annotation on the class.
+ * Metadata on classes specific to the XML serializers and parsers pulled from the {@link Xml @Xml} annotation on the
+ * class.
*/
public class XmlClassMeta extends ClassMetaExtended {
@@ -55,7 +56,8 @@ public class XmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Xml} annotation defined on the class.
*
- * @return The value of the {@link Xml} annotation defined on the class, or <jk>null</jk> if annotation is not specified.
+ * @return The value of the {@link Xml} annotation defined on the class, or <jk>null</jk> if annotation is not
+ * specified.
*/
protected Xml getAnnotation() {
return xml;
@@ -92,8 +94,7 @@ public class XmlClassMeta extends ClassMetaExtended {
* <li>{@link Xml#prefix()} annotation defined on interface packages.
* </ol>
*
- * @return The namespace associated with this class, or <jk>null</jk> if no namespace is
- * associated with it.
+ * @return The namespace associated with this class, or <jk>null</jk> if no namespace is associated with it.
*/
protected Namespace getNamespace() {
return namespace;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
index 0d4a9d2..b26f025 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
@@ -29,8 +29,8 @@ import org.apache.juneau.serializer.*;
*
* <h5 class='section'>Description:</h5>
* <p>
- * Same as {@link XmlSerializer}, except prepends <code><xt><?xml</xt> <xa>version</xa>=<xs>'1.0'</xs> <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?></xt></code> to the response
- * to make it a valid XML document.
+ * Same as {@link XmlSerializer}, except prepends <code><xt><?xml</xt> <xa>version</xa>=<xs>'1.0'</xs>
+ * <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?></xt></code> to the response to make it a valid XML document.
*
*/
public class XmlDocSerializer extends XmlSerializer {
@@ -41,6 +41,7 @@ public class XmlDocSerializer extends XmlSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public Ns(PropertyStore propertyStore) {
@@ -55,6 +56,7 @@ public class XmlDocSerializer extends XmlSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public XmlDocSerializer(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParser.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParser.java
index f1d24d2..c4f4d35 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParser.java
@@ -62,6 +62,7 @@ public class XmlParser extends ReaderParser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public XmlParser(PropertyStore propertyStore) {
@@ -87,7 +88,8 @@ public class XmlParser extends ReaderParser {
* @return The parsed object.
* @throws Exception
*/
- protected <T> T parseAnything(XmlParserSession session, ClassMeta<T> eType, String currAttr, XMLStreamReader r, Object outer, boolean isRoot, BeanPropertyMeta pMeta) throws Exception {
+ protected <T> T parseAnything(XmlParserSession session, ClassMeta<T> eType, String currAttr, XMLStreamReader r,
+ Object outer, boolean isRoot, BeanPropertyMeta pMeta) throws Exception {
if (eType == null)
eType = (ClassMeta<T>)object();
@@ -180,7 +182,9 @@ public class XmlParser extends ReaderParser {
} else if (sType.canCreateNewInstanceFromNumber(outer)) {
o = sType.newInstanceFromNumber(session, outer, parseNumber(session.getElementText(r), sType.getNewInstanceFromNumberClass()));
} else {
- throw new ParseException(session, "Class ''{0}'' could not be instantiated. Reason: ''{1}'', property: ''{2}''", sType.getInnerClass().getName(), sType.getNotABeanReason(), pMeta == null ? null : pMeta.getName());
+ throw new ParseException(session,
+ "Class ''{0}'' could not be instantiated. Reason: ''{1}'', property: ''{2}''",
+ sType.getInnerClass().getName(), sType.getNotABeanReason(), pMeta == null ? null : pMeta.getName());
}
if (transform != null && o != null)
@@ -192,7 +196,8 @@ public class XmlParser extends ReaderParser {
return (T)o;
}
- private <K,V> Map<K,V> parseIntoMap(XmlParserSession session, XMLStreamReader r, Map<K,V> m, ClassMeta<K> keyType, ClassMeta<V> valueType, BeanPropertyMeta pMeta) throws Exception {
+ private <K,V> Map<K,V> parseIntoMap(XmlParserSession session, XMLStreamReader r, Map<K,V> m, ClassMeta<K> keyType,
+ ClassMeta<V> valueType, BeanPropertyMeta pMeta) throws Exception {
int depth = 0;
for (int i = 0; i < r.getAttributeCount(); i++) {
String a = r.getAttributeLocalName(i);
@@ -230,7 +235,8 @@ public class XmlParser extends ReaderParser {
return m;
}
- private <E> Collection<E> parseIntoCollection(XmlParserSession session, XMLStreamReader r, Collection<E> l, ClassMeta<?> type, BeanPropertyMeta pMeta) throws Exception {
+ private <E> Collection<E> parseIntoCollection(XmlParserSession session, XMLStreamReader r, Collection<E> l,
+ ClassMeta<?> type, BeanPropertyMeta pMeta) throws Exception {
int depth = 0;
int argIndex = 0;
do {
@@ -497,7 +503,8 @@ public class XmlParser extends ReaderParser {
//--------------------------------------------------------------------------------
@Override /* Parser */
- public XmlParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public XmlParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale,
+ TimeZone timeZone, MediaType mediaType) {
return new XmlParserSession(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
index eaf97f8..8e1a348 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
@@ -37,6 +37,7 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public XmlParserBuilder(PropertyStore propertyStore) {
@@ -66,7 +67,8 @@ public class XmlParserBuilder extends ParserBuilder {
* If <jk>true</jk>, XML document will be validated.
* See {@link XMLInputFactory#IS_VALIDATING} for more info.
* <p>
- * If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to the POJO.
+ * 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>
@@ -98,7 +100,8 @@ public class XmlParserBuilder extends ParserBuilder {
* <li>Reporters are not copied to new parsers during a clone.
* </ul>
* <p>
- * If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to the POJO.
+ * 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>
@@ -125,7 +128,8 @@ public class XmlParserBuilder extends ParserBuilder {
* <p>
* Associates an {@link XMLResolver} with this parser.
* <p>
- * If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to the POJO.
+ * 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>
@@ -152,7 +156,8 @@ public class XmlParserBuilder extends ParserBuilder {
* <p>
* Associates an {@link XMLEventAllocator} with this parser.
* <p>
- * If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to the POJO.
+ * 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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java
index 6c56276..d7f36fc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java
@@ -28,9 +28,11 @@ 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.
+ * <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.
+ * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
+ * - Configurable properties common to all parsers.
* </ul>
* </ul>
*/
@@ -108,9 +110,9 @@ public class XmlParserContext extends ParserContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * If <jk>true</jk>, when parsing into a generic {@link ObjectMap}, the map will
- * contain a single entry whose key is the root element name.
- *
+ * If <jk>true</jk>, when parsing into a generic {@link ObjectMap}, the map will contain a single entry whose key
+ * is the root element name.
+ * <p>
* Example:
* <table class='styled'>
* <tr>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserSession.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserSession.java
index 098c5ee..c903421 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserSession.java
@@ -50,13 +50,13 @@ public class XmlParserSession extends ParserSession {
* @param ctx The context creating this session object.
* The context contains all the configuration settings for this object.
* @param input The input. Can be any of the following types:
- * <ul>
- * <li><jk>null</jk>
- * <li>{@link Reader}
- * <li>{@link CharSequence}
- * <li>{@link InputStream} containing UTF-8 encoded text.
- * <li>{@link File} containing system encoded text.
- * </ul>
+ * <ul>
+ * <li><jk>null</jk>
+ * <li>{@link Reader}
+ * <li>{@link CharSequence}
+ * <li>{@link InputStream} containing UTF-8 encoded text.
+ * <li>{@link File} containing system encoded text.
+ * </ul>
* @param op The override properties.
* These override any context properties defined in the context.
* @param javaMethod The java method that called this parser, usually the method in a REST servlet.
@@ -67,7 +67,8 @@ public class XmlParserSession extends ParserSession {
* If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
*/
- public XmlParserSession(XmlParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public XmlParserSession(XmlParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer,
+ Locale locale, TimeZone timeZone, MediaType mediaType) {
super(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);
if (op == null || op.isEmpty()) {
validating = ctx.validating;
@@ -257,8 +258,8 @@ public class XmlParserSession extends ParserSession {
/**
* Parses the current element as text.
- * Note that this is different than {@link #getText(XMLStreamReader)} since it
- * assumes that we're pointing to a whitespace element.
+ * Note that this is different than {@link #getText(XMLStreamReader)} since it assumes that we're pointing to a
+ * whitespace element.
*
* @param r
* @return The parsed text.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
index 5036bf8..edab0e4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
@@ -26,8 +26,8 @@ import org.apache.juneau.serializer.*;
*
* <h5 class='section'>Description:</h5>
* <p>
- * Same as {@link XmlSchemaSerializer}, except prepends <code><xt><?xml</xt> <xa>version</xa>=<xs>'1.0'</xs> <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?></xt></code> to the response
- * to make it a valid XML document.
+ * Same as {@link XmlSchemaSerializer}, except prepends <code><xt><?xml</xt> <xa>version</xa>=<xs>'1.0'</xs>
+ * <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?></xt></code> to the response to make it a valid XML document.
*/
public class XmlSchemaDocSerializer extends XmlSchemaSerializer {
@@ -37,6 +37,7 @@ public class XmlSchemaDocSerializer extends XmlSchemaSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public XmlSchemaDocSerializer(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
index 8a06047..ab93ce9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
@@ -61,6 +61,7 @@ public class XmlSchemaSerializer extends XmlSerializer {
/**
* Constructor.
+ *
* @param propertyStore Initialize with the specified config property store.
*/
public XmlSchemaSerializer(PropertyStore propertyStore) {
@@ -69,6 +70,7 @@ public class XmlSchemaSerializer extends XmlSerializer {
/**
* Constructor
+ *
* @param propertyStore The property store containing all the settings for this object.
* @param overrideProperties A set of overridden settings, typically defined by the class itself.
*/
@@ -95,7 +97,8 @@ public class XmlSchemaSerializer extends XmlSerializer {
/**
* Returns an XML-Schema validator based on the output returned by {@link #doSerialize(SerializerSession, Object)};
*
- * @param session The serializer session object return by {@link #createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType, UriContext)}.<br>
+ * @param session The serializer session object return by {@link #createSession(Object, ObjectMap, Method, Locale,
+ * TimeZone, MediaType, UriContext)}.
* Can be <jk>null</jk>.
* @param o The object to serialize.
* @return The new validator.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
index dcb590c..30701cb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
@@ -32,6 +32,7 @@ public class XmlSchemaSerializerBuilder extends XmlSerializerBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public XmlSchemaSerializerBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java
index 73fdf7e..4c9d0a6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java
@@ -101,10 +101,12 @@ import org.apache.juneau.xml.annotation.*;
* <xt><fico_x0020_score</xt> <xa>_type</xa>=<xs>'string'</xs><xt>></xt> &gt; 640<xt></fico_x0020_score></xt>
* <xt></object></xt>
* <p>
- * This serializer provides several serialization options. Typically, one of the predefined <jsf>DEFAULT</jsf> serializers will be sufficient.
+ * This serializer provides several serialization options.
+ * Typically, one of the predefined <jsf>DEFAULT</jsf> serializers will be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
* <p>
- * If an attribute name contains any non-valid XML element characters, they will be escaped using standard {@code _x####_} notation.
+ * If an attribute name contains any non-valid XML element characters, they will be escaped using standard
+ * {@code _x####_} notation.
*
* <h5 class='section'>Configurable properties:</h5>
* <p>
@@ -150,6 +152,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public Sq(PropertyStore propertyStore) {
@@ -167,6 +170,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public SqReadable(PropertyStore propertyStore) {
@@ -185,6 +189,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public Ns(PropertyStore propertyStore) {
@@ -202,6 +207,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public NsSq(PropertyStore propertyStore) {
@@ -219,6 +225,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public NsSqReadable(PropertyStore propertyStore) {
@@ -227,7 +234,8 @@ public class XmlSerializer extends WriterSerializer {
@Override /* CoreObject */
protected ObjectMap getOverrideProperties() {
- return super.getOverrideProperties().append(XML_enableNamespaces, true).append(SERIALIZER_quoteChar, '\'').append(SERIALIZER_useWhitespace, true);
+ return super.getOverrideProperties().append(XML_enableNamespaces, true).append(SERIALIZER_quoteChar, '\'')
+ .append(SERIALIZER_useWhitespace, true);
}
}
@@ -237,6 +245,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public XmlSerializer(PropertyStore propertyStore) {
@@ -344,7 +353,8 @@ public class XmlSerializer extends WriterSerializer {
* @param addNamespaceUris Flag indicating that namespace URIs need to be added.
* @param format The format to serialize the output to.
* @param isMixed We're serializing mixed content, so don't use whitespace.
- * @param preserveWhitespace <jk>true</jk> if we're serializing {@link XmlFormat#MIXED_PWS} or {@link XmlFormat#TEXT_PWS}.
+ * @param preserveWhitespace <jk>true</jk> if we're serializing {@link XmlFormat#MIXED_PWS} or
+ * {@link XmlFormat#TEXT_PWS}.
* @param pMeta The bean property metadata if this is a bean property being serialized.
* @return The same writer passed in so that calls to the writer can be chained.
* @throws Exception If a problem occurred trying to convert the output.
@@ -576,7 +586,8 @@ public class XmlSerializer extends WriterSerializer {
return out;
}
- private ContentResult serializeMap(XmlSerializerSession session, XmlWriter out, Map m, ClassMeta<?> sType, ClassMeta<?> eKeyType, ClassMeta<?> eValueType, boolean isMixed) throws Exception {
+ private ContentResult serializeMap(XmlSerializerSession session, XmlWriter out, Map m, ClassMeta<?> sType,
+ ClassMeta<?> eKeyType, ClassMeta<?> eValueType, boolean isMixed) throws Exception {
m = session.sort(m);
@@ -607,7 +618,8 @@ public class XmlSerializer extends WriterSerializer {
return hasChildren ? CR_ELEMENTS : CR_EMPTY;
}
- private ContentResult serializeBeanMap(XmlSerializerSession session, XmlWriter out, BeanMap<?> m, Namespace elementNs, boolean isCollapsed, boolean isMixed) throws Exception {
+ private ContentResult serializeBeanMap(XmlSerializerSession session, XmlWriter out, BeanMap<?> m,
+ Namespace elementNs, boolean isCollapsed, boolean isMixed) throws Exception {
boolean hasChildren = false;
BeanMeta<?> bm = m.getMeta();
@@ -745,7 +757,8 @@ public class XmlSerializer extends WriterSerializer {
return isMixed ? CR_MIXED : CR_ELEMENTS;
}
- private XmlWriter serializeCollection(XmlSerializerSession session, XmlWriter out, Object in, ClassMeta<?> sType, ClassMeta<?> eType, BeanPropertyMeta ppMeta, boolean isMixed) throws Exception {
+ private XmlWriter serializeCollection(XmlSerializerSession session, XmlWriter out, Object in, ClassMeta<?> sType,
+ ClassMeta<?> eType, BeanPropertyMeta ppMeta, boolean isMixed) throws Exception {
ClassMeta<?> seType = sType.getElementType();
if (seType == null)
@@ -831,7 +844,8 @@ public class XmlSerializer extends WriterSerializer {
}
@Override /* Serializer */
- public XmlSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ public XmlSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale,
+ TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
return new XmlSerializerSession(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
}
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
index 56b2fff..6592980 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
@@ -34,6 +34,7 @@ public class XmlSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public XmlSerializerBuilder(PropertyStore propertyStore) {
@@ -97,21 +98,19 @@ public class XmlSerializerBuilder extends SerializerBuilder {
* <p>
* Detect namespace usage before serialization.
* <p>
- * Used in conjunction with {@link XmlSerializerContext#XML_addNamespaceUrisToRoot} to reduce
- * the list of namespace URLs appended to the root element to only those
- * that will be used in the resulting document.
+ * Used in conjunction with {@link XmlSerializerContext#XML_addNamespaceUrisToRoot} to reduce the list of namespace
+ * URLs appended to the root element to only those that will be used in the resulting document.
* <p>
- * If enabled, then the data structure will first be crawled looking for
- * namespaces that will be encountered before the root element is
- * serialized.
+ * If enabled, then the data structure will first be crawled looking for namespaces that will be encountered before
+ * the root element is serialized.
* <p>
* This setting is ignored if {@link XmlSerializerContext#XML_enableNamespaces} is not enabled.
* <p>
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Auto-detection of namespaces can be costly performance-wise.
- * In high-performance environments, it's recommended that namespace detection be
- * disabled, and that namespaces be manually defined through the {@link XmlSerializerContext#XML_namespaces} property.
+ * In high-performance environments, it's recommended that namespace detection be disabled, and that
+ * namespaces be manually defined through the {@link XmlSerializerContext#XML_namespaces} property.
* </ul>
* <p>
* <h5 class='section'>Notes:</h5>
@@ -138,8 +137,7 @@ public class XmlSerializerBuilder extends SerializerBuilder {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * Use this setting to add {@code xmlns:x} attributes to the root
- * element for the default and all mapped namespaces.
+ * Use this setting to add {@code xmlns:x} attributes to the root element for the default and all mapped namespaces.
* <p>
* This setting is ignored if {@link XmlSerializerContext#XML_enableNamespaces} is not enabled.
* <p>
@@ -193,8 +191,8 @@ public class XmlSerializerBuilder extends SerializerBuilder {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * Specifies the namespace for the <code>XMLSchema</code> namespace, used by the schema generated
- * by the {@link XmlSchemaSerializer} class.
+ * Specifies the namespace for the <code>XMLSchema</code> namespace, used by the schema generated by the
+ * {@link XmlSchemaSerializer} class.
* <p>
* <h5 class='section'>Notes:</h5>
* <ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerContext.java
index 7239f25..cd11328 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerContext.java
@@ -25,9 +25,12 @@ 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> - Properties associated with handling beans on serializers and parsers.
+ * <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.
+ * <li class='jc'><a class="doclink"
+ * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
* </ul>
* </ul>
*/
@@ -59,13 +62,11 @@ public class XmlSerializerContext extends SerializerContext {
* <p>
* Detect namespace usage before serialization.
* <p>
- * Used in conjunction with {@link #XML_addNamespaceUrisToRoot} to reduce
- * the list of namespace URLs appended to the root element to only those
- * that will be used in the resulting document.
+ * Used in conjunction with {@link #XML_addNamespaceUrisToRoot} to reduce the list of namespace URLs appended to the
+ * root element to only those that will be used in the resulting document.
* <p>
- * If enabled, then the data structure will first be crawled looking for
- * namespaces that will be encountered before the root element is
- * serialized.
+ * If enabled, then the data structure will first be crawled looking for namespaces that will be encountered before
+ * the root element is serialized.
* <p>
* This setting is ignored if {@link #XML_enableNamespaces} is not enabled.
* <p>
@@ -88,8 +89,7 @@ public class XmlSerializerContext extends SerializerContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * Use this setting to add {@code xmlns:x} attributes to the root
- * element for the default and all mapped namespaces.
+ * Use this setting to add {@code xmlns:x} attributes to the root element for the default and all mapped namespaces.
* <p>
* This setting is ignored if {@link #XML_enableNamespaces} is not enabled.
*/
@@ -119,8 +119,8 @@ public class XmlSerializerContext extends SerializerContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * Specifies the namespace for the <code>XMLSchema</code> namespace, used by the schema generated
- * by the {@link XmlSchemaSerializer} class.
+ * Specifies the namespace for the <code>XMLSchema</code> namespace, used by the schema generated by the
+ * {@link XmlSchemaSerializer} class.
*/
public static final String XML_xsNamespace = "XmlSerializer.xsNamespace";
@@ -148,9 +148,11 @@ public class XmlSerializerContext extends SerializerContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred through reflection.
+ * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
+ * through reflection.
* 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.
+ * For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined from
+ * the value type.
* <p>
* When present, this value overrides the {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java
index ca67989..76588c4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java
@@ -51,20 +51,21 @@ public class XmlSerializerSession extends SerializerSession {
* Create a new session using properties specified in the context.
*
* @param ctx The context creating this session object.
- * The context contains all the configuration settings for this object.
+ * The context contains all the configuration settings for this object.
* @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.
* @param op The override properties.
- * These override any context properties defined in the context.
+ * These override any context properties defined in the context.
* @param javaMethod The java method that called this serializer, usually the method in a REST servlet.
* @param locale The session locale.
- * If <jk>null</jk>, then the locale defined on the context is used.
+ * If <jk>null</jk>, then the locale defined on the context is used.
* @param timeZone The session timezone.
- * If <jk>null</jk>, then the timezone defined on the context is used.
+ * If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
* @param uriContext The URI context.
- * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
+ * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
*/
- public XmlSerializerSession(XmlSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ public XmlSerializerSession(XmlSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale,
+ TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
super(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
if (op == null || op.isEmpty()) {
enableNamespaces = ctx.enableNamespaces;
@@ -187,8 +188,7 @@ public class XmlSerializerSession extends SerializerSession {
* Returns <jk>true</jk> if we're serializing HTML.
* <p>
* The difference in behavior is how empty non-void elements are handled.
- * The XML serializer will produce a collapsed tag, whereas the HTML serializer
- * will produce a start and end tag.
+ * The XML serializer will produce a collapsed tag, whereas the HTML serializer will produce a start and end tag.
*
* @return <jk>true</jk> if we're generating HTML.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java
index 28d858a..43d0835 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java
@@ -165,16 +165,18 @@ public final class XmlUtils {
/**
* Encodes the specified element text and sends the results to the specified writer.
* <p>
- * Encodes any invalid XML text characters to <code>_x####_</code> sequences and sends the response
- * to the specified writer.
- * <br>Encodes <js>'&'</js>, <js>'<'</js>, and <js>'>'</js> as XML entities.
- * <br>Encodes invalid XML text characters to <code>_x####_</code> sequences.
+ * Encodes any invalid XML text characters to <code>_x####_</code> sequences and sends the response to the specified
+ * writer.
+ * <br>
+ * Encodes <js>'&'</js>, <js>'<'</js>, and <js>'>'</js> as XML entities.
+ * <br>
+ * Encodes invalid XML text characters to <code>_x####_</code> sequences.
*
* @param w The writer to send the output to.
* @param o The object being encoded.
* @param trim Trim the text before serializing it.
* @param preserveWhitespace Specifies whether we're in preserve-whitespace mode.
- * (e.g. {@link XmlFormat#MIXED_PWS} or {@link XmlFormat#TEXT_PWS}.
+ * (e.g. {@link XmlFormat#MIXED_PWS} or {@link XmlFormat#TEXT_PWS}.
* If <jk>true</jk>, leading and trailing whitespace characters will be encoded.
* @return The same writer passed in.
* @throws IOException Thrown from the writer.
@@ -299,10 +301,12 @@ public final class XmlUtils {
/**
* Encodes the specified attribute value and sends the results to the specified writer.
* <p>
- * Encodes any invalid XML text characters to <code>_x####_</code> sequences and sends the response
- * to the specified writer.
- * <br>Encodes <js>'&'</js>, <js>'<'</js>, <js>'>'</js>, <js>'"'</js>, and <js>'\''</js> as XML entities.
- * <br>Encodes invalid XML text characters to <code>_x####_</code> sequences.
+ * Encodes any invalid XML text characters to <code>_x####_</code> sequences and sends the response to the specified
+ * writer.
+ * <br>
+ * Encodes <js>'&'</js>, <js>'<'</js>, <js>'>'</js>, <js>'"'</js>, and <js>'\''</js> as XML entities.
+ * <br>
+ * Encodes invalid XML text characters to <code>_x####_</code> sequences.
*
* @param w The writer to send the output to.
* @param o The object being encoded.
@@ -475,8 +479,7 @@ public final class XmlUtils {
/**
* Find the namespace given a list of <ja>@Xml</ja> and <ja>@XmlSchema</ja> annotations.
- * The annotations should be a child-to-parent ordering of annotations found on
- * a class or method.
+ * The annotations should be a child-to-parent ordering of annotations found on a class or method.
*
* @param xmls The list of <ja>@Xml</ja> annotations.
* @param schemas The list of <ja>@XmlSchema</ja> annotations.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/XmlWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlWriter.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlWriter.java
index 21d1d2a..cb00878 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlWriter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlWriter.java
@@ -44,7 +44,8 @@ public class XmlWriter extends SerializerWriter {
* @param enableNs Flag to indicate if XML namespaces are enabled.
* @param defaultNamespace The default namespace if XML namespaces are enabled.
*/
- public XmlWriter(Writer out, boolean useWhitespace, int maxIndent, boolean trimStrings, char quoteChar, UriResolver uriResolver, boolean enableNs, Namespace defaultNamespace) {
+ public XmlWriter(Writer out, boolean useWhitespace, int maxIndent, boolean trimStrings, char quoteChar,
+ UriResolver uriResolver, boolean enableNs, Namespace defaultNamespace) {
super(out, useWhitespace, maxIndent, trimStrings, quoteChar, uriResolver);
this.enableNs = enableNs;
this.defaultNsPrefix = defaultNamespace == null ? null : defaultNamespace.name;
@@ -496,7 +497,7 @@ public class XmlWriter extends SerializerWriter {
*
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The attribute name.
- * @param value The attribute value, convertable to a URI via <code>toString()</code>
+ * @param value The attribute value, convertible to a URI via <code>toString()</code>
* @return This object (for method chaining).
* @throws IOException If a problem occurred.
*/
@@ -509,7 +510,7 @@ public class XmlWriter extends SerializerWriter {
*
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The attribute name.
- * @param value The attribute value, convertable to a URI via <code>toString()</code>
+ * @param value The attribute value, convertible to a URI via <code>toString()</code>
* @return This object (for method chaining).
* @throws IOException If a problem occurred.
*/
@@ -533,7 +534,8 @@ public class XmlWriter extends SerializerWriter {
* Serializes and encodes the specified object as valid XML text.
*
* @param o The object being serialized.
- * @param preserveWhitespace If <jk>true</jk>, then we're serializing {@link XmlFormat#MIXED_PWS} or {@link XmlFormat#TEXT_PWS} content.
+ * @param preserveWhitespace If <jk>true</jk>, then we're serializing {@link XmlFormat#MIXED_PWS} or
+ * {@link XmlFormat#TEXT_PWS} content.
* @return This object (for method chaining).
* @throws IOException
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java
index 13f7613..97e2d92 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java
@@ -81,17 +81,16 @@ public @interface Xml {
* to the bean property.
* </ul>
* <p>
- * Must either be matched to a {@link #namespace()} annotation on the same object, parent object, or a {@link XmlNs} with the same name
- * through the {@link XmlSchema#xmlNs()} annotation on the package.
- * </p>
+ * Must either be matched to a {@link #namespace()} annotation on the same object, parent object, or a
+ * {@link XmlNs} with the same name through the {@link XmlSchema#xmlNs()} annotation on the package.
*/
String prefix() default "";
/**
* Sets the namespace URI of this property or class.
* <p>
- * Must be matched with a {@link #prefix()} annotation on this object, a parent object, or a {@link XmlNs} with the same name
- * through the {@link XmlSchema#xmlNs()} annotation on the package.
+ * Must be matched with a {@link #prefix()} annotation on this object, a parent object, or a {@link XmlNs} with the
+ * same name through the {@link XmlSchema#xmlNs()} annotation on the package.
*/
String namespace() default "";
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
index a96b945..690f0ac 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
@@ -40,9 +40,10 @@ public enum XmlFormat {
* <p>
* On a bean class, implies bean properties will be serialized as attributes instead of child elements by default.
* <p>
- * On bean properties, implies that the bean property value itself should be serialized as attributes on the bean element.
+ * On bean properties, implies that the bean property value itself should be serialized as attributes on the bean
+ * element.
* The bean property data type must be of class type <code>Map<Object,Object></code> where both
- * objects are convertible to <code>Strings</code>.
+ * objects are convertible to <code>Strings</code>.
*/
ATTRS,
@@ -63,7 +64,8 @@ public enum XmlFormat {
* <p>
* Only applicable for objects of type array/Collection.
* <p>
- * On a bean property, implies that the bean property value itself should be serialized as child elements of the bean element.
+ * On a bean property, implies that the bean property value itself should be serialized as child elements of the
+ * bean element.
*/
ELEMENTS,
@@ -105,7 +107,7 @@ public enum XmlFormat {
* Same as {@link #TEXT} except the content is expected to be fully-formed XML that will
* get serialized as-is.
* <p>
- * During parsing, this XML text will be reserialized and set on the property.
+ * During parsing, this XML text will be re-serialized and set on the property.
* <p>
* Only applicable for bean properties, not bean classes.
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java
index 8d67da8..04a9def 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java
@@ -29,33 +29,30 @@ public @interface XmlSchema {
/**
* Sets the default XML prefix for all classes in this and child packages.
* <p>
- * Must either be matched with a {@link #namespace()} annotation, or an {@link #xmlNs()} mapping with the
- * same {@link XmlNs#prefix} value.
- * </p>
+ * Must either be matched with a {@link #namespace()} annotation, or an {@link #xmlNs()} mapping with the same
+ * {@link XmlNs#prefix} value.
*/
public String prefix() default "";
/**
* Sets the default XML namespace URL for all classes in this and child packages.
* <p>
- * Must either be matched with a {@link #prefix()} annotation, or an {@link #xmlNs()} mapping with the
- * same {@link XmlNs#namespaceURI} value.
- * </p>
+ * Must either be matched with a {@link #prefix()} annotation, or an {@link #xmlNs()} mapping with the same
+ * {@link XmlNs#namespaceURI} value.
*/
public String namespace() default "";
/**
* Lists all namespace mappings to be used on all classes within this package.
* <p>
- * The purpose of this annotation is to allow namespace mappings to be defined in a single location
- * and referred to by name through just the {@link Xml#prefix()} annotation.
+ * The purpose of this annotation is to allow namespace mappings to be defined in a single location and referred
+ * to by name through just the {@link Xml#prefix()} annotation.
* <p>
* Inherited by child packages.
*
* <h5 class='section'>Example:</h5>
* <p>
* Contents of <code>package-info.java</code>...
- * </p>
* <p class='bcode'>
* <jc>// XML namespaces used within this package.</jc>
* <ja>@XmlSchema</ja>(prefix=<js>"ab"</js>,
@@ -71,7 +68,6 @@ public @interface XmlSchema {
* </p>
* <p>
* Class in package using defined namespaces...
- * </p>
* <p class='bcode'>
* <jk>package</jk> corg.apache.juneau.examples.addressbook;
*
[03/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/xml/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/package.html b/juneau-core/src/main/java/org/apache/juneau/xml/package.html
index 672ca2f..34cb5bc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/package.html
@@ -87,17 +87,6 @@
<li><p><a class='doclink' href='#ParserConfigurableProperties'>Configurable properties</a></p>
<li><p><a class='doclink' href='#ParserOtherNotes'>Other notes</a></p>
</ol>
- <li><p><a class='doclink' href='#RestApiSupport'>REST API support</a></p>
- <ol>
- <li><p><a class='doclink' href='#RestServerSupport'>REST server support</a></p>
- <ol>
- <li><p><a class='doclink' href='#RestServletDefault'>Using RestServletDefault</a></p>
- <li><p><a class='doclink' href='#RestServlet'>Using RestServlet with annotations</a></p>
- <li><p><a class='doclink' href='#DefaultProvider'>Using JAX-RS DefaultProvider</a></p>
- <li><p><a class='doclink' href='#BaseProvider'>Using JAX-RS BaseProvider with annotations</a></p>
- </ol>
- <li><p><a class='doclink' href='#RestClientSupport'>REST client support</a></p>
- </ol>
</ol>
@@ -106,34 +95,44 @@
<h2 class='topic' onclick='toggle(this)'>1 - XML support overview</h2>
<div class='topic'>
<p>
- Juneau supports converting arbitrary POJOs to and from XML using ultra-efficient serializers and parsers.<br>
- The XML serializer converts POJOs directly to XML without the need for intermediate DOM objects.<br>
+ Juneau supports converting arbitrary POJOs to and from XML using ultra-efficient serializers and parsers.
+ <br>
+ The XML serializer converts POJOs directly to XML without the need for intermediate DOM objects.
+ <br>
Likewise, the XML parser uses a STaX parser and creates POJOs directly without intermediate DOM objects.
</p>
<p>
- Unlike frameworks such as JAXB, Juneau does not require POJO classes to be annotated to produce
- and consume XML.<br>
+ Unlike frameworks such as JAXB, Juneau does not require POJO classes to be annotated to produce and consume
+ XML.
+ <br>
For example, it can serialize and parse instances of any of the following POJO types:
</p>
<ul class='spaced-list'>
- <li>Java 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 this list.
+ <li>Java 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 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 <code>toString()</code>, <code>fromString()</code>, <code>valueOf()</code>, <code>constructor(String)</code>).
+ <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>).
</ul>
<p>
- In addition to the types shown above, Juneau includes the ability to define transforms to transform non-standard object and
- property types to serializable forms (e.g. to transform <code>Calendars</code> to and from <code>ISO8601</code> strings,
- or <code>byte[]</code> arrays to and from base-64 encoded strings).<br>
- These transforms can be associated with serializers/parsers, or can be associated with classes or bean properties through type and method annotations.
+ In addition to the types shown above, Juneau includes the ability to define transforms to transform
+ non-standard object and property types to serializable forms (e.g. to transform <code>Calendars</code> to and
+ from <code>ISO8601</code> strings, or <code>byte[]</code> arrays to and from base-64 encoded strings).
+ <br>
+ These transforms can be associated with serializers/parsers, or can be associated with classes or bean
+ properties through type and method annotations.
</p>
<p>
- Refer to <a href='../../../../overview-summary.html#Core.PojoCategories' class='doclink'>POJO Categories</a> for a complete definition of supported POJOs.
+ Refer to <a href='../../../../overview-summary.html#Core.PojoCategories' class='doclink'>POJO Categories</a>
+ for a complete definition of supported POJOs.
</p>
<p>
- While annotations are not required to produce or consume XML, several XML annotations are provided
- for handling namespaces and fine-tuning the format of the XML produced.
+ While annotations are not required to produce or consume XML, several XML annotations are provided for handling
+ namespaces and fine-tuning the format of the XML produced.
</p>
<h6 class='topic'>Prerequisites</h6>
<p>
@@ -146,16 +145,19 @@
<h3 class='topic' onclick='toggle(this)'>1.1 - XML support overview - example</h3>
<div class='topic'>
<p>
- The example shown here is from the Address Book resource located in the <code>juneau-examples-rest</code> microservice project.<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.
+ The example shown here is from the Address Book resource located in the <code>juneau-examples-rest</code>
+ microservice project.
+ <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>
When you point a browser at <code>/sample/addressBook</code>, the POJO is rendered as HTML:
</p>
<img class='bordered' src="doc-files/Example_HTML.png">
<p>
- By appending <code>?Accept=<i>mediaType</i>&plainText=true</code> to the URL, you can view the data in the various supported XML formats:
+ By appending <code>?Accept=<i>mediaType</i>&plainText=true</code> to the URL, you can view the data
+ in the various supported XML formats:
</p>
<h6 class='figure'>Normal XML</h6>
@@ -165,13 +167,12 @@
<img class='bordered' src="doc-files/Example_XMLSimple.png">
<p>
- In addition to serializing POJOs to XML, Juneau includes support for serializing the POJO metamodel to XML Schema, with
- support for multiple namespaces.
+ In addition to serializing POJOs to XML, Juneau includes support for serializing the POJO metamodel to
+ XML Schema, with support for multiple namespaces.
</p>
<h6 class='figure'>XML Schema</h6>
<img class='bordered' src="doc-files/Example_XMLSchema.png">
-
</div>
</div>
@@ -181,36 +182,50 @@
<h2 class='topic' onclick='toggle(this)'>2 - XmlSerializer class</h2>
<div class='topic'>
<p>
- {@link org.apache.juneau.xml.XmlSerializer} is the class used to convert POJOs to XML.<br>
- {@link org.apache.juneau.xml.XmlDocSerializer} is a subclass that adds an XML declaration element to the output before the POJO is serialized.
+ {@link org.apache.juneau.xml.XmlSerializer} is the class used to convert POJOs to XML.
+ <br>
+ {@link org.apache.juneau.xml.XmlDocSerializer} is a subclass that adds an XML declaration element to the output
+ before the POJO is serialized.
</p>
<p>
- The XML serializer includes many configurable settings.<br>
+ The XML serializer includes many configurable settings.
+ <br>
Static reusable instances of XML serializers are provided with commonly-used settings:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT} - All default settings.
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_SQ} - Use single quotes on attributes. Typically useful for testing since it makes string comparison simpler.
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_SQ_READABLE} - Use single quotes on attributes and add whitespace for readability.
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS} - Same as DEFAULT but with namespaces enabled.
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS_SQ} - Same as DEFAULT_SQ but with namespaces enabled.
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS_SQ_READABLE} - Same as DEFAULT_SQ_READABLE but with namespaces enabled.
+ <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT}
+ - All default settings.
+ <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_SQ}
+ - Use single quotes on attributes. Typically useful for testing since it makes string comparison simpler.
+ <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_SQ_READABLE}
+ - Use single quotes on attributes and add whitespace for readability.
+ <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS}
+ - Same as DEFAULT but with namespaces enabled.
+ <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS_SQ}
+ - Same as DEFAULT_SQ but with namespaces enabled.
+ <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS_SQ_READABLE}
+ - Same as DEFAULT_SQ_READABLE but with namespaces enabled.
</ul>
<p>
In addition, DTO beans are provided that use the XML serializer and parser for the following languages:
</p>
<ul>
- <li><a class='doclink' href='../dto/atom/package-summary.html#TOC'>org.apache.juneau.dto.atom</a> - ATOM beans.
- <li><a class='doclink' href='../dto/cognos/package-summary.html#TOC'>org.apache.juneau.dto.cognos</a> - Cognos beans.
- <li><a class='doclink' href='../dto/html5/package-summary.html#TOC'>org.apache.juneau.dto.html5</a> - HTML5 beans.
+ <li><a class='doclink' href='../dto/atom/package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ - ATOM beans.
+ <li><a class='doclink' href='../dto/cognos/package-summary.html#TOC'>org.apache.juneau.dto.cognos</a>
+ - Cognos beans.
+ <li><a class='doclink' href='../dto/html5/package-summary.html#TOC'>org.apache.juneau.dto.html5</a>
+ - HTML5 beans.
</ul>
<p>
Refer to the package-level Javadocs for more information about those formats.
</p>
<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>
+ 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.
</p>
<p>
@@ -269,8 +284,11 @@
</object>
</xt></p>
<p>
- The first thing you may notice is how the bean instance is represented by the element <xt><object></xt>.<br>
- When objects have no name associated with them, Juneau provides a default generalized name that maps to the equivalent JSON data type.<br>
+ The first thing you may notice is how the bean instance is represented by the element <xt><object></xt>.
+ <br>
+ When objects have no name associated with them, Juneau provides a default generalized name that maps to the
+ equivalent JSON data type.
+ <br>
Some cases when objects do not have names:
</p>
<ul>
@@ -278,9 +296,12 @@
<li>Object in an array, collection, or map.
</ul>
<p>
- The generalized name reflects the JSON-equivalent data type.<br>
- Juneau produces JSON-equivalent XML, meaning any valid JSON document can be losslessly converted into an XML equivalent.<br>
- In fact, all of the Juneau serializers and parsers are built upon this JSON-equivalency.
+ The generalized name reflects the JSON-equivalent data type.
+ <br>
+ Juneau produces JSON-equivalent XML, meaning any valid JSON document can be losslessly converted into an XML
+ equivalent.
+ <br>
+ In fact, all of the Juneau serializers and parsers are built upon this JSON-equivalence.
</p>
@@ -333,7 +354,8 @@
Loose maps and beans use the element <xt><object></xt> for encapsulation.
</p>
<p>
- <xa>_type</xa> attributes are added to bean properties or map entries if the type cannot be inferred through reflection (e.g. an <code>Object</code> or superclass/interface value type).
+ <xa>_type</xa> attributes are added to bean properties or map entries if the type cannot be inferred
+ through reflection (e.g. an <code>Object</code> or superclass/interface value type).
</p>
<table class='styled' style='width:auto'>
<tr>
@@ -693,8 +715,11 @@
<h3 class='topic' onclick='toggle(this)'>2.2 - @Xml annotations</h3>
<div class='topic'>
<p>
- Just because Juneau allows you to serialize ordinary POJOs to XML doesn't mean you are limited to just JSON-equivalent XML.<br>
- Several annotations are provided in the <a class='doclink' href='annotation/package-summary.html#TOC'>org.apache.juneau.xml.annotation</a> package for customizing the output.
+ Just because Juneau allows you to serialize ordinary POJOs to XML doesn't mean you are limited to just
+ JSON-equivalent XML.
+ <br>
+ Several annotations are provided in the <a class='doclink' href='annotation/package-summary.html#TOC'>
+ org.apache.juneau.xml.annotation</a> package for customizing the output.
</p>
<!-- ======================================================================================================== -->
@@ -702,7 +727,8 @@
<h4 class='topic' onclick='toggle(this)'>2.2.1 - @Bean.typeName()</h4>
<div class='topic'>
<p>
- The {@link org.apache.juneau.annotation.Bean#typeName() @Bean.typeName()} annotation can be used to override the Juneau default name on bean elements.
+ The {@link org.apache.juneau.annotation.Bean#typeName() @Bean.typeName()} annotation can be used to
+ override the Juneau default name on bean elements.
Types names serve two distinct purposes:
</p>
<ol>
@@ -747,7 +773,8 @@
</tr>
</table>
<p>
- On bean properties, a <xa>_type</xa> attribute will be added if a type name is present and the bean class cannot be inferred through reflection.
+ On bean properties, a <xa>_type</xa> attribute will be added if a type name is present and the bean
+ class cannot be inferred through reflection.
</p>
<p>
In the following example, a type attribute is used on property 'b' but not property 'a' since
@@ -797,13 +824,16 @@
</table>
<ul class='doctree'>
<li class='info'>
- <code>string</code>, <code>number</code>, <code>boolean</code>, <code>object</code>, <code>array</code>, and <code>null</code> are reserved keywords that cannot be used as type names.
+ <code>string</code>, <code>number</code>, <code>boolean</code>, <code>object</code>,
+ <code>array</code>, and <code>null</code> are reserved keywords that cannot be used as type names.
</ul>
<p>
- Beans with type names are often used in conjunction with the {@link org.apache.juneau.annotation.Bean#beanDictionary() @Bean.beanDictionary()} and
- {@link org.apache.juneau.annotation.BeanProperty#beanDictionary() @BeanProperty.beanDictionary()} annotations so that the beans can be
- resolved at parse time. These annotations are not necessary during serialization, but are needed during parsing in order to resolve the
- bean types.
+ Beans with type names are often used in conjunction with the
+ {@link org.apache.juneau.annotation.Bean#beanDictionary() @Bean.beanDictionary()} and
+ {@link org.apache.juneau.annotation.BeanProperty#beanDictionary() @BeanProperty.beanDictionary()}
+ annotations so that the beans can be resolved at parse time.
+ These annotations are not necessary during serialization, but are needed during parsing in order to
+ resolve the bean types.
</p>
<p>
The following examples show how type names are used under various circumstances.
@@ -1164,9 +1194,10 @@
</tr>
</table>
<p>
- While it's true that these characters CAN be represented in XML 1.1, it's impossible to parse XML 1.1 text in
- Java without the XML containing an XML declaration.
- Unfortunately, this, and the uselessness of the {@link javax.xml.stream.XMLInputFactory#IS_REPLACING_ENTITY_REFERENCES} setting in Java
+ While it's true that these characters CAN be represented in XML 1.1, it's impossible to parse XML 1.1
+ text in Java without the XML containing an XML declaration.
+ Unfortunately, this, and the uselessness of the
+ {@link javax.xml.stream.XMLInputFactory#IS_REPLACING_ENTITY_REFERENCES} setting in Java
forced us to make some hard design decisions that may not be the most elegant.
</p>
</div>
@@ -1177,8 +1208,8 @@
<h4 class='topic' onclick='toggle(this)'>2.2.2 - @Xml.childName()</h4>
<div class='topic'>
<p>
- The {@link org.apache.juneau.xml.annotation.Xml#childName() @Xml.childName()} annotation can be used to specify the name of XML
- child elements for bean properties of type collection or array.
+ The {@link org.apache.juneau.xml.annotation.Xml#childName() @Xml.childName()} annotation can be used to
+ specify the name of XML child elements for bean properties of type collection or array.
</p>
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
@@ -1266,14 +1297,18 @@
<h4 class='topic' onclick='toggle(this)'>2.2.3 - @Xml.format()</h4>
<div class='topic'>
<p>
- The {@link org.apache.juneau.xml.annotation.Xml#format() @Xml.format()} annotation can be used to tweak the XML format of a POJO.
- <br>The value is set to an enum value of type {@link org.apache.juneau.xml.annotation.XmlFormat}.
- <br>This annotation can be applied to both classes and bean properties.
+ The {@link org.apache.juneau.xml.annotation.Xml#format() @Xml.format()} annotation can be used to tweak
+ the XML format of a POJO.
+ <br>
+ The value is set to an enum value of type {@link org.apache.juneau.xml.annotation.XmlFormat}.
+ <br>
+ This annotation can be applied to both classes and bean properties.
</p>
<p>
- The {@link org.apache.juneau.xml.annotation.XmlFormat#ATTR} format can be applied to bean properties to serialize
- them as XML attributes instead of elements.
- <br>Note that this only supports properties of simple types (e.g. strings, numbers, booleans).
+ The {@link org.apache.juneau.xml.annotation.XmlFormat#ATTR} format can be applied to bean properties to
+ serialize them as XML attributes instead of elements.
+ <br>
+ Note that this only supports properties of simple types (e.g. strings, numbers, booleans).
</p>
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
@@ -1306,8 +1341,8 @@
</tr>
</table>
<p>
- The {@link org.apache.juneau.xml.annotation.XmlFormat#ATTRS} format can be applied to bean classes to force all bean properties
- to be serialized as XML attributes instead of child elements.
+ The {@link org.apache.juneau.xml.annotation.XmlFormat#ATTRS} format can be applied to bean classes to
+ force all bean properties to be serialized as XML attributes instead of child elements.
</p>
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
@@ -1343,8 +1378,9 @@
</tr>
</table>
<p>
- The {@link org.apache.juneau.xml.annotation.XmlFormat#ELEMENT} format can be applied to bean properties to override
- the {@link org.apache.juneau.xml.annotation.XmlFormat#ATTRS} format applied on the bean class.
+ The {@link org.apache.juneau.xml.annotation.XmlFormat#ELEMENT} format can be applied to bean properties
+ to override the {@link org.apache.juneau.xml.annotation.XmlFormat#ATTRS} format applied on the bean
+ class.
</p>
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
@@ -1383,10 +1419,12 @@
</tr>
</table>
<p>
- The {@link org.apache.juneau.xml.annotation.XmlFormat#ATTRS} format can be applied to a single bean property
- of type <code>Map<String,Object></code> to denote arbitrary XML attribute values on the element.
- <br>These can be mixed with other {@link org.apache.juneau.xml.annotation.XmlFormat#ATTR} annotated properties, but
- there must not be an overlap in bean property names and map keys.
+ The {@link org.apache.juneau.xml.annotation.XmlFormat#ATTRS} format can be applied to a single bean
+ property of type <code>Map<String,Object></code> to denote arbitrary XML attribute values on the
+ element.
+ <br>
+ These can be mixed with other {@link org.apache.juneau.xml.annotation.XmlFormat#ATTR} annotated
+ properties, but there must not be an overlap in bean property names and map keys.
</p>
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
@@ -1431,10 +1469,13 @@
<p>
The {@link org.apache.juneau.xml.annotation.XmlFormat#COLLAPSED} format can be applied to bean properties
of type array/Collection.
- <br>This causes the child objects to be serialized directly inside the bean element.
- <br>This format must be used in conjunction with {@link org.apache.juneau.xml.annotation.Xml#childName()}
+ <br>
+ This causes the child objects to be serialized directly inside the bean element.
+ <br>
+ This format must be used in conjunction with {@link org.apache.juneau.xml.annotation.Xml#childName()}
to differentiate which collection the values came from if you plan on parsing the output back into beans.
- <br>Note that child names must not conflict with other property names.
+ <br>
+ Note that child names must not conflict with other property names.
</p>
<table class='styled' style='width:auto'>
<tr>
@@ -1481,10 +1522,12 @@
</tr>
</table>
<p>
- The {@link org.apache.juneau.xml.annotation.XmlFormat#ELEMENTS} format can be applied to a single bean property
- of either a simple type or array/Collection.
- <br>It allows free-form child elements to be formed.
- <br>All other properties on the bean MUST be serialized as attributes.
+ The {@link org.apache.juneau.xml.annotation.XmlFormat#ELEMENTS} format can be applied to a single bean
+ property of either a simple type or array/Collection.
+ <br>
+ It allows free-form child elements to be formed.
+ <br>
+ All other properties on the bean MUST be serialized as attributes.
</p>
<table class='styled' style='width:auto'>
<tr>
@@ -1546,14 +1589,18 @@
</tr>
</table>
<p>
- The {@link org.apache.juneau.xml.annotation.XmlFormat#MIXED} format is similar to {@link org.apache.juneau.xml.annotation.XmlFormat#ELEMENTS}
- except elements names on primitive types (string/number/boolean/null) are stripped from the output.
+ The {@link org.apache.juneau.xml.annotation.XmlFormat#MIXED} format is similar to
+ {@link org.apache.juneau.xml.annotation.XmlFormat#ELEMENTS} except elements names on primitive types
+ (string/number/boolean/null) are stripped from the output.
This format particularly useful when combined with bean dictionaries to produce mixed content.
- <br>The bean dictionary isn't used during serialization, but it is needed during parsing to resolve bean types.
+ <br>
+ The bean dictionary isn't used during serialization, but it is needed during parsing to resolve bean
+ types.
</p>
<p>
- The {@link org.apache.juneau.xml.annotation.XmlFormat#MIXED_PWS} format identical to {@link org.apache.juneau.xml.annotation.XmlFormat#MIXED}
- except whitespace characters are preserved in the output.
+ The {@link org.apache.juneau.xml.annotation.XmlFormat#MIXED_PWS} format identical to
+ {@link org.apache.juneau.xml.annotation.XmlFormat#MIXED} except whitespace characters are preserved in
+ the output.
</p>
<table class='styled' style='width:auto'>
<tr>
@@ -1615,15 +1662,21 @@
</table>
<p>
Whitespace (tabs and newlines) are not added to MIXED child nodes in readable-output mode.
- This helps ensures strings in the serialized output can be losslessly parsed back into their original forms when they contain whitespace characters.
- If the {@link javax.xml.stream.XMLInputFactory#IS_REPLACING_ENTITY_REFERENCES} setting was not useless in Java, we could support lossless
- readable XML for MIXED content. But as of Java 8, it still does not work.
+ This helps ensures strings in the serialized output can be losslessly parsed back into their original
+ forms when they contain whitespace characters.
+ If the {@link javax.xml.stream.XMLInputFactory#IS_REPLACING_ENTITY_REFERENCES} setting was not useless
+ in Java, we could support lossless readable XML for MIXED content.
+ But as of Java 8, it still does not work.
</p>
<p>
- XML suffers from other deficiencies as well that affect MIXED content. For example, <xt><X></X></xt> and <xt><X/></xt> are
- equivalent in XML and indistinguishable by the Java XML parsers. This makes it impossible to differentiate between an empty element and an
- element containing an empty string. This causes empty strings to get lost in translation. To alleviate this, we use the constructs <js>"_xE000_"</js> to
- represent an empty string, and <js>"_x0020_"</js> to represent leading and trailing spaces.
+ XML suffers from other deficiencies as well that affect MIXED content.
+ For example, <xt><X></X></xt> and <xt><X/></xt> are equivalent in XML and
+ indistinguishable by the Java XML parsers.
+ This makes it impossible to differentiate between an empty element and an element containing an empty
+ string.
+ This causes empty strings to get lost in translation.
+ To alleviate this, we use the constructs <js>"_xE000_"</js> to represent an empty string, and
+ <js>"_x0020_"</js> to represent leading and trailing spaces.
</p>
<p>
The examples below show how whitespace is handled under various circumstances:
@@ -1880,14 +1933,18 @@
</table>
<p>
- It should be noted that when using <jsf>MIXED</jsf>, you are not guaranteed to parse back the exact same content
- since side-by-side strings in the content will end up concatenated when parsed.
+ It should be noted that when using <jsf>MIXED</jsf>, you are not guaranteed to parse back the exact
+ same content since side-by-side strings in the content will end up concatenated when parsed.
</p>
<p>
- The {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT} format is similar to {@link org.apache.juneau.xml.annotation.XmlFormat#MIXED}
- except it's meant for solitary objects that get serialized as simple child text nodes.
- <br>Any object that can be serialize to a <code>String</code> can be used.
- <br>The {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT_PWS} is the same except whitespace is preserved in the output.
+ The {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT} format is similar to
+ {@link org.apache.juneau.xml.annotation.XmlFormat#MIXED} except it's meant for solitary objects that
+ get serialized as simple child text nodes.
+ <br>
+ Any object that can be serialize to a <code>String</code> can be used.
+ <br>
+ The {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT_PWS} is the same except whitespace is
+ preserved in the output.
</p>
<table class='styled' style='width:auto'>
<tr>
@@ -1919,11 +1976,15 @@
</tr>
</table>
<p>
- The {@link org.apache.juneau.xml.annotation.XmlFormat#XMLTEXT} format is similar to {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT}
- except it's meant for strings containing XML that should be serialized as-is to the document.
- <br>Any object that can be serialize to a <code>String</code> can be used.
- <br>During parsing, the element content gets parsed with the rest of the document and then re-serialized to XML before being set as the
- property value. This process may not be perfect (e.g. double quotes may be replaced by single quotes, etc...).
+ The {@link org.apache.juneau.xml.annotation.XmlFormat#XMLTEXT} format is similar to
+ {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT} except it's meant for strings containing XML
+ that should be serialized as-is to the document.
+ <br>
+ Any object that can be serialize to a <code>String</code> can be used.
+ <br>
+ During parsing, the element content gets parsed with the rest of the document and then re-serialized to
+ XML before being set as the property value.
+ This process may not be perfect (e.g. double quotes may be replaced by single quotes, etc...).
</p>
<table class='styled' style='width:auto'>
<tr>
@@ -2004,19 +2065,22 @@
<xt></object></xt>
</p>
<p>
- This isn't too exciting yet since we haven't specified any namespaces yet.<br>
- Therefore, everything is defined under the default <code>Juneau</code> namespace.<br>
+ This isn't too exciting yet since we haven't specified any namespaces yet.
+ <br>
+ Therefore, everything is defined under the default <code>Juneau</code> namespace.
</p>
<p>
Namespaces can be defined at the following levels:
</p>
<ul class='spaced-list'>
- <li>At the package level by using the {@link org.apache.juneau.xml.annotation.XmlSchema @XmlSchema} annotation.
+ <li>At the package level by using the {@link org.apache.juneau.xml.annotation.XmlSchema @XmlSchema}
+ annotation.
<li>At the class level by using the {@link org.apache.juneau.xml.annotation.Xml @Xml} annotation.
<li>At the bean property level by using the {@link org.apache.juneau.xml.annotation.Xml @Xml} annotation.
</ul>
<p>
- It's typically best to specify the namespaces used at the package level.<br>
+ It's typically best to specify the namespaces used at the package level.
+ <br>
We'll do that here for the package containing our test code.
</p>
<p class='bcode'>
@@ -2034,17 +2098,22 @@
<jk>import</jk> org.apache.juneau.xml.annotation.*;
</p>
<p>
- We're defining four namespaces in this package and designating <js>"http://www.apache.org/addressBook/"</js> as the default
- namespace for all classes and properties within this package.
+ We're defining four namespaces in this package and designating <js>"http://www.apache.org/addressBook/"</js>
+ as the default namespace for all classes and properties within this package.
</p>
<p>
- Take special note that the <ja>@XmlSchema</ja> is modelled after the equivalent JAXB annotation, but is
- defined in the <a class='doclink' href='annotation/package-summary.html#TOC'>org.apache.juneau.xml.annotation</a> package.<br>
- Other XML annotations are also modelled after JAXB.
+ Take special note that the <ja>@XmlSchema</ja> is modeled after the equivalent JAXB annotation, but is
+ defined in the <a class='doclink'
+ href='annotation/package-summary.html#TOC'>org.apache.juneau.xml.annotation</a> package.
+ <br>
+ Other XML annotations are also modeled after JAXB.
However, since many of the features of JAXB are already implemented for all serializers and parsers
- at a higher level through various general annotations such as {@link org.apache.juneau.annotation.Bean} and {@link org.apache.juneau.annotation.BeanProperty}
- it was decided to maintain separate Juneau XML annotations instead of reusing JAXB annotations.<br>
- This may change in some future implementation, but for now it was decided that having separate Juneau XML annotations was less confusing.
+ at a higher level through various general annotations such as {@link org.apache.juneau.annotation.Bean}
+ and {@link org.apache.juneau.annotation.BeanProperty} it was decided to maintain separate Juneau XML
+ annotations instead of reusing JAXB annotations.
+ <br>
+ This may change in some future implementation, but for now it was decided that having separate Juneau XML
+ annotations was less confusing.
</p>
<p>
On our bean class, we'll specify to use the <js>"http://www.apache.org/person/"</js> namespace:
@@ -2067,8 +2136,8 @@
<xt></per:person></xt>
</p>
<p>
- We can simplify the output by setting the default namespace on the serializer so that
- all the elements do not need to be prefixed:
+ We can simplify the output by setting the default namespace on the serializer so that all the elements do
+ not need to be prefixed:
<p class='bcode'>
<jc>// Create a new serializer with readable output, this time with namespaces enabled.</jc>
XmlSerializer s = <jk>new</jk> XmlSerializerBuilder()
@@ -2079,7 +2148,8 @@
.build();
</p>
<p>
- This produces the following equivalent where the elements don't need prefixes since they're already in the default document namespace:
+ This produces the following equivalent where the elements don't need prefixes since they're already in the
+ default document namespace:
</p>
<p class='bcode'>
<xt><person</xt>
@@ -2096,13 +2166,18 @@
<h4 class='topic' onclick='toggle(this)'>2.3.1 - Auto-detection of namespaces</h4>
<div class='topic'>
<p>
- One important property on the XML serializer class is {@link org.apache.juneau.xml.XmlSerializerContext#XML_autoDetectNamespaces XML_autoDetectNamespaces}.<br>
- This property tells the serializer to make a first-pass over the data structure to look for namespaces defined on classes and bean properties.<br>
- In high-performance environments, you may want to consider disabling auto-detection and providing your own explicit list of namespaces to the serializer
- to avoid this scanning step.
+ One important property on the XML serializer class is
+ {@link org.apache.juneau.xml.XmlSerializerContext#XML_autoDetectNamespaces XML_autoDetectNamespaces}.
+ <br>
+ This property tells the serializer to make a first-pass over the data structure to look for namespaces
+ defined on classes and bean properties.
+ <br>
+ In high-performance environments, you may want to consider disabling auto-detection and providing your
+ own explicit list of namespaces to the serializer to avoid this scanning step.
</p>
<p>
- The following code will produce the same output as before, but will perform slightly better since it avoids this prescan step.
+ The following code will produce the same output as before, but will perform slightly better since it
+ avoids this pre-scan step.
</p>
<p class='bcode'>
<jc>// Create a new serializer with readable output, this time with namespaces enabled.</jc>
@@ -2122,20 +2197,26 @@
<h3 class='topic' onclick='toggle(this)'>2.4 - @Bean and @BeanProperty annotations</h3>
<div class='topic'>
<p>
- 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>
- In addition to using them to identify the resource URI for the bean shown above, they have various other uses:
+ 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>
+ In addition to using them to identify the resource URI for the bean shown above, they have various other
+ 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 transforms at both the class and property level (to convert non-serializable POJOs to serializable forms).
+ <li>Associating transforms 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 transform with it to transform
- it to an ISO8601 date-time string in GMT time.<br>
- By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you want them serialized.<br>
+ it to an ISO8601 date-time string in GMT time.
+ <br>
+ By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you want
+ them serialized.
+ <br>
Using transforms, we can convert them to standardized string forms.
</p>
<p class='bcode'>
@@ -2148,10 +2229,13 @@
...
<jc>// Normal constructor</jc>
- <jk>public</jk> Person(<jk>int</jk> id, String name, String uri, String addressBookUri, String birthDate) <jk>throws</jk> Exception {
+ <jk>public</jk> Person(<jk>int</jk> id, String name, String uri, String addressBookUri, String birthDate)
+ <jk>throws</jk> Exception {
...
<jk>this</jk>.<jf>birthDate</jf> = <jk>new</jk> GregorianCalendar();
- <jk>this</jk>.<jf>birthDate</jf>.setTime(DateFormat.<jsm>getDateInstance</jsm>(DateFormat.<jsf>MEDIUM</jsf>).parse(birthDate));
+ <jk>this</jk>.<jf>birthDate</jf>
+ .setTime(DateFormat.<jsm>getDateInstance</jsm>(DateFormat.<jsf>MEDIUM</jsf>)
+ .parse(birthDate));
}
}
</p>
@@ -2160,7 +2244,8 @@
</p>
<p class='bcode'>
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
</p>
<p>
Now when we rerun the sample code, we'll get the following:
@@ -2177,8 +2262,9 @@
<xt></per:person></xt>
</p>
<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>
+ 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.
It converts bean property names to lowercase-dashed format.
</p>
@@ -2244,7 +2330,8 @@
XmlSerializer s = <jk>new</jk> XmlSerializerBuilder().ws().sq().build();
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
Address a = <jk>new</jk> Address();
a.<jf>uri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/address/1"</js>);
a.<jf>personUri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/person/1"</js>);
@@ -2291,24 +2378,31 @@
<h3 class='topic' onclick='toggle(this)'>2.6 - XML-Schema support</h3>
<div class='topic'>
<p>
- Juneau provides the {@link org.apache.juneau.xml.XmlSchemaSerializer} class for generating XML-Schema documents
- that describe the output generated by the {@link org.apache.juneau.xml.XmlSerializer} class.<br>
- This class shares the same properties as <code>XmlSerializer</code>.<br>
+ Juneau provides the {@link org.apache.juneau.xml.XmlSchemaSerializer} class for generating XML-Schema
+ documents that describe the output generated by the {@link org.apache.juneau.xml.XmlSerializer} class.
+ <br>
+ This class shares the same properties as <code>XmlSerializer</code>.
+ <br>
Since the XML output differs based on settings on the XML serializer class, the XML-Schema serializer
- class must have the same property values as the XML serializer class it's descriqux.<br>
+ class must have the same property values as the XML serializer class it's describes.
+ <br>
To help facilitate creating an XML Schema serializer with the same properties as the corresponding
- XML serializer, the {@link org.apache.juneau.xml.XmlSerializer#getSchemaSerializer()} method
- has been added.
+ XML serializer, the {@link org.apache.juneau.xml.XmlSerializer#getSchemaSerializer()} method
+ has been added.
</p>
<p>
- XML-Schema requires a separate file for each namespace.<br>
- Unfortunately, does not mesh well with the Juneau serializer architecture which serializes to single writers.<br>
+ XML-Schema requires a separate file for each namespace.
+ <br>
+ Unfortunately, does not mesh well with the Juneau serializer architecture which serializes to single writers.
+ <br>
To get around this limitation, the schema serializer will produce a single output, but with multiple
- schema documents separated by the null character (<js>'\u0000'</js>) to make it simple to split apart.
+ schema documents separated by the null character (<js>'\u0000'</js>) to make it simple to split apart.
</p>
<p>
- Lets start with an example where everything is in the same namespace.<br>
- We'll use the classes from before, but remove the references to namespaces.<br>
+ Lets start with an example where everything is in the same namespace.
+ <br>
+ We'll use the classes from before, but remove the references to namespaces.
+ <br>
Since we have not defined a default namespace, everything is defined under the default Juneau namespace.
</p>
<p class='bcode'>
@@ -2326,7 +2420,8 @@
<jk>public</jk> Person() {}
<jc>// Normal constructor</jc>
- <jk>public</jk> Person(<jk>int</jk> id, String name, String uri, String addressBookUri, String birthDate) <jk>throws</jk> Exception {
+ <jk>public</jk> Person(<jk>int</jk> id, String name, String uri, String addressBookUri, String birthDate)
+ <jk>throws</jk> Exception {
<jk>this</jk>.<jf>id</jf> = id;
<jk>this</jk>.<jf>name</jf> = name;
<jk>this</jk>.<jf>uri</jf> = <jk>new</jk> URI(uri);
@@ -2363,7 +2458,8 @@
XmlSchemaSerializer ss = s.getSchemaSerializer();
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
Address a = <jk>new</jk> Address();
a.<jf>uri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/address/1"</js>);
a.<jf>personUri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/person/1"</js>);
@@ -2611,8 +2707,9 @@
<xt></schema></xt>
</p>
<p>
- For convenience, the {@link org.apache.juneau.xml.XmlSchemaSerializer#getValidator(SerializerSession,Object)} method is provided
- to create a {@link javax.xml.validation.Validator} using the input from the serialize method.
+ For convenience, the {@link org.apache.juneau.xml.XmlSchemaSerializer
+ #getValidator(SerializerSession,Object)} method is provided to create a
+ {@link javax.xml.validation.Validator} using the input from the serialize method.
</p>
</div>
@@ -2623,15 +2720,18 @@
<div class='topic'>
<p>
The XML 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>
+ 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).
+ be thrown (if {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_maxDepth} is not reached
+ first).
</p>
<p>
If you still want to use the XML 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 serialization when a duplicate is encountered.
+ {@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
+ serialization when a duplicate is encountered.
</p>
<p>
For example, let's make a POJO model out of the following classes:
@@ -2685,7 +2785,8 @@
Without recursion detection enabled, this would cause a stack-overflow error.
</p>
<p>
- Recursion detection introduces a performance penalty of around 20%.<br>
+ Recursion detection introduces a performance penalty of around 20%.
+ <br>
For this reason the setting is disabled by default.
</p>
</div>
@@ -2710,8 +2811,11 @@
<h3 class='topic' onclick='toggle(this)'>2.9 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau serializers, the XML 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 always creating new instances.
+ <li>Like all other Juneau serializers, the XML 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
+ always creating new instances.
</ul>
</div>
</div>
@@ -2722,7 +2826,8 @@
<h2 class='topic' onclick='toggle(this)'>3 - XmlParser class</h2>
<div class='topic'>
<p>
- The {@link org.apache.juneau.xml.XmlParser} class is the class used to parse Juneau-generated XML back into POJOs.
+ The {@link org.apache.juneau.xml.XmlParser} class is the class used to parse Juneau-generated XML back into
+ POJOs.
</p>
<p>
A static reusable instance of <code>XmlParser</code> is also provided for convenience:
@@ -2731,7 +2836,8 @@
<li>{@link org.apache.juneau.xml.XmlParser#DEFAULT}
</ul>
<p>
- Let's build upon the previous example and parse the generated XML back into the original bean.<br>
+ Let's build upon the previous example and parse the generated XML back into the original bean.
+ <br>
We start with the XML that was generated.
</p>
<p class='bcode'>
@@ -2739,7 +2845,8 @@
XmlSerializer s = <jk>new</jk> XmlSerializerBuilder().ws().sq().ns().build();
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
Address a = <jk>new</jk> Address();
a.<jf>uri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/address/1"</js>);
a.<jf>personUri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/person/1"</js>);
@@ -2822,22 +2929,24 @@
<h3 class='topic' onclick='toggle(this)'>3.1 - Parsing into generic POJO models</h3>
<div class='topic'>
<p>
- The XML 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
- parse into a generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive
- objects.
+ The XML 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 parse into a
+ generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive objects.
</p>
<p>
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>, <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.
+ 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>,
+ <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>
<p>
- When the map or list type is not specified, or is the abstract <code>Map</code>, <code>Collection</code>, or <code>List</code> types,
- the parser will use <code>ObjectMap</code> and <code>ObjectList</code> by default.
+ When the map or list type is not specified, or is the abstract <code>Map</code>, <code>Collection</code>,
+ or <code>List</code> types, the parser will use <code>ObjectMap</code> and <code>ObjectList</code> by
+ default.
</p>
</div>
@@ -2861,413 +2970,16 @@
<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 XML 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 creating new instances.
+ <li>Like all other Juneau parsers, the XML 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
+ creating new instances.
</ul>
</div>
</div>
-
-<!-- ======================================================================================================== -->
-<a id="RestApiSupport"></a>
-<h2 class='topic' onclick='toggle(this)'>4 - REST API support</h2>
-<div class='topic'>
- <p>
- Juneau provides fully-integrated support for XML serialization/parsing in the REST server and client APIs.<br>
- The next two sections describe these in detail.
- </p>
-
- <!-- ======================================================================================================== -->
- <a id="RestServerSupport"></a>
- <h3 class='topic' onclick='toggle(this)'>4.1 - REST server support</h3>
- <div class='topic'>
- <p>
- There are four general ways of defining REST interfaces with support for XML.
- Two using the built-in Juneau Server API, and two using the JAX-RS integration component.
- </p>
- <ul class='spaced-list'>
- <li>Create a servlet that subclasses from {@link org.apache.juneau.rest.RestServletDefault}.<br>
- This includes XML serialization/parsing support by default, in addition to several other media types.
- <li>Create a servlet that subclasses from {@link org.apache.juneau.rest.RestServlet} and specify the
- an XML serializer and/or parser using the {@link org.apache.juneau.rest.annotation.RestResource#serializers()} and
- {@link org.apache.juneau.rest.annotation.RestResource#parsers()} on the entire servlet class, or
- the {@link org.apache.juneau.rest.annotation.RestMethod#serializers()} and {@link org.apache.juneau.rest.annotation.RestMethod#parsers()}
- annotations on individual methods within the class.
- <li>Register {@link org.apache.juneau.rest.jaxrs.DefaultProvider} with JAX-RS to provide XML support.<br>
- This includes XML serialization/parsing support by default, in addition to several other media types.
- <li>Create and register a subclass of {@link org.apache.juneau.rest.jaxrs.BaseProvider} and specify the serializers and parsers to use on JAX-RS resources.
- </ul>
- <p>
- In general, the Juneau REST server API is much more configurable and easier to use than JAX-RS, but beware that the author may be slightly biased in this statement.
- </p>
-
- <!-- ======================================================================================================== -->
- <a id="RestServletDefault"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.1 - Using RestServletDefault</h4>
- <div class='topic'>
- <p>
- The quickest way to implement a REST resource with XML support is to create a subclass of {@link org.apache.juneau.rest.RestServletDefault}.<br>
- This class provides support for JSON, XML, HTML, URL-Encoding, and others.
- </p>
- <p>
- The <code>AddressBookResource</code> example shown in the first chapter uses the <code>RestServletJenaDefault</code> class
- which is a subclass of <code>RestServletDefault</code> with additional support for RDF languages.<br>
- The start of the class definition is shown below:
- </p>
- <p class='bcode'>
- <jc>// Proof-of-concept resource that shows off the capabilities of working with POJO resources.
- // Consists of an in-memory address book repository.</jc>
- <ja>@RestResource</ja>(
- messages=<js>"nls/AddressBookResource"</js>,
- title=<js>"$L{title}"</js>,
- description=<js>"$L{description}"</js>,
- htmldoc=<ja>@HtmlDoc</ja>(
- links=<js>"{options:'?method=OPTIONS'}"</js>
- ),
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>),
- <ja>@Property</ja>(name=HtmlSerializerContext.<jsf>HTML_uriAnchorText</jsf>, value=<jsf>TO_STRING</jsf>)
- },
- encoders=GzipEncoder.<jk>class</jk>
- )
- <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
- </p>
- <p>
- Notice how serializer and parser properties can be specified using the <code>@RestResource.properties()</code> annotation.<br>
- The <jsf>SERIALIZER_quoteChar</jsf> property is common to all serializers.<br>
- The remaining properties are specific to the HTML serializer.
- </p>
- <p>
- The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the <code>messages</code> annotation.
- These variables are replaced at runtime based on the HTTP request locale.
- Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.
- See {@link org.apache.juneau.rest.RestContext#getVarResolver()} for more information.
- </p>
- <p>
- This document won't go into all the details of the Juneau <code>RestServlet</code> class.<br>
- Refer to the <a class='doclink' href='../rest/package-summary.html#TOC'>org.apache.juneau.rest</a> documentation for more information on the REST servlet class in general.
- </p>
- <p>
- The rest of the code in the resource class consists of REST methods that simply accept and return POJOs.<br>
- The framework takes care of all content negotiation, serialization/parsing, and error handling.<br>
- Below are 3 of those methods to give you a general idea of the concept:
- </p>
- <p class='bcode'>
- <jc>// GET person request handler</jc>
- <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/people/{id}/*"</js>, rc={200,404})
- <jk>public</jk> Person getPerson(RestRequest req, RestResponse res, <ja>@Path</ja> <jk>int</jk> id) throws Exception {
- res.setPageTitle(req.getPathInfo());
- <jk>return</jk> findPerson(id);
- }
-
- <jc>// POST person handler</jc>
- <ja>@RestMethod</ja>(name=<js>"POST"</js>, path=<js>"/people"</js>, guards=AdminGuard.<jk>class</jk>, rc={307,404})
- <jk>public void</jk> createPerson(RestResponse res, <ja>@Body</ja> CreatePerson cp) <jk>throws</jk> Exception {
- Person p = addressBook.createPerson(cp);
- res.sendRedirect(p.<jf>uri</jf>);
- }
-
- <jc>// DELETE person handler</jc>
- <ja>@RestMethod</ja>(name=<js>"DELETE"</js>, path=<js>"/people/{id}"</js>, guards=AdminGuard.<jk>class</jk>, rc={200,404})
- <jk>public</jk> String deletePerson(RestResponse res, <ja>@Path</ja> <jk>int</jk> id) <jk>throws</jk> Exception {
- Person p = findPerson(id);
- addressBook.remove(p);
- <jk>return</jk> <js>"DELETE successful"</js>;
- }
- </p>
- <p>
- The resource class can be registered with the web application like any other servlet, or can be
- defined as a child of another resource through the {@link org.apache.juneau.rest.annotation.RestResource#children()} annotation.
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="RestServlet"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.2 - Using RestServlet with annotations</h4>
- <div class='topic'>
- <p>
- For fine-tuned control of media types, the {@link org.apache.juneau.rest.RestServlet} class
- can be subclassed directly.<br>
- The serializers/parsers can be specified through annotations at the class and/or method levels.
- </p>
- <p>
- An equivalent <code>AddressBookResource</code> class could be defined to only support XML using
- the following definition:
- </p>
- <p class='bcode'>
- <ja>@RestResource</ja>(
- serializers={XmlSerializer.<jk>class</jk>},
- parsers={XmlParser.<jk>class</jk>},
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServlet {
- </p>
- <p>
- Likewise, serializers and parsers can be specified/augmented/overridden at the method level like so:
- </p>
- <p class='bcode'>
- <jc>// GET person request handler</jc>
- <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/people/{id}/*"</js>, rc={200,404},
- serializers={XmlSerializer.<jk>class</jk>},
- parsers={XmlParser.<jk>class</jk>},
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public</jk> Person getPerson(RestRequest req, RestRequest res, <ja>@Path</ja> <jk>int</jk> id) throws Exception {
- res.setPageTitle(req.getPathInfo());
- <jk>return</jk> findPerson(id);
- }
- </p>
- <p>
- The {@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit()} and
- {@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit()} control how various artifacts
- are inherited from the parent class.<br>
- Refer to <a class='doclink' href='../rest/package-summary.html#TOC'>org.apache.juneau.rest</a> for additional information on using these annotations.
- </p>
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="DefaultProvider"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.3 - Using JAX-RS DefaultProvider</h4>
- <div class='topic'>
- <p>
- XML media type support in JAX-RS can be achieved by using the {@link org.apache.juneau.rest.jaxrs.DefaultProvider} class.<br>
- It implements the JAX-RS <code>MessageBodyReader</code> and <code>MessageBodyWriter</code> interfaces for all Juneau supported media types.
- </p>
- <p>
- The <code>DefaultProvider</code> class definition is shown below:
- </p>
- <p class='bcode'>
- <ja>@Provider</ja>
- <ja>@Produces</ja>(
- <js>"application/json,text/json,"</js>+ <jc>// JsonSerializer</jc>
- <js>"application/json+simple,text/json+simple,"</js>+ <jc>// JsonSerializer.Simple</jc>
- <js>"application/json+schema,text/json+schema,"</js>+ <jc>// JsonSchemaSerializer</jc>
- <js>"text/xml,"</js>+ <jc>// XmlDocSerializer</jc>
- <js>"text/xml+simple,"</js>+ <jc>// XmlDocSerializer.Simple</jc>
- <js>"text/xml+schema,"</js>+ <jc>// XmlSchemaDocSerializer</jc>
- <js>"text/html,"</js>+ <jc>// HtmlDocSerializer</jc>
- <js>"application/x-www-form-urlencoded,"</js>+ <jc>// UrlEncodingSerializer</jc>
- <js>"text/xml+soap,"</js>+ <jc>// SoapXmlSerializer</jc>
- <js>"application/x-java-serialized-object"</js> <jc>// JavaSerializedObjectSerializer</jc>
- )
- <ja>@Consumes</ja>(
- <js>"application/json,text/json,"</js>+ <jc>// JsonParser</jc>
- <js>"text/xml,"</js>+ <jc>// XmlParser</jc>
- <js>"text/html,"</js>+ <jc>// HtmlParser</jc>
- <js>"application/x-www-form-urlencoded,"</js>+ <jc>// UrlEncodingParser</jc>
- <js>"application/x-java-serialized-object"</js> <jc>// JavaSerializedObjectParser</jc>
- )
- <ja>@JuneauProvider</ja>(
- serializers={
- JsonSerializer.<jk>class</jk>,
- JsonSerializer.Simple.<jk>class</jk>,
- JsonSchemaSerializer.<jk>class</jk>,
- XmlDocSerializer.<jk>class</jk>,
- XmlDocSerializer.Simple.<jk>class</jk>,
- XmlSchemaDocSerializer.<jk>class</jk>,
- HtmlDocSerializer.<jk>class</jk>,
- UrlEncodingSerializer.<jk>class</jk>,
- SoapXmlSerializer.<jk>class</jk>,
- JavaSerializedObjectSerializer.<jk>class</jk>
- },
- parsers={
- JsonParser.<jk>class</jk>,
- XmlParser.<jk>class</jk>,
- HtmlParser.<jk>class</jk>,
- UrlEncodingParser.<jk>class</jk>,
- JavaSerializedObjectParser.<jk>class</jk>,
- }
- )
- <jk>public final class</jk> DefaultProvider <jk>extends</jk> BaseProvider {}
- </p>
- <p>
- That's the entire class. It consists of only annotations to hook up media types to Juneau serializers and parsers.
- The <ja>@Provider</ja>, <ja>@Produces</ja>, and <ja>@Consumes</ja> annotations are standard JAX-RS annotations, and the <ja>@JuneauProvider</ja> annotation is from Juneau.
- </p>
- <p>
- To enable the provider, you need to make the JAX-RS environment aware of it.
- In Wink, this is accomplished by adding an entry to a config file.
- </p>
- <p class='bcode'>
- <xt><web-app</xt> <xa>version</xa>=<xs>"2.3"</xs><xt>></xt>
- <xt><servlet></xt>
- <xt><servlet-name></xt>WinkService<xt></servlet-name></xt>
- <xt><servlet-class></xt>org.apache.wink.server.internal.servlet.RestServlet<xt></servlet-class></xt>
- <xt><init-param></xt>
- <xt><param-name></xt>applicationConfigLocation<xt></param-name></xt>
- <xt><param-value></xt>/WEB-INF/wink.cfg<xt></param-value></xt>
- <xt></init-param></xt>
- <xt></servlet></xt>
- </p>
- <p>
- Simply include a reference to the provider in the configuration file.
- <p class='bcode'>
- org.apache.juneau.rest.jaxrs.DefaultProvider
- </p>
- <p>
- Properties can be specified on providers through the {@link org.apache.juneau.rest.jaxrs.JuneauProvider#properties()} annotation.<br>
- Properties can also be specified at the method level by using the {@link org.apache.juneau.rest.annotation.RestMethod#properties} annotation, like so:
- </p>
- <p class='bcode'>
- <ja>@GET</ja>
- <ja>@Produces</ja>(<js>"*/*"</js>)
- <ja>@RestMethod</ja>( <jc>/* Override some properties */</jc>
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public</jk> Message getMessage() {
- <jk>return</jk> message;
- }
- </p>
- <h6 class='topic'>Limitations</h6>
- <p>
- In general, the Juneau REST API is considerably more flexible than the JAX-RS API, since you can specify and override
- serializers, parsers, properties, transforms, converters, guards, etc... at both the class and method levels.<br>
- Therefore, the JAX-RS API has the following limitations that the Juneau Server API does not:
- </p>
- <ul class='spaced-list'>
- <li>The ability to specify different media type providers at the class and method levels.<br>
- For example, you may want to use <code>XmlSerializer</code> with one set of properties on
- one class, and another instance with different properties on another class.<br>
- There is currently no way to define this at the class level.<br>
- You can override properties at the method level, but this can be cumbersome since it would have to be
- done for all methods in the resource.
- <li>The Juneau Server API allows you to manipulate properties programatically through the {@link org.apache.juneau.rest.RestResponse#setProperty(String,Object)}
- method, and through the {@link org.apache.juneau.rest.annotation.Properties} annotation.<br>
- There is no equivalent in JAX-RS.
- </ul>
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="BaseProvider"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.4 - Using JAX-RS BaseProvider with annotations</h4>
- <div class='topic'>
- <p>
- To provide support for only XML media types, you can define your own provider class, like so:
- </p>
- <p class='bcode'>
- <ja>@Provider</ja>
- <ja>@Produces</ja>(
- <js>"text/xml,"</js>+ <jc>// XmlDocSerializer</jc>
- <js>"text/xml+simple"</js> <jc>// XmlDocSerializer.Simple</jc>
- )
- <ja>@Consumes</ja>(
- <js>"text/xml"</js> <jc>// XmlParser</jc>
- )
- <ja>@JuneauProvider</ja>(
- serializers={
- XmlDocSerializer.<jk>class</jk>,
- XmlDocSerializer.Simple.<jk>class</jk>
- },
- parsers={
- XmlParser.<jk>class</jk>,
- }
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public final class</jk> MyRdfProvider <jk>extends</jk> BaseProvider {}
- </p>
- <p>
- Then register it with Wink the same way as <code>DefaultProvider</code>.
- </p>
- </div>
-
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="RestClientSupport"></a>
- <h3 class='topic' onclick='toggle(this)'>4.2 - REST client support</h3>
- <div class='topic'>
- <p>
- The {@link org.apache.juneau.rest.client.RestClient} class provides an easy-to-use REST client interface with
- pluggable media type handling using any of the Juneau serializers and parsers.<br>
- Defining a client to support XML media types on HTTP requests and responses can be done in one line of code:
- </p>
- <p class='bcode'>
- <jc>// Create a client to handle XML requests and responses.</jc>
- RestClient client = <jk>new</jk> RestClientBuilder(XmlSerializer.<jk>class</jk>, XmlParser.<jk>class</jk>).build();
- </p>
- <p>
- The client handles all content negotiation based on the registered serializers and parsers.
- </p>
- <p>
- The following code is pulled from the main method of the <code>ClientTest</code> class in the sample web application, and
- is run against the <code>AddressBookResource</code> class running within the sample app.<br>
- It shows how the client can be used to interact with the REST API while completely hiding the negotiated content type and working with nothing more than beans.
- </p>
- <h6 class='figure'>Example</h6>
- <p class='bcode'>
- String root = <js>"http://localhost:9080/sample/addressBook"</js>;
-
- <jc>// Get the current contents of the address book</jc>
- AddressBook ab = client.doGet(root).getResponse(AddressBook.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Number of entries = "</js> + ab.size());
-
- <jc>// Delete the existing entries</jc>
- <jk>for</jk> (Person p : ab) {
- String r = client.doDelete(p.<jf>uri</jf>).getResponse(String.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Deleted person "</js> + p.<jf>name</jf> + <js>", response = "</js> + r);
- }
-
- <jc>// Make sure they're gone</jc>
- ab = client.doGet(root).getResponse(AddressBook.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Number of entries = "</js> + ab.size());
-
- <jc>// Add 1st person again</jc>
- CreatePerson cp = <jk>new</jk> CreatePerson(
- <js>"Barack Obama"</js>,
- <jsm>toCalendar</jsm>(<js>"Aug 4, 1961"</js>),
- <jk>new</jk> CreateAddress(<js>"1600 Pennsylvania Ave"</js>, <js>"Washington"</js>, <js>"DC"</js>, 20500, <jk>true</jk>),
- <jk>new</jk> CreateAddress(<js>"5046 S Greenwood Ave"</js>, <js>"Chicago"</js>, <js>"IL"</js>, 60615, <jk>false</jk>)
- );
- Person p = client.doPost(root + <js>"/people"</js>, cp).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created person "</js> + p.<jf>name</jf> + <js>", uri = "</js> + p.<jf>uri</jf>);
-
- <jc>// Add 2nd person again, but add addresses separately</jc>
- cp = <jk>new</jk> CreatePerson(
- <js>"George Walker Bush"</js>,
- toCalendar(<js>"Jul 6, 1946"</js>)
- );
- p = client.doPost(root + <js>"/people"</js>, cp).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created person "</js> + p.<jf>name</jf> + <js>", uri = "</js> + p.<jf>uri</jf>);
-
- <jc>// Add addresses to 2nd person</jc>
- CreateAddress ca = <jk>new</jk> CreateAddress(<js>"43 Prairie Chapel Rd"</js>, <js>"Crawford"</js>, <js>"TX"</js>, 76638, <jk>true</jk>);
- Address a = client.doPost(p.<jf>uri</jf> + <js>"/addresses"</js>, ca).getResponse(Address.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created address "</js> + a.<jf>uri</jf>);
-
- ca = <jk>new</jk> CreateAddress(<js>"1600 Pennsylvania Ave"</js>, <js>"Washington"</js>, <js>"DC"</js>, 20500, <jk>false</jk>);
- a = client.doPost(p.<jf>uri</jf> + "/addresses"</js>, ca).getResponse(Address.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created address "</js> + a.<jf>uri</jf>);
-
- <jc>// Find 1st person, and change name</jc>
- Person[] pp = client.doGet(root + <js>"?q={name:\"'Barack+Obama'\"}"</js>).getResponse(Person[].<jk>class</jk>);
- String r = client.doPut(pp[0].<jf>uri</jf> + <js>"/name"</js>, <js>"Barack Hussein Obama"</js>).getResponse(String.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Changed name, response = "</js> + r);
- p = client.doGet(pp[0].<jf>uri</jf>).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"New name = "</js> + p.<jf>name</jf>);
- </p>
- <h6 class='figure'>Results</h6>
- <p class='bcode'>
- Number of entries = 2
- Deleted person Barack Obama, response = DELETE successful
- Deleted person George Walker Bush, response = DELETE successful
- Number of entries = 0
- Created person Barack Obama, uri = http://localhost:9080/sample/addressBook/people/3
- Created person George Walker Bush, uri = http://localhost:9080/sample/addressBook/people/4
- Created address http://localhost:9080/sample/addressBook/addresses/7
- Created address http://localhost:9080/sample/addressBook/addresses/8
- Changed name, response = PUT successful
- New name = Barack Hussein Obama
- </p>
- </div>
-</div>
<p align="center"><i><b>*** fín ***</b></i></p>
</body>
[14/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
index a8fd4bd..15701e7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
@@ -17,11 +17,13 @@ import org.apache.juneau.annotation.*;
/**
* A metadata object that allows for more fine-tuned XML model definitions.
* <p>
- * When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.
+ * When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be
+ * used to add that information.
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -42,8 +44,10 @@ public class Xml extends SwaggerElement {
* Bean property getter: <property>name</property>.
* <p>
* Replaces the name of the element/attribute used for the described schema property.
- * When defined within the Items Object (<code>items</code>), it will affect the name of the individual XML elements within the list.
- * When defined alongside <code>type</code> being array (outside the <code>items</code>), it will affect the wrapping element and only if wrapped is <jk>true</jk>.
+ * When defined within the Items Object (<code>items</code>), it will affect the name of the individual XML elements
+ * within the list.
+ * When defined alongside <code>type</code> being array (outside the <code>items</code>), it will affect the
+ * wrapping element and only if wrapped is <jk>true</jk>.
* If wrapped is <jk>false</jk>, it will be ignored.
*
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -56,8 +60,10 @@ public class Xml extends SwaggerElement {
* Bean property setter: <property>name</property>.
* <p>
* Replaces the name of the element/attribute used for the described schema property.
- * When defined within the Items Object (<code>items</code>), it will affect the name of the individual XML elements within the list.
- * When defined alongside <code>type</code> being array (outside the <code>items</code>), it will affect the wrapping element and only if wrapped is <jk>true</jk>.
+ * When defined within the Items Object (<code>items</code>), it will affect the name of the individual XML elements
+ * within the list.
+ * When defined alongside <code>type</code> being array (outside the <code>items</code>), it will affect the
+ * wrapping element and only if wrapped is <jk>true</jk>.
* If wrapped is <jk>false</jk>, it will be ignored.
*
* @param name The new value for the <property>name</property> property on this bean.
@@ -149,7 +155,8 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>attribute</property>.
* <p>
- * Declares whether the property definition translates to an attribute instead of an element. Default value is <jk>false</jk>.
+ * Declares whether the property definition translates to an attribute instead of an element.
+ * Default value is <jk>false</jk>.
*
* @return The value of the <property>attribute</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -160,7 +167,8 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>attribute</property>.
* <p>
- * Declares whether the property definition translates to an attribute instead of an element. Default value is <jk>false</jk>.
+ * Declares whether the property definition translates to an attribute instead of an element.
+ * Default value is <jk>false</jk>.
*
* @param attribute The new value for the <property>attribute</property> property on this bean.
* @return This object (for method chaining).
@@ -184,9 +192,12 @@ public class Xml extends SwaggerElement {
* Bean property getter: <property>wrapped</property>.
* <p>
* MAY be used only for an array definition.
- * Signifies whether the array is wrapped (for example, <code><books><book/><book/><books></code>) or unwrapped (<code><book/><book/></code>).
+ * Signifies whether the array is wrapped (for example,
+ * <code><books><book/><book/><books></code>) or unwrapped
+ * (<code><book/><book/></code>).
* Default value is <jk>false</jk>.
- * The definition takes effect only when defined alongside <code>type</code> being <code>array</code> (outside the <code>items</code>).
+ * The definition takes effect only when defined alongside <code>type</code> being <code>array</code>
+ * (outside the <code>items</code>).
*
* @return The value of the <property>wrapped</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -198,9 +209,12 @@ public class Xml extends SwaggerElement {
* Bean property setter: <property>wrapped</property>.
* <p>
* MAY be used only for an array definition.
- * Signifies whether the array is wrapped (for example, <code><books><book/><book/><books></code>) or unwrapped (<code><book/><book/></code>).
+ * Signifies whether the array is wrapped (for example,
+ * <code><books><book/><book/><books></code>) or unwrapped
+ * (<code><book/><book/></code>).
* Default value is <jk>false</jk>.
- * The definition takes effect only when defined alongside <code>type</code> being <code>array</code> (outside the <code>items</code>).
+ * The definition takes effect only when defined alongside <code>type</code> being <code>array</code>
+ * (outside the <code>items</code>).
*
* @param wrapped The new value for the <property>wrapped</property> property on this bean.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/package.html b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/package.html
index 694657f..bde6318 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/package.html
@@ -69,7 +69,9 @@
<h2 class='topic' onclick='toggle(this)'>1 - Overview</h2>
<div class='topic'>
<p>
- Juneau supports generation and consumption of Swagger 2.0 documents and fragments through the use of DTOs (Data Transfer Objects).<br>
+ Juneau supports generation and consumption of Swagger 2.0 documents and fragments through the use of DTOs
+ (Data Transfer Objects).
+ <br>
It uses existing support for serializing and parsing POJOs to and from JSON to define these objects.
</p>
@@ -162,7 +164,8 @@
<jsm>contact</jsm>().email(<js>"apiteam@swagger.io"</js>)
)
.license(
- <jsm>license</jsm>(<js>"Apache 2.0"</js>).url(<js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js>)
+ <jsm>license</jsm>(<js>"Apache 2.0"</js>)
+ .url(<js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js>)
)
)
.host(<js>"petstore.swagger.io"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java b/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
index 933bc07..7c7110f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
@@ -19,7 +19,7 @@ import java.io.*;
*
* <h5 class='section'>Description:</h5>
* <p>
- * Used to wrap input and output streams withing compression/decompression streams.
+ * Used to wrap input and output streams within compression/decompression streams.
* <p>
* Encoders are registered with <code>RestServlets</code> through the <ja>@RestResource.encoders()</ja> annotation.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
index 194a39f..ae3128e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
@@ -35,8 +35,8 @@ import org.apache.juneau.http.*;
* Adding new entries will cause the entries to be prepended to the group.
* This allows for previous encoders to be overridden through subsequent calls.
* <p>
- * For example, calling <code>groupBuilder.append(E1.<jk>class</jk>,E2.<jk>class</jk>).append(E3.<jk>class</jk>,E4.<jk>class</jk>)</code>
- * will result in the order <code>E3, E4, E1, E2</code>.
+ * For example, calling <code>groupBuilder.append(E1.<jk>class</jk>,E2.<jk>class</jk>).append(E3.<jk>class</jk>,
+ * E4.<jk>class</jk>)</code> will result in the order <code>E3, E4, E1, E2</code>.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
index 2d9a8ed..32958ec 100644
--- a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
@@ -33,6 +33,7 @@ public class EncoderGroupBuilder {
/**
* Clone an existing encoder group builder.
+ *
* @param copyFrom The encoder group that we're copying settings and encoders from.
*/
public EncoderGroupBuilder(EncoderGroup copyFrom) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
index ce0be74..71358d2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
@@ -17,7 +17,8 @@ import org.apache.juneau.html.annotation.*;
import org.apache.juneau.internal.*;
/**
- * Metadata on bean properties specific to the HTML serializers and parsers pulled from the {@link Html @Html} annotation on the bean property.
+ * Metadata on bean properties specific to the HTML serializers and parsers pulled from the {@link Html @Html}
+ * annotation on the bean property.
*/
@SuppressWarnings("rawtypes")
public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
@@ -85,7 +86,8 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should be serialized as plain text instead of HTML.
*
- * @return <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#asPlainText()} is <jk>true</jk>.
+ * @return <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#asPlainText()} is
+ * <jk>true</jk>.
*/
protected boolean isAsPlainText() {
return asPlainText;
@@ -94,7 +96,8 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should not be serialized as an HTML table.
*
- * @return <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#noTables()} is <jk>true</jk>.
+ * @return <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#noTables()} is
+ * <jk>true</jk>.
*/
protected boolean isNoTables() {
return noTables;
@@ -103,7 +106,8 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should not include table headers when serialized as an HTML table.
*
- * @return <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#noTableHeaders()} is <jk>true</jk>.
+ * @return <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#noTableHeaders()} is
+ * <jk>true</jk>.
*/
public boolean isNoTableHeaders() {
return noTableHeaders;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlClassMeta.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
index 5442a2d..a30d977 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
@@ -17,7 +17,8 @@ import org.apache.juneau.html.annotation.*;
import org.apache.juneau.internal.*;
/**
- * Metadata on classes specific to the HTML serializers and parsers pulled from the {@link Html @Html} annotation on the class.
+ * Metadata on classes specific to the HTML serializers and parsers pulled from the {@link Html @Html} annotation on
+ * the class.
*/
public class HtmlClassMeta extends ClassMetaExtended {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
index 694a0a6..fc0c7d3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
@@ -31,8 +31,8 @@ import org.apache.juneau.serializer.*;
*
* <h5 class='section'>Description:</h5>
* <p>
- * Same as {@link HtmlSerializer}, except wraps the response in <code><xt><html></code>, <code><xt><head></code>,
- * and <code><xt><body></code> tags so that it can be rendered in a browser.
+ * Same as {@link HtmlSerializer}, except wraps the response in <code><xt><html></code>,
+ * <code><xt><head></code>, and <code><xt><body></code> tags so that it can be rendered in a browser.
*
* <h5 class='section'>Configurable properties:</h5>
* <p>
@@ -54,6 +54,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public HtmlDocSerializer(PropertyStore propertyStore) {
@@ -67,7 +68,8 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
//--------------------------------------------------------------------------------
@Override /* Serializer */
- public HtmlDocSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ public HtmlDocSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale,
+ TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
return new HtmlDocSerializerSession(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
}
@@ -90,6 +92,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Calls the parent {@link #doSerialize(SerializerSession, Object)} method which invokes just the HTML serializer.
+ *
* @param session The serializer session.
* @param o The object being serialized.
* @throws Exception
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
index 66e7929..40537ab 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
/**
* Properties associated with the {@link HtmlDocSerializer} class.
* <p>
- * These are typically specified via <ja>@RestResource.properties()</ja> and <ja>@RestMethod.properties()</ja> annotations,
- * although they can also be set programmatically via the <code>RestResponse.setProperty()</code> method.
+ * These are typically specified via <ja>@RestResource.properties()</ja> and <ja>@RestMethod.properties()</ja>
+ * annotations, although they can also be set programmatically via the <code>RestResponse.setProperty()</code> method.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -48,17 +48,23 @@ import org.apache.juneau.*;
* </p>
*
* <p>
- * The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the <code>messages</code> annotation.
+ * The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the
+ * <code>messages</code> annotation.
* These variables are replaced at runtime based on the HTTP request locale.
* Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.
*
* <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.
+ * <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.
+ * <li class='jc'><a class="doclink"
+ * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
* <ul>
- * <li class='jc'><a class="doclink" href="../html/HtmlSerializerContext.html#ConfigProperties">HtmlSerializerContext</a> - Configurable properties on the HTML serializer.
+ * <li class='jc'><a class="doclink"
+ * href="../html/HtmlSerializerContext.html#ConfigProperties">HtmlSerializerContext</a>
+ * - Configurable properties on the HTML serializer.
* </ul>
* </ul>
* </ul>
@@ -134,7 +140,8 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * Specifies the text for the subtitle that shows up in the header section of the page generated by the basic template.
+ * Specifies the text for the subtitle that shows up in the header section of the page generated by the basic
+ * template.
* <p>
*
* <h5 class='section'>Example:</h5>
@@ -145,7 +152,8 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <ja>@RestResource</ja>(
* messages=<js>"nls/AddressBookResource"</js>,
* properties={
- * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_description</jsf>, value=<js>"My description"</js>)
+ * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_description</jsf>,
+ alue=<js>"My description"</js>)
* }
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
@@ -223,7 +231,8 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* </p>
* <p>
- * When this property is specified, the {@link #HTMLDOC_title} and {@link #HTMLDOC_description} properties are ignored.
+ * When this property is specified, the {@link #HTMLDOC_title} and {@link #HTMLDOC_description} properties are
+ * ignored.
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -247,9 +256,10 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <p>
* Relative URLs are considered relative to the servlet path.
* For example, if the servlet path is <js>"http://localhost/myContext/myServlet"</js>, and the
- * URL is <js>"foo"</js>, the link becomes <js>"http://localhost/myContext/myServlet/foo"</js>.
+ * URL is <js>"foo"</js>, the link becomes <js>"http://localhost/myContext/myServlet/foo"</js>.
* Absolute (<js>"/myOtherContext/foo"</js>) and fully-qualified (<js>"http://localhost2/foo"</js>) URLs
- * can also be used in addition to various other protocols specified by {@link UriResolver} such as <js>"servlet:/..."</js>.
+ * can also be used in addition to various other protocols specified by {@link UriResolver} such as
+ * <js>"servlet:/..."</js>.
*
* <h5 class='section'>Example:</h5>
* <p>
@@ -258,7 +268,8 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <p class='bcode'>
* <ja>@RestResource</ja>(
* properties={
- * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_links</jsf>, value=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js>)
+ * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_links</jsf>,
+ * value=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js>)
* }
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
@@ -326,9 +337,9 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * Allows you to specifigy the contents of the aside section on the HTML page.
+ * Allows you to specify the contents of the aside section on the HTML page.
* The aside section floats on the right of the page for providing content supporting the serialized content of
- * the page.
+ * the page.
* <p>
* By default, the aside section is empty.
* <p>
@@ -449,7 +460,8 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <p class='bcode'>
* <ja>@RestResource</ja>(
* properties={
- * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_css</jsf>, value=<js>"h3 { color: red; }\nh5 { font-weight: bold; }"</js>)
+ * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_css</jsf>,
+ * value=<js>"h3 { color: red; }\nh5 { font-weight: bold; }"</js>)
* }
* )
* </p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
index 5d136cb..8e20a3e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
@@ -57,7 +57,8 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
* Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
- protected HtmlDocSerializerSession(HtmlDocSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ protected HtmlDocSerializerSession(HtmlDocSerializerContext ctx, ObjectMap op, Object output, Method javaMethod,
+ Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
super(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
if (op == null || op.isEmpty()) {
title = ctx.title;
@@ -93,8 +94,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_cssUrl} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_cssUrl} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * <jk>null</jk> if not specified. Never an empty string.
*/
public final String getCssUrl() {
return cssUrl;
@@ -102,6 +104,7 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_css} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_css} setting value in this context.
* <jk>null</jk> if not specified. Never an empty array.
*/
@@ -111,6 +114,7 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_nowrap} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_nowrap} setting value in this context.
*/
public final boolean isNoWrap() {
@@ -119,8 +123,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_title} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_title} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * <jk>null</jk> if not specified. Never an empty string.
*/
public final String getTitle() {
return title;
@@ -128,8 +133,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_description} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_description} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * <jk>null</jk> if not specified. Never an empty string.
*/
public final String getDescription() {
return description;
@@ -137,8 +143,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_branding} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_branding} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * <jk>null</jk> if not specified. Never an empty string.
*/
public final String getBranding() {
return branding;
@@ -146,8 +153,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_header} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_header} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * <jk>null</jk> if not specified. Never an empty string.
*/
public final String getHeader() {
return header;
@@ -155,8 +163,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_links} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_links} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty map.
+ * <jk>null</jk> if not specified. Never an empty map.
*/
public final Map<String,Object> getLinks() {
return links;
@@ -164,8 +173,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the template to use for generating the HTML page.
+ *
* @return The HTML page generator.
- * Never <jk>null</jk>.
+ * Never <jk>null</jk>.
*/
public final HtmlDocTemplate getTemplate() {
return template;
@@ -173,8 +183,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_nav} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_nav} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * <jk>null</jk> if not specified. Never an empty string.
*/
public final String getNav() {
return nav;
@@ -182,8 +193,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_aside} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_aside} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * <jk>null</jk> if not specified. Never an empty string.
*/
public final String getAside() {
return aside;
@@ -191,8 +203,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_footer} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_footer} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * <jk>null</jk> if not specified. Never an empty string.
*/
public final String getFooter() {
return footer;
@@ -200,8 +213,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_noResultsMessage} setting value in this context.
+ *
* @return The {@link HtmlDocSerializerContext#HTMLDOC_noResultsMessage} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * <jk>null</jk> if not specified. Never an empty string.
*/
public final String getNoResultsMessage() {
return noResultsMessage;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
index 8de526b..2e743f6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
@@ -13,7 +13,8 @@
package org.apache.juneau.html;
/**
- * Defines the interface for rendering the contents of an HTML page produced by the {@link HtmlDocSerializer} serializer.
+ * Defines the interface for rendering the contents of an HTML page produced by the {@link HtmlDocSerializer}
+ * serializer.
* <p>
* The HTML doc serializer produces the following document structure with the typical contents:
* <p class='bcode'>
@@ -51,6 +52,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><head></xt></code> element.
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param s The serializer calling this method.
@@ -60,7 +62,9 @@ public interface HtmlDocTemplate {
public void head(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;
/**
- * Renders the contents of the <code><xt><head></xt>/<xt><style</xt> <xa>type</xa>=<xs>"text/css"</xs><xt>></xt></code> element.
+ * Renders the contents of the <code><xt><head></xt>/<xt><style</xt>
+ * <xa>type</xa>=<xs>"text/css"</xs><xt>></xt></code> element.
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param s The serializer calling this method.
@@ -71,6 +75,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt></code> element.
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param s The serializer calling this method.
@@ -81,6 +86,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><header></xt></code> element.
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param s The serializer calling this method.
@@ -91,6 +97,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><nav></xt></code> element.
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param s The serializer calling this method.
@@ -101,6 +108,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><article></xt></code> element.
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param s The serializer calling this method.
@@ -111,6 +119,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><aside></xt></code> element.
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param s The serializer calling this method.
@@ -121,6 +130,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><footer></xt></code> element.
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param s The serializer calling this method.
@@ -130,35 +140,45 @@ public interface HtmlDocTemplate {
public void footer(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;
/**
- * Returns <jk>true</jk> if this page should render a <code><xt><head></xt>/<xt><style</xt> <xa>type</xa>=<xs>"text/css"</xs><xt>></xt></code> element.
+ * Returns <jk>true</jk> if this page should render a <code><xt><head></xt>/<xt><style</xt>
+ * <xa>type</xa>=<xs>"text/css"</xs><xt>></xt></code> element.
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
public boolean hasCss(HtmlDocSerializerSession session);
/**
- * Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><header></xt></code> element.
+ * Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><header></xt></code>
+ * element.
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
public boolean hasHeader(HtmlDocSerializerSession session);
/**
- * Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><nav></xt></code> element.
+ * Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><nav></xt></code>
+ * element.
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
public boolean hasNav(HtmlDocSerializerSession session);
/**
- * Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><aside></xt></code> element.
+ * Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><aside></xt></code>
+ * element.
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
public boolean hasAside(HtmlDocSerializerSession session);
/**
- * Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><footer></xt></code> element.
+ * Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><footer></xt></code>
+ * element.
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
index 67fb799..99a9688 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
@@ -123,7 +123,8 @@ public class HtmlDocTemplateBasic implements HtmlDocTemplate {
if (v.startsWith("<"))
w.append(v);
else
- w.oTag("a").attr("class", "link").attr("href", session.resolveUri(v), true).cTag().text(e.getKey(), true).eTag("a");
+ w.oTag("a").attr("class", "link").attr("href", session.resolveUri(v), true).cTag()
+ .text(e.getKey(), true).eTag("a");
}
}
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java
index 08c1808..5748815 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java
@@ -24,7 +24,8 @@ import java.lang.annotation.*;
* <p>
* Annotation that can be used to specify that a class has a URL associated with it.
* <p>
- * When rendered using the {@link org.apache.juneau.html.HtmlSerializer HtmlSerializer} class, this class will get rendered as a hyperlink like so...
+ * When rendered using the {@link org.apache.juneau.html.HtmlSerializer HtmlSerializer} class, this class will get
+ * rendered as a hyperlink like so...
* <p class='code'>
* <xt><a</xt> <xa>href</xa>=<xs>'hrefProperty'</xs><xt>></xt>nameProperty<xt></a></xt>
* </p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java
index 0e2b201..b28e73b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java
@@ -61,6 +61,7 @@ public class HtmlParser extends XmlParser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public HtmlParser(PropertyStore propertyStore) {
@@ -79,7 +80,8 @@ public class HtmlParser extends XmlParser {
* Precondition: Must be pointing at outer START_ELEMENT.
* Postcondition: Pointing at outer END_ELEMENT.
*/
- private <T> T parseAnything(HtmlParserSession session, ClassMeta<T> eType, XMLStreamReader r, Object outer, boolean isRoot, BeanPropertyMeta pMeta) throws Exception {
+ private <T> T parseAnything(HtmlParserSession session, ClassMeta<T> eType, XMLStreamReader r, Object outer,
+ boolean isRoot, BeanPropertyMeta pMeta) throws Exception {
if (eType == null)
eType = (ClassMeta<T>)object();
@@ -134,7 +136,8 @@ public class HtmlParser extends XmlParser {
else
isValid = false;
- } else if (tag == STRING || (tag == A && pMeta != null && pMeta.getExtendedMeta(HtmlBeanPropertyMeta.class).getLink() != null)) {
+ } else if (tag == STRING || (tag == A && pMeta != null
+ && pMeta.getExtendedMeta(HtmlBeanPropertyMeta.class).getLink() != null)) {
String text = session.getElementText(r);
if (sType.isObject() || sType.isCharSequence())
o = text;
@@ -197,9 +200,11 @@ public class HtmlParser extends XmlParser {
if (typeName.equals("object")) {
if (sType.isObject()) {
- o = parseIntoMap(session, r, (Map)new ObjectMap(session), sType.getKeyType(), sType.getValueType(), pMeta);
+ o = parseIntoMap(session, r, (Map)new ObjectMap(session), sType.getKeyType(), sType.getValueType(),
+ pMeta);
} else if (sType.isMap()) {
- o = parseIntoMap(session, r, (Map)(sType.canCreateNewInstance(outer) ? sType.newInstance(outer) : new ObjectMap(session)), sType.getKeyType(), sType.getValueType(), pMeta);
+ o = parseIntoMap(session, r, (Map)(sType.canCreateNewInstance(outer) ? sType.newInstance(outer)
+ : new ObjectMap(session)), sType.getKeyType(), sType.getValueType(), pMeta);
} else if (sType.canCreateNewBean(outer)) {
BeanMap m = session.newBeanMap(outer, sType.getInnerClass());
o = parseIntoBean(session, r, m).getBean();
@@ -212,7 +217,8 @@ public class HtmlParser extends XmlParser {
if (sType.isObject())
o = parseTableIntoCollection(session, r, (Collection)new ObjectList(session), sType, pMeta);
else if (sType.isCollection())
- o = parseTableIntoCollection(session, r, (Collection)(sType.canCreateNewInstance(outer) ? sType.newInstance(outer) : new ObjectList(session)), sType, pMeta);
+ o = parseTableIntoCollection(session, r, (Collection)(sType.canCreateNewInstance(outer)
+ ? sType.newInstance(outer) : new ObjectList(session)), sType, pMeta);
else if (sType.isArray() || sType.isArgs()) {
ArrayList l = (ArrayList)parseTableIntoCollection(session, r, new ArrayList(), sType, pMeta);
o = session.toArray(sType, l);
@@ -234,7 +240,8 @@ public class HtmlParser extends XmlParser {
if (sType.isObject())
o = parseIntoCollection(session, r, new ObjectList(session), sType, pMeta);
else if (sType.isCollection() || sType.isObject())
- o = parseIntoCollection(session, r, (Collection)(sType.canCreateNewInstance(outer) ? sType.newInstance(outer) : new ObjectList(session)), sType, pMeta);
+ o = parseIntoCollection(session, r, (Collection)(sType.canCreateNewInstance(outer)
+ ? sType.newInstance(outer) : new ObjectList(session)), sType, pMeta);
else if (sType.isArray() || sType.isArgs())
o = session.toArray(sType, parseIntoCollection(session, r, new ArrayList(), sType, pMeta));
else
@@ -286,7 +293,8 @@ public class HtmlParser extends XmlParser {
/*
* Reads an anchor tag and converts it into a bean.
*/
- private static <T> T parseAnchor(HtmlParserSession session, XMLStreamReader r, ClassMeta<T> beanType) throws XMLStreamException {
+ private static <T> T parseAnchor(HtmlParserSession session, XMLStreamReader r, ClassMeta<T> beanType)
+ throws XMLStreamException {
String href = r.getAttributeValue(null, "href");
String name = session.getElementText(r);
Class<T> beanClass = beanType.getInnerClass();
@@ -312,7 +320,8 @@ public class HtmlParser extends XmlParser {
* Precondition: Must be pointing at <table> event.
* Postcondition: Pointing at next START_ELEMENT or END_DOCUMENT event.
*/
- private <K,V> Map<K,V> parseIntoMap(HtmlParserSession session, XMLStreamReader r, Map<K,V> m, ClassMeta<K> keyType, ClassMeta<V> valueType, BeanPropertyMeta pMeta) throws Exception {
+ private <K,V> Map<K,V> parseIntoMap(HtmlParserSession session, XMLStreamReader r, Map<K,V> m, ClassMeta<K> keyType,
+ ClassMeta<V> valueType, BeanPropertyMeta pMeta) throws Exception {
while (true) {
HtmlTag tag = nextTag(r, TR, xTABLE);
if (tag == xTABLE)
@@ -341,7 +350,8 @@ public class HtmlParser extends XmlParser {
* Precondition: Must be pointing at event following <ul> event.
* Postcondition: Pointing at next START_ELEMENT or END_DOCUMENT event.
*/
- private <E> Collection<E> parseIntoCollection(HtmlParserSession session, XMLStreamReader r, Collection<E> l, ClassMeta<?> type, BeanPropertyMeta pMeta) throws Exception {
+ private <E> Collection<E> parseIntoCollection(HtmlParserSession session, XMLStreamReader r, Collection<E> l,
+ ClassMeta<?> type, BeanPropertyMeta pMeta) throws Exception {
int argIndex = 0;
while (true) {
HtmlTag tag = nextTag(r, LI, xUL);
@@ -358,7 +368,8 @@ public class HtmlParser extends XmlParser {
* Precondition: Must be pointing at event following <ul> event.
* Postcondition: Pointing at next START_ELEMENT or END_DOCUMENT event.
*/
- private <E> Collection<E> parseTableIntoCollection(HtmlParserSession session, XMLStreamReader r, Collection<E> l, ClassMeta<E> type, BeanPropertyMeta pMeta) throws Exception {
+ private <E> Collection<E> parseTableIntoCollection(HtmlParserSession session, XMLStreamReader r, Collection<E> l,
+ ClassMeta<E> type, BeanPropertyMeta pMeta) throws Exception {
HtmlTag tag = nextTag(r, TR);
List<String> keys = new ArrayList<String>();
@@ -411,7 +422,8 @@ public class HtmlParser extends XmlParser {
l.add(m == null ? null : (E)m.getBean());
} else {
String c = getAttributes(r).get(session.getBeanTypePropertyName(type.getElementType()));
- Map m = (Map)(elementType.isMap() && elementType.canCreateNewInstance(l) ? elementType.newInstance(l) : new ObjectMap(session));
+ Map m = (Map)(elementType.isMap() && elementType.canCreateNewInstance(l) ? elementType.newInstance(l)
+ : new ObjectMap(session));
for (int i = 0; i < keys.size(); i++) {
tag = nextTag(r, TD, NULL);
if (tag == NULL) {
@@ -497,7 +509,9 @@ public class HtmlParser extends XmlParser {
if (t == tag)
return tag;
- throw new XMLStreamException("Unexpected tag: " + tag + ". Expected one of the following: " + JsonSerializer.DEFAULT.toString(expected), r.getLocation());
+ throw new XMLStreamException(
+ "Unexpected tag: " + tag + ". Expected one of the following: "
+ + JsonSerializer.DEFAULT.toString(expected), r.getLocation());
}
/**
@@ -513,7 +527,9 @@ public class HtmlParser extends XmlParser {
int et = r.getEventType();
if (et != START_ELEMENT)
- throw new XMLStreamException("skipToNextTag() call on invalid event ["+XmlUtils.toReadableEvent(r)+"]. Must only be called on START_ELEMENT events.");
+ throw new XMLStreamException(
+ "skipToNextTag() call on invalid event ["+XmlUtils.toReadableEvent(r)
+ +"]. Must only be called on START_ELEMENT events.");
String n = r.getLocalName();
@@ -539,7 +555,9 @@ public class HtmlParser extends XmlParser {
if (tag.isOneOf(expected))
r.next();
else
- throw new XMLStreamException("Unexpected tag: " + tag + ". Expected one of the following: " + JsonSerializer.DEFAULT.toString(expected), r.getLocation());
+ throw new XMLStreamException(
+ "Unexpected tag: " + tag + ". Expected one of the following: "
+ + JsonSerializer.DEFAULT.toString(expected), r.getLocation());
}
private static int skipWs(XMLStreamReader r) throws XMLStreamException {
@@ -555,7 +573,8 @@ public class HtmlParser extends XmlParser {
//--------------------------------------------------------------------------------
@Override /* Parser */
- public HtmlParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public HtmlParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale,
+ TimeZone timeZone, MediaType mediaType) {
return new HtmlParserSession(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);
}
@@ -566,13 +585,16 @@ public class HtmlParser extends XmlParser {
}
@Override /* ReaderParser */
- protected <K,V> Map<K,V> doParseIntoMap(ParserSession session, Map<K,V> m, Type keyType, Type valueType) throws Exception {
+ protected <K,V> Map<K,V> doParseIntoMap(ParserSession session, Map<K,V> m, Type keyType, Type valueType)
+ throws Exception {
HtmlParserSession s = (HtmlParserSession)session;
- return parseIntoMap(s, s.getXmlStreamReader(), m, (ClassMeta<K>)s.getClassMeta(keyType), (ClassMeta<V>)s.getClassMeta(valueType), null);
+ return parseIntoMap(s, s.getXmlStreamReader(), m, (ClassMeta<K>)s.getClassMeta(keyType),
+ (ClassMeta<V>)s.getClassMeta(valueType), null);
}
@Override /* ReaderParser */
- protected <E> Collection<E> doParseIntoCollection(ParserSession session, Collection<E> c, Type elementType) throws Exception {
+ protected <E> Collection<E> doParseIntoCollection(ParserSession session, Collection<E> c, Type elementType)
+ throws Exception {
HtmlParserSession s = (HtmlParserSession)session;
return parseIntoCollection(s, s.getXmlStreamReader(), c, s.getClassMeta(elementType), null);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
index 8504f6b..e27737a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
@@ -25,9 +25,11 @@ import org.apache.juneau.xml.*;
*
* <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.
+ * <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.
+ * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> -
+ * Configurable properties common to all parsers.
* </ul>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java
index 092aa0c..5e7881f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java
@@ -62,7 +62,8 @@ public final class HtmlParserSession extends XmlParserSession {
* If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
*/
- public HtmlParserSession(HtmlParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public HtmlParserSession(HtmlParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer,
+ Locale locale, TimeZone timeZone, MediaType mediaType) {
super(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
index fabcdaa..7420331 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
@@ -35,13 +35,12 @@ import org.apache.juneau.transform.*;
*
* <h5 class='section'>Description:</h5>
* <p>
- * Essentially the same as {@link HtmlSerializer}, except serializes the POJO metamodel
- * instead of the model itself.
+ * Essentially the same as {@link HtmlSerializer}, except serializes the POJO metamodel instead of the model itself.
* <p>
* Produces output that describes the POJO metamodel similar to an XML schema document.
* <p>
* The easiest way to create instances of this class is through the {@link HtmlSerializer#getSchemaSerializer()},
- * which will create a schema serializer with the same settings as the originating serializer.
+ * which will create a schema serializer with the same settings as the originating serializer.
*/
@Produces(value="text/html+schema", contentType="text/html")
public final class HtmlSchemaDocSerializer extends HtmlDocSerializer {
@@ -51,6 +50,7 @@ public final class HtmlSchemaDocSerializer extends HtmlDocSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store to use for creating the context for this serializer.
*/
public HtmlSchemaDocSerializer(PropertyStore propertyStore) {
@@ -60,6 +60,7 @@ public final class HtmlSchemaDocSerializer extends HtmlDocSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store to use for creating the context for this serializer.
* @param overrideProperties
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
index b5ab39c..77e93a9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
@@ -41,13 +41,16 @@ import org.apache.juneau.xml.annotation.*;
* <p>
* The conversion is as follows...
* <ul class='spaced-list'>
- * <li>{@link Map Maps} (e.g. {@link HashMap}, {@link TreeMap}) and beans are converted to HTML tables with 'key' and 'value' columns.
- * <li>{@link Collection Collections} (e.g. {@link HashSet}, {@link LinkedList}) and Java arrays are converted to HTML ordered lists.
+ * <li>{@link Map Maps} (e.g. {@link HashMap}, {@link TreeMap}) and beans are converted to HTML tables with
+ * 'key' and 'value' columns.
+ * <li>{@link Collection Collections} (e.g. {@link HashSet}, {@link LinkedList}) and Java arrays are converted
+ * to HTML ordered lists.
* <li>{@code Collections} of {@code Maps} and beans are converted to HTML tables with keys as headers.
* <li>Everything else is converted to text.
* </ul>
* <p>
- * This serializer provides several serialization options. Typically, one of the predefined <jsf>DEFAULT</jsf> serializers will be sufficient.
+ * This serializer provides several serialization options. Typically, one of the predefined <jsf>DEFAULT</jsf>
+ * serializers will be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
* <p>
* The {@link HtmlLink} annotation can be used on beans to add hyperlinks to the output.
@@ -146,6 +149,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public Sq(PropertyStore propertyStore) {
@@ -164,6 +168,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public SqReadable(PropertyStore propertyStore) {
@@ -182,6 +187,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public HtmlSerializer(PropertyStore propertyStore) {
@@ -196,10 +202,10 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Main serialization routine.
+ *
* @param session The serialization context object.
* @param o The object being serialized.
* @param w The writer to serialize to.
- *
* @return The same writer passed in.
* @throws IOException If a problem occurred trying to send output to the writer.
*/
@@ -215,7 +221,8 @@ public class HtmlSerializer extends XmlSerializer {
* @param out The writer.
* @param o The object to serialize.
* @param eType The expected type of the object if this is a bean property.
- * @param name The attribute name of this object if this object was a field in a JSON object (i.e. key of a {@link java.util.Map.Entry} or property name of a bean).
+ * @param name The attribute name of this object if this object was a field in a JSON object (i.e. key of a
+ * {@link java.util.Map.Entry} or property name of a bean).
* @param indent The current indentation value.
* @param pMeta The bean property being serialized, or <jk>null</jk> if we're not serializing a bean property.
* @param isRoot <jk>true</jk> if this is the root element of the document.
@@ -223,7 +230,8 @@ public class HtmlSerializer extends XmlSerializer {
* @throws Exception If a problem occurred trying to convert the output.
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
- protected ContentResult serializeAnything(HtmlSerializerSession session, HtmlWriter out, Object o, ClassMeta<?> eType, String name, int indent, BeanPropertyMeta pMeta, boolean isRoot) throws Exception {
+ protected ContentResult serializeAnything(HtmlSerializerSession session, HtmlWriter out, Object o,
+ ClassMeta<?> eType, String name, int indent, BeanPropertyMeta pMeta, boolean isRoot) throws Exception {
ClassMeta<?> aType = null; // The actual type
ClassMeta<?> wType = null; // The wrapped type (delegate)
@@ -362,7 +370,8 @@ public class HtmlSerializer extends XmlSerializer {
}
@SuppressWarnings({ "rawtypes", "unchecked" })
- private void serializeMap(HtmlSerializerSession session, HtmlWriter out, Map m, ClassMeta<?> sType, ClassMeta<?> eKeyType, ClassMeta<?> eValueType, String typeName, BeanPropertyMeta ppMeta) throws Exception {
+ private void serializeMap(HtmlSerializerSession session, HtmlWriter out, Map m, ClassMeta<?> sType,
+ ClassMeta<?> eKeyType, ClassMeta<?> eValueType, String typeName, BeanPropertyMeta ppMeta) throws Exception {
ClassMeta<?> keyType = eKeyType == null ? session.string() : eKeyType;
ClassMeta<?> valueType = eValueType == null ? session.object() : eValueType;
@@ -376,7 +385,8 @@ public class HtmlSerializer extends XmlSerializer {
out.attr(session.getBeanTypePropertyName(sType), typeName);
out.append(">").nl(i+1);
- if (session.isAddKeyValueTableHeaders() && ! (aType.getExtendedMeta(HtmlClassMeta.class).isNoTableHeaders() || (ppMeta != null && ppMeta.getExtendedMeta(HtmlBeanPropertyMeta.class).isNoTableHeaders()))) {
+ if (session.isAddKeyValueTableHeaders() && ! (aType.getExtendedMeta(HtmlClassMeta.class).isNoTableHeaders()
+ || (ppMeta != null && ppMeta.getExtendedMeta(HtmlBeanPropertyMeta.class).isNoTableHeaders()))) {
out.sTag(i+1, "tr").nl(i+2);
out.sTag(i+2, "th").append("key").eTag("th").nl(i+3);
out.sTag(i+2, "th").append("value").eTag("th").nl(i+3);
@@ -420,7 +430,8 @@ public class HtmlSerializer extends XmlSerializer {
out.ie(i).eTag("table").nl(i);
}
- private void serializeBeanMap(HtmlSerializerSession session, HtmlWriter out, BeanMap<?> m, ClassMeta<?> eType, BeanPropertyMeta ppMeta) throws Exception {
+ private void serializeBeanMap(HtmlSerializerSession session, HtmlWriter out, BeanMap<?> m, ClassMeta<?> eType,
+ BeanPropertyMeta ppMeta) throws Exception {
int i = session.getIndent();
out.oTag(i, "table");
@@ -430,7 +441,8 @@ public class HtmlSerializer extends XmlSerializer {
out.attr(session.getBeanTypePropertyName(m.getClassMeta()), typeName);
out.append('>').nl(i);
- if (session.isAddKeyValueTableHeaders() && ! (m.getClassMeta().getExtendedMeta(HtmlClassMeta.class).isNoTableHeaders() || (ppMeta != null && ppMeta.getExtendedMeta(HtmlBeanPropertyMeta.class).isNoTableHeaders()))) {
+ if (session.isAddKeyValueTableHeaders() && ! (m.getClassMeta().getExtendedMeta(HtmlClassMeta.class).isNoTableHeaders()
+ || (ppMeta != null && ppMeta.getExtendedMeta(HtmlBeanPropertyMeta.class).isNoTableHeaders()))) {
out.sTag(i+1, "tr").nl(i+1);
out.sTag(i+2, "th").append("key").eTag("th").nl(i+2);
out.sTag(i+2, "th").append("value").eTag("th").nl(i+2);
@@ -483,7 +495,8 @@ public class HtmlSerializer extends XmlSerializer {
}
@SuppressWarnings({ "rawtypes", "unchecked" })
- private void serializeCollection(HtmlSerializerSession session, HtmlWriter out, Object in, ClassMeta<?> sType, ClassMeta<?> eType, String name, BeanPropertyMeta ppMeta) throws Exception {
+ private void serializeCollection(HtmlSerializerSession session, HtmlWriter out, Object in, ClassMeta<?> sType,
+ ClassMeta<?> eType, String name, BeanPropertyMeta ppMeta) throws Exception {
ClassMeta<?> seType = sType.getElementType();
if (seType == null)
@@ -508,7 +521,8 @@ public class HtmlSerializer extends XmlSerializer {
HtmlBeanPropertyMeta hbpMeta = (ppMeta == null ? null : ppMeta.getExtendedMeta(HtmlBeanPropertyMeta.class));
String btpn = session.getBeanTypePropertyName(eType);
- // Look at the objects to see how we're going to handle them. Check the first object to see how we're going to handle this.
+ // Look at the objects to see how we're going to handle them. Check the first object to see how we're going to
+ // handle this.
// If it's a map or bean, then we'll create a table.
// Otherwise, we'll create a list.
Object[] th = getTableHeaders(session, c, hbpMeta);
@@ -767,7 +781,8 @@ public class HtmlSerializer extends XmlSerializer {
//--------------------------------------------------------------------------------
@Override /* Serializer */
- public HtmlSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ public HtmlSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale,
+ TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
return new HtmlSerializerSession(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
index 5073f67..3a3c620 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
@@ -35,6 +35,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public HtmlSerializerBuilder(PropertyStore propertyStore) {
@@ -62,15 +63,17 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
* </ul>
* <p>
* When creating anchor tags (e.g. <code><xt><a</xt> <xa>href</xa>=<xs>'...'</xs><xt>></xt>text<xt></a></xt></code>)
- * in HTML, this setting defines what to set the inner text to.
+ * in HTML, this setting defines what to set the inner text to.
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li>{@link HtmlSerializerContext#TO_STRING} / <js>"toString"</js> - Set to whatever is returned by {@link #toString()} on the object.
+ * <li>{@link HtmlSerializerContext#TO_STRING} / <js>"toString"</js> - Set to whatever is returned by
+ * {@link #toString()} on the object.
* <li>{@link HtmlSerializerContext#URI} / <js>"uri"</js> - Set to the URI value.
* <li>{@link HtmlSerializerContext#LAST_TOKEN} / <js>"lastToken"</js> - Set to the last token of the URI value.
* <li>{@link HtmlSerializerContext#PROPERTY_NAME} / <js>"propertyName"</js> - Set to the bean property name.
- * <li>{@link HtmlSerializerContext#URI_ANCHOR} / <js>"uriAnchor"</js> - Set to the anchor of the URL. (e.g. <js>"http://localhost:9080/foobar#anchorTextHere"</js>)
+ * <li>{@link HtmlSerializerContext#URI_ANCHOR} / <js>"uriAnchor"</js> - Set to the anchor of the URL.
+ * (e.g. <js>"http://localhost:9080/foobar#anchorTextHere"</js>)
* </ul>
* <p>
* <h5 class='section'>Notes:</h5>
@@ -143,7 +146,8 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
}
/**
- * <b>Configuration property:</b> The parameter name to use when using {@link HtmlSerializerContext#HTML_lookForLabelParameters}.
+ * <b>Configuration property:</b> The parameter name to use when using
+ * {@link HtmlSerializerContext#HTML_lookForLabelParameters}.
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.labelParameter"</js>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
index fded1ab..11a43c0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
@@ -26,9 +26,11 @@ import org.apache.juneau.xml.*;
*
* <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.
+ * <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.
+ * <li class='jc'><a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">
+ * SerializerContext</a> - Configurable properties common to all serializers.
* </ul>
* </ul>
*/
@@ -44,16 +46,18 @@ public class HtmlSerializerContext extends XmlSerializerContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * When creating anchor tags (e.g. <code><xt><a</xt> <xa>href</xa>=<xs>'...'</xs><xt>></xt>text<xt></a></xt></code>)
- * in HTML, this setting defines what to set the inner text to.
+ * When creating anchor tags (e.g. <code><xt><a</xt> <xa>href</xa>=<xs>'...'</xs>
+ * <xt>></xt>text<xt></a></xt></code>) in HTML, this setting defines what to set the inner text to.
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li>{@link #TO_STRING} / <js>"toString"</js> - Set to whatever is returned by {@link #toString()} on the object.
+ * <li>{@link #TO_STRING} / <js>"toString"</js> - Set to whatever is returned by {@link #toString()} on the
+ * object.
* <li>{@link #URI} / <js>"uri"</js> - Set to the URI value.
* <li>{@link #LAST_TOKEN} / <js>"lastToken"</js> - Set to the last token of the URI value.
* <li>{@link #PROPERTY_NAME} / <js>"propertyName"</js> - Set to the bean property name.
- * <li>{@link #URI_ANCHOR} / <js>"uriAnchor"</js> - Set to the anchor of the URL. (e.g. <js>"http://localhost:9080/foobar#anchorTextHere"</js>)
+ * <li>{@link #URI_ANCHOR} / <js>"uriAnchor"</js> - Set to the anchor of the URL.
+ * (e.g. <js>"http://localhost:9080/foobar#anchorTextHere"</js>)
* </ul>
*/
public static final String HTML_uriAnchorText = "HtmlSerializer.uriAnchorText";
@@ -81,7 +85,7 @@ public class HtmlSerializerContext extends XmlSerializerContext {
* </ul>
* <p>
* If a string looks like a URL (e.g. starts with <js>"http://"</js> or <js>"https://"</js>, then treat it like a URL
- * and make it into a hyperlink based on the rules specified by {@link #HTML_uriAnchorText}.
+ * and make it into a hyperlink based on the rules specified by {@link #HTML_uriAnchorText}.
*/
public static final String HTML_detectLinksInStrings = "HtmlSerializer.detectLinksInStrings";
@@ -110,7 +114,6 @@ public class HtmlSerializerContext extends XmlSerializerContext {
* <li><b>Default:</b> <js>"label"</js>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- * <p>
*/
public static final String HTML_labelParameter = "HtmlSerializer.labelParameter";
@@ -123,7 +126,6 @@ public class HtmlSerializerContext extends XmlSerializerContext {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- * <p>
*/
public static final String HTML_addKeyValueTableHeaders = "HtmlSerializer.addKeyValueTableHeaders";
@@ -137,9 +139,11 @@ public class HtmlSerializerContext extends XmlSerializerContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred through reflection.
+ * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
+ * through reflection.
* 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.
+ * For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined
+ * from the value type.
* <p>
* When present, this value overrides the {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -169,7 +173,8 @@ public class HtmlSerializerContext extends XmlSerializerContext {
detectLinksInStrings = ps.getProperty(HTML_detectLinksInStrings, Boolean.class, true);
labelParameter = ps.getProperty(HTML_labelParameter, String.class, "label");
addKeyValueTableHeaders = ps.getProperty(HTML_addKeyValueTableHeaders, Boolean.class, false);
- addBeanTypeProperties = ps.getProperty(HTML_addBeanTypeProperties, boolean.class, ps.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));
+ addBeanTypeProperties = ps.getProperty(HTML_addBeanTypeProperties, boolean.class,
+ ps.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));
}
@Override /* Context */
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
index 6f528dd..5377a8a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
@@ -64,7 +64,8 @@ public class HtmlSerializerSession extends XmlSerializerSession {
* @param uriContext The URI context.
* Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
*/
- protected HtmlSerializerSession(HtmlSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ protected HtmlSerializerSession(HtmlSerializerContext ctx, ObjectMap op, Object output, Method javaMethod,
+ Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
super(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
String labelParameter;
if (op == null || op.isEmpty()) {
@@ -90,14 +91,16 @@ public class HtmlSerializerSession extends XmlSerializerSession {
Object output = getOutput();
if (output instanceof HtmlWriter)
return (HtmlWriter)output;
- return new HtmlWriter(super.getWriter(), isUseWhitespace(), getMaxIndent(), isTrimStrings(), getQuoteChar(), getUriResolver());
+ return new HtmlWriter(super.getWriter(), isUseWhitespace(), getMaxIndent(), isTrimStrings(), getQuoteChar(),
+ getUriResolver());
}
/**
* Returns <jk>true</jk> if the specified object is a URL.
*
* @param cm The ClassMeta of the object being serialized.
- * @param pMeta The property metadata of the bean property of the object. Can be <jk>null</jk> if the object isn't from a bean property.
+ * @param pMeta The property metadata of the bean property of the object.
+ * Can be <jk>null</jk> if the object isn't from a bean property.
* @param o The object.
* @return <jk>true</jk> if the specified object is a URL.
*/
@@ -114,7 +117,8 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Returns the anchor text to use for the specified URL object.
*
- * @param pMeta The property metadata of the bean property of the object. Can be <jk>null</jk> if the object isn't from a bean property.
+ * @param pMeta The property metadata of the bean property of the object.
+ * Can be <jk>null</jk> if the object isn't from a bean property.
* @param o The URL object.
* @return The anchor text to use for the specified URL object.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
index 815e2ef..a43f1e7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
@@ -30,7 +30,8 @@ import org.apache.juneau.serializer.*;
*
* <h5 class='section'>Description:</h5>
* <p>
- * Produces the same output as {@link HtmlDocSerializer}, but without the header and body tags and page title and description.
+ * Produces the same output as {@link HtmlDocSerializer}, but without the header and body tags and page title and
+ * description.
* Used primarily for JUnit testing the {@link HtmlDocSerializer} class.
*/
@Produces(value="text/html+stripped",contentType="text/html")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/HtmlWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlWriter.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlWriter.java
index fbbd225..559cae4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlWriter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlWriter.java
@@ -34,7 +34,8 @@ public class HtmlWriter extends XmlWriter {
* @param quoteChar The quote character to use (i.e. <js>'\''</js> or <js>'"'</js>)
* @param uriResolver The URI resolver for resolving URIs to absolute or root-relative form.
*/
- public HtmlWriter(Writer out, boolean useWhitespace, int maxIndent, boolean trimStrings, char quoteChar, UriResolver uriResolver) {
+ public HtmlWriter(Writer out, boolean useWhitespace, int maxIndent, boolean trimStrings, char quoteChar,
+ UriResolver uriResolver) {
super(out, useWhitespace, maxIndent, trimStrings, quoteChar, uriResolver, false, null);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java b/juneau-core/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java
index fcac7ec..299ba7d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java
@@ -19,7 +19,8 @@ import java.io.*;
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
- * String table = <jk>new</jk> SimpleHtmlWriter().sTag(<js>"table"</js>).sTag(<js>"tr"</js>).sTag(<js>"td"</js>).append(<js>"hello"</js>).eTag(<js>"td"</js>).eTag(<js>"tr"</js>).eTag(<js>"table"</js>).toString();
+ * String table = <jk>new</jk> SimpleHtmlWriter().sTag(<js>"table"</js>).sTag(<js>"tr"</js>).sTag(<js>"td"</js>)
+ * .append(<js>"hello"</js>).eTag(<js>"td"</js>).eTag(<js>"tr"</js>).eTag(<js>"table"</js>).toString();
* </p>
*/
public class SimpleHtmlWriter extends HtmlWriter {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/html/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/package.html b/juneau-core/src/main/java/org/apache/juneau/html/package.html
index c07f97a..83e97fa 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/html/package.html
@@ -117,7 +117,8 @@
Maps and beans are represented as tables.
</p>
<p>
- The <xa>_type</xa> attribute is added to differentiate between objects (maps/beans) and arrays (arrays/collections).
+ The <xa>_type</xa> attribute is added to differentiate between objects (maps/beans) and arrays
+ (arrays/collections).
</p>
<table class='styled' style='width:auto'>
<tr>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Accept.java b/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
index 9fa6971..cdf7fa7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
@@ -128,7 +128,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Accept {
@@ -175,13 +176,16 @@ public final class Accept {
* <p>
* Note that fuzzy matching is allowed on the media types where the <code>Accept</code> header may
* contain additional subtype parts.
- * <br>For example, given identical q-values and an <code>Accept</code> value of <js>"text/json+activity"</js>,
+ * <br>
+ * For example, given identical q-values and an <code>Accept</code> value of <js>"text/json+activity"</js>,
* the media type <js>"text/json"</js> will match if <js>"text/json+activity"</js> or <js>"text/activity+json"</js>
* isn't found.
- * <br>The purpose for this is to allow serializers to match when artifacts such as <code>id</code> properties are present
- * in the header.
+ * <br>
+ * The purpose for this is to allow serializers to match when artifacts such as <code>id</code> properties are
+ * present in the header.
* <p>
- * See <a class='doclink' href='https://www.w3.org/TR/activitypub/#retrieving-objects'>ActivityPub / Retrieving Objects</a>
+ * See <a class='doclink' href='https://www.w3.org/TR/activitypub/#retrieving-objects'>
+ * ActivityPub / Retrieving Objects</a>
* <p>
*
* @param mediaTypes The media types to match against.
@@ -217,10 +221,11 @@ public final class Accept {
* Convenience method for searching through all of the subtypes of all the media ranges in this header
* for the presence of a subtype fragment.
* <p>
- * For example, given the header <js>"text/json+activity"</js>, calling <code>hasSubtypePart(<js>"activity"</js>)</code> returns <jk>true</jk>.
+ * For example, given the header <js>"text/json+activity"</js>, calling
+ * <code>hasSubtypePart(<js>"activity"</js>)</code> returns <jk>true</jk>.
*
* @param part The media type subtype fragment.
- * @return <jk>true</jk> if subtype fragement exists.
+ * @return <jk>true</jk> if subtype fragment exists.
*/
public boolean hasSubtypePart(String part) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
index d208291..5a88ba5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
@@ -61,7 +61,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class AcceptCharset extends HeaderRangeArray {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
index f7926d7..fa6f918 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
@@ -28,7 +28,8 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>RFC2616 Specification</h6>
*
- * The Accept-Encoding request-header field is similar to Accept, but restricts the content-codings (section 3.5) that are acceptable in the response.
+ * The Accept-Encoding request-header field is similar to Accept, but restricts the content-codings (section 3.5) that
+ * are acceptable in the response.
*
* <p class='bcode'>
* Accept-Encoding = "Accept-Encoding" ":"
@@ -80,7 +81,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class AcceptEncoding extends HeaderRangeArray {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
index ddc9242..3e6805d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
@@ -88,7 +88,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class AcceptLanguage extends HeaderRangeArray {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
index b05a427..6bd4051 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
@@ -52,7 +52,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class AcceptRanges extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/Age.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Age.java b/juneau-core/src/main/java/org/apache/juneau/http/Age.java
index 08bb513..a452e5b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Age.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Age.java
@@ -47,7 +47,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Age extends HeaderInteger {
[15/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
index 692ad34..d7c6260 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
@@ -26,7 +26,8 @@ import org.apache.juneau.json.*;
* <p>
* There are five possible parameter types.
* <ul>
- * <li><js>"path"</js> - Used together with Path Templating, where the parameter value is actually part of the operation's URL.
+ * <li><js>"path"</js> - Used together with Path Templating, where the parameter value is actually part of the
+ * operation's URL.
* This does not include the host or base path of the API.
* For example, in <code>/items/{itemId}</code>, the path parameter is <code>itemId</code>.
* <li><js>"query"</js> - Parameters that are appended to the URL.
@@ -34,18 +35,27 @@ import org.apache.juneau.json.*;
* <li><js>"header"</js> - Custom headers that are expected as part of the request.
* <li><js>"body"</js> - The payload that's appended to the HTTP request.
* Since there can only be one payload, there can only be one body parameter.
- * The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only.
- * Since Form parameters are also in the payload, body and form parameters cannot exist together for the same operation.
- * <li><js>"formData"</js> - Used to describe the payload of an HTTP request when either <code>application/x-www-form-urlencoded</code>, <code>multipart/form-data</code> or both are used as the content type of the request (in Swagger's definition, the consumes property of an operation).
+ * The name of the body parameter has no effect on the parameter itself and is used for documentation purposes
+ * only.
+ * Since Form parameters are also in the payload, body and form parameters cannot exist together for the same
+ * operation.
+ * <li><js>"formData"</js> - Used to describe the payload of an HTTP request when either
+ * <code>application/x-www-form-urlencoded</code>, <code>multipart/form-data</code> or both are used as the
+ * content type of the request (in Swagger's definition, the consumes property of an operation).
* This is the only parameter type that can be used to send files, thus supporting the file type.
- * Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation.
- * Form parameters have a different format based on the content-type used (for further details, consult <code>http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4</code>):
+ * Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the
+ * same operation.
+ * Form parameters have a different format based on the content-type used (for further details, consult
+ * <code>http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4</code>):
* <ul>
- * <li><js>"application/x-www-form-urlencoded"</js> - Similar to the format of Query parameters but as a payload.
- * For example, <code>foo=1&bar=swagger</code> - both <code>foo</code> and <code>bar</code> are form parameters.
+ * <li><js>"application/x-www-form-urlencoded"</js> - Similar to the format of Query parameters but as a
+ * payload.
+ * For example, <code>foo=1&bar=swagger</code> - both <code>foo</code> and <code>bar</code> are form
+ * parameters.
* This is normally used for simple parameters that are being transferred.
* <li><js>"multipart/form-data"</js> - each parameter takes a section in the payload with an internal header.
- * For example, for the header <code>Content-Disposition: form-data; name="submit-name"</code> the name of the parameter is <code>submit-name</code>.
+ * For example, for the header <code>Content-Disposition: form-data; name="submit-name"</code> the name of
+ * the parameter is <code>submit-name</code>.
* This type of form parameters is more commonly used for file transfers.
* </ul>
* </li>
@@ -53,7 +63,8 @@ import org.apache.juneau.json.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -103,8 +114,11 @@ public class ParameterInfo extends SwaggerElement {
* <p>
* Required. The name of the parameter.
* Parameter names are case sensitive.
- * If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment from the <code>path</code> field in the <a class="doclink" href="http://swagger.io/specification/#pathsObject">Paths Object</a>.
- * See <a class="doclink" href="http://swagger.io/specification/#pathTemplating">Path Templating</a> for further information.
+ * If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment
+ * from the <code>path</code> field in the <a class="doclink"
+ * href="http://swagger.io/specification/#pathsObject">Paths Object</a>.
+ * See <a class="doclink" href="http://swagger.io/specification/#pathTemplating">Path Templating</a> for further
+ * information.
* For all other cases, the name corresponds to the parameter name used based on the <code>in</code> property.
*
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -118,8 +132,11 @@ public class ParameterInfo extends SwaggerElement {
* <p>
* Required. The name of the parameter.
* Parameter names are case sensitive.
- * If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment from the <code>path</code> field in the <a class="doclink" href="http://swagger.io/specification/#pathsObject">Paths Object</a>.
- * See <a class="doclink" href="http://swagger.io/specification/#pathTemplating">Path Templating</a> for further information.
+ * If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment
+ * from the <code>path</code> field in the <a class="doclink"
+ * href="http://swagger.io/specification/#pathsObject">Paths Object</a>.
+ * See <a class="doclink" href="http://swagger.io/specification/#pathTemplating">Path Templating</a> for further
+ * information.
* For all other cases, the name corresponds to the parameter name used based on the <code>in</code> property.
*
* @param name The new value for the <property>name</property> property on this bean.
@@ -164,7 +181,9 @@ public class ParameterInfo extends SwaggerElement {
*/
public ParameterInfo setIn(String in) {
if (isStrict() && ! contains(in, VALID_IN))
- throw new RuntimeException("Invalid value passed in to setIn(String). Value='"+in+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_IN));
+ throw new RuntimeException(
+ "Invalid value passed in to setIn(String). Value='"+in+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_IN));
this.in = in;
if ("path".equals(in))
required = true;
@@ -186,9 +205,11 @@ public class ParameterInfo extends SwaggerElement {
* <p>
* A brief description of the parameter.
* This could contain examples of use.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
- * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getDescription() {
return description;
@@ -199,7 +220,8 @@ public class ParameterInfo extends SwaggerElement {
* <p>
* A brief description of the parameter.
* This could contain examples of use.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
@@ -223,7 +245,8 @@ public class ParameterInfo extends SwaggerElement {
* Bean property getter: <property>required</property>.
* <p>
* Determines whether this parameter is mandatory.
- * If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be <jk>true</jk>.
+ * If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be
+ * <jk>true</jk>.
* Otherwise, the property MAY be included and its default value is <jk>false</jk>.
*
* @return The value of the <property>required</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -236,7 +259,8 @@ public class ParameterInfo extends SwaggerElement {
* Bean property setter: <property>required</property>.
* <p>
* Determines whether this parameter is mandatory.
- * If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be <jk>true</jk>.
+ * If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be
+ * <jk>true</jk>.
* Otherwise, the property MAY be included and its default value is <jk>false</jk>.
*
* @param required The new value for the <property>required</property> property on this bean.
@@ -296,8 +320,11 @@ public class ParameterInfo extends SwaggerElement {
* <p>
* Required. The type of the parameter.
* Since the parameter is not located at the request body, it is limited to simple types (that is, not an object).
- * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, <js>"array"</js> or <js>"file"</js>.
- * If type is <js>"file"</js>, the <code>consumes</code> MUST be either <js>"multipart/form-data"</js>, <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be <code>in</code> <js>"formData"</js>.
+ * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>,
+ * <js>"array"</js> or <js>"file"</js>.
+ * If type is <js>"file"</js>, the <code>consumes</code> MUST be either <js>"multipart/form-data"</js>,
+ * <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be <code>in</code>
+ * <js>"formData"</js>.
*
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -310,15 +337,20 @@ public class ParameterInfo extends SwaggerElement {
* <p>
* Required. The type of the parameter.
* Since the parameter is not located at the request body, it is limited to simple types (that is, not an object).
- * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, <js>"array"</js> or <js>"file"</js>.
- * If type is <js>"file"</js>, the <code>consumes</code> MUST be either <js>"multipart/form-data"</js>, <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be <code>in</code> <js>"formData"</js>.
+ * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>,
+ * <js>"array"</js> or <js>"file"</js>.
+ * If type is <js>"file"</js>, the <code>consumes</code> MUST be either <js>"multipart/form-data"</js>,
+ * <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be <code>in</code>
+ * <js>"formData"</js>.
*
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
public ParameterInfo setType(String type) {
if (isStrict() && ! contains(type, VALID_TYPES))
- throw new RuntimeException("Invalid value passed in to setType(String). Value='"+type+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
+ throw new RuntimeException(
+ "Invalid value passed in to setType(String). Value='"+type+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
this.type = type;
return this;
}
@@ -337,7 +369,8 @@ public class ParameterInfo extends SwaggerElement {
* Bean property getter: <property>format</property>.
* <p>
* The extending format for the previously mentioned type.
- * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
+ * details.
*
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -349,7 +382,8 @@ public class ParameterInfo extends SwaggerElement {
* Bean property setter: <property>format</property>.
* <p>
* The extending format for the previously mentioned type.
- * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
+ * details.
*
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
@@ -373,10 +407,12 @@ public class ParameterInfo extends SwaggerElement {
* Bean property getter: <property>allowEmptyValue</property>.
* <p>
* Sets the ability to pass empty-valued parameters.
- * This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a parameter with a name only or an empty value.
+ * This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a
+ * parameter with a name only or an empty value.
* Default value is <jk>false</jk>.
*
- * @return The value of the <property>allowEmptyValue</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>allowEmptyValue</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getAllowEmptyValue() {
return allowEmptyValue;
@@ -386,7 +422,8 @@ public class ParameterInfo extends SwaggerElement {
* Bean property setter: <property>allowEmptyValue</property>.
* <p>
* Sets the ability to pass empty-valued parameters.
- * This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a parameter with a name only or an empty value.
+ * This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a
+ * parameter with a name only or an empty value.
* Default value is <jk>false</jk>.
*
* @param allowEmptyValue The new value for the <property>allowEmptyValue</property> property on this bean.
@@ -454,13 +491,15 @@ public class ParameterInfo extends SwaggerElement {
* <li><code>ssv</code> - space separated values <code>foo bar</code>.
* <li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
* <li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
- * <li><code>multi</code> - corresponds to multiple parameter instances instead of multiple values for a single instance <code>foo=bar&foo=baz</code>.
+ * <li><code>multi</code> - corresponds to multiple parameter instances instead of multiple values for a single
+ * instance <code>foo=bar&foo=baz</code>.
* This is valid only for parameters <code>in</code> <js>"query"</js> or <js>"formData"</js>.
* </ul>
* <p>
* Default value is <code>csv</code>.
*
- * @return The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public String getCollectionFormat() {
return collectionFormat;
@@ -477,7 +516,8 @@ public class ParameterInfo extends SwaggerElement {
* <li><code>ssv</code> - space separated values <code>foo bar</code>.
* <li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
* <li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
- * <li><code>multi</code> - corresponds to multiple parameter instances instead of multiple values for a single instance <code>foo=bar&foo=baz</code>.
+ * <li><code>multi</code> - corresponds to multiple parameter instances instead of multiple values for a single
+ * instance <code>foo=bar&foo=baz</code>.
* This is valid only for parameters <code>in</code> <js>"query"</js> or <js>"formData"</js>.
* </ul>
* <p>
@@ -506,9 +546,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>default</property>.
* <p>
- * Declares the value of the parameter that the server will use if none is provided, for example a <js>"count"</js> to control the number of results per page might default to 100 if not supplied by the client in the request.
+ * Declares the value of the parameter that the server will use if none is provided, for example a <js>"count"</js>
+ * to control the number of results per page might default to 100 if not supplied by the client in the request.
* (Note: <js>"default"</js> has no meaning for required parameters.)
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
* Unlike JSON Schema this value MUST conform to the defined <code>type</code> for this parameter.
*
* @return The value of the <property>default</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -520,9 +562,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>default</property>.
* <p>
- * Declares the value of the parameter that the server will use if none is provided, for example a <js>"count"</js> to control the number of results per page might default to 100 if not supplied by the client in the request.
+ * Declares the value of the parameter that the server will use if none is provided, for example a <js>"count"</js>
+ * to control the number of results per page might default to 100 if not supplied by the client in the request.
* (Note: <js>"default"</js> has no meaning for required parameters.)
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
* Unlike JSON Schema this value MUST conform to the defined <code>type</code> for this parameter.
*
* @param _default The new value for the <property>default</property> property on this bean.
@@ -546,7 +590,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>maximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
* @return The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -557,7 +602,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>maximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
@@ -580,9 +626,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
- * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk>
+ * if it is not set.
*/
public Boolean getExclusiveMaximum() {
return exclusiveMaximum;
@@ -591,7 +639,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMaximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
@@ -614,7 +663,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>minimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
* @return The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -625,7 +675,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>minimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
@@ -648,9 +699,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
- * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMinimum() {
return exclusiveMinimum;
@@ -659,7 +712,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMinimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
@@ -682,7 +736,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
*
* @return The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -693,7 +748,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
*
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
@@ -716,7 +772,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>minLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
*
* @return The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -727,7 +784,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>minLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
*
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
@@ -750,7 +808,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>pattern</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
*
* @return The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -761,7 +820,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
*
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
@@ -784,7 +844,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
*
* @return The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -795,7 +856,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
*
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
@@ -818,7 +880,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>minItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
*
* @return The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -829,7 +892,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>minItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
*
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
@@ -852,9 +916,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
*
- * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Boolean getUniqueItems() {
return uniqueItems;
@@ -863,7 +929,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>uniqueItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
*
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
@@ -886,7 +953,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @return The value of the <property>enum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -897,7 +965,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
@@ -910,7 +979,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @param _enum The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -946,7 +1016,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>multipleOf</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
*
* @return The value of the <property>multipleOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -957,7 +1028,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>multipleOf</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
*
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
index bc9ac0b..4bc5236 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
@@ -34,7 +34,8 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -54,7 +55,8 @@ public class ResponseInfo extends SwaggerElement {
* Bean property getter: <property>description</property>.
* <p>
* Required. A short description of the response.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for
+ * rich text representation.
*
* @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -66,7 +68,8 @@ public class ResponseInfo extends SwaggerElement {
* Bean property setter: <property>description</property>.
* <p>
* Required. A short description of the response.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
@@ -92,7 +95,8 @@ public class ResponseInfo extends SwaggerElement {
* A definition of the response structure.
* It can be a primitive, an array or an object.
* If this field does not exist, it means no content is returned as part of the response.
- * As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>, its root type value may also be <js>"file"</js>.
+ * As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>,
+ * its root type value may also be <js>"file"</js>.
* This SHOULD be accompanied by a relevant produces mime-type.
*
* @return The value of the <property>schema</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -107,7 +111,8 @@ public class ResponseInfo extends SwaggerElement {
* A definition of the response structure.
* It can be a primitive, an array or an object.
* If this field does not exist, it means no content is returned as part of the response.
- * As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>, its root type value may also be <js>"file"</js>.
+ * As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>,
+ * its root type value may also be <js>"file"</js>.
* This SHOULD be accompanied by a relevant produces mime-type.
*
* @param schema The new value for the <property>schema</property> property on this bean.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
index d4f2f7e..460a051 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
@@ -28,7 +28,8 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -72,7 +73,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
* <p>
- * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
+ * details.
*
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -83,7 +85,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
* <p>
- * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
+ * details.
*
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
@@ -136,7 +139,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
* <p>
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
* @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -147,7 +151,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
* <p>
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
@@ -264,7 +269,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
*
- * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMaximum() {
return exclusiveMaximum;
@@ -324,7 +330,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
*
- * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMinimum() {
return exclusiveMinimum;
@@ -504,7 +511,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
*
- * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Boolean getUniqueItems() {
return uniqueItems;
@@ -533,7 +541,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxProperties</property>.
*
- * @return The value of the <property>maxProperties</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>maxProperties</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Integer getMaxProperties() {
return maxProperties;
@@ -563,7 +572,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>minProperties</property>.
*
- * @return The value of the <property>minProperties</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>minProperties</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Integer getMinProperties() {
return minProperties;
@@ -839,7 +849,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>additionalProperties</property>.
*
- * @return The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it
+ * is not set.
*/
public Map<String,Object> getAdditionalProperties() {
return additionalProperties;
@@ -874,7 +885,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>discriminator</property>.
*
- * @return The value of the <property>discriminator</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>discriminator</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public String getDiscriminator() {
return discriminator;
@@ -964,7 +976,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>externalDocs</property>.
*
- * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public ExternalDocumentation getExternalDocs() {
return externalDocs;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
index 8856db2..f41e194 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
@@ -22,7 +22,8 @@ import org.apache.juneau.json.*;
/**
* Allows the definition of a security scheme that can be used by the operations.
* <p>
- * Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code).
+ * Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's
+ * common flows (implicit, password, application and access code).
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -52,7 +53,8 @@ import org.apache.juneau.json.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -103,7 +105,9 @@ public class SecurityScheme extends SwaggerElement {
*/
public SecurityScheme setType(String type) {
if (isStrict() && ! contains(type, VALID_TYPES))
- throw new RuntimeException("Invalid value passed in to setType(String). Value='"+type+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
+ throw new RuntimeException(
+ "Invalid value passed in to setType(String). Value='"+type+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
this.type = type;
return this;
}
@@ -123,7 +127,8 @@ public class SecurityScheme extends SwaggerElement {
* <p>
* A short description for security scheme.
*
- * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getDescription() {
return description;
@@ -262,7 +267,8 @@ public class SecurityScheme extends SwaggerElement {
* The authorization URL to be used for this flow.
* This SHOULD be in the form of a URL.
*
- * @return The value of the <property>authorizationUrl</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>authorizationUrl</property> property on this bean, or <jk>null</jk> if it
+ * is not set.
*/
public String getAuthorizationUrl() {
return authorizationUrl;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
index 2da4bbb..bbb8d05 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
@@ -23,7 +23,8 @@ import org.apache.juneau.utils.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -129,11 +130,12 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>host</property>.
* <p>
- * The host (name or ip) serving the API.
+ * The host (name or IP) serving the API.
* This MUST be the host only and does not include the scheme nor sub-paths.
* It MAY include a port.
* If the host is not included, the host serving the documentation is to be used (including the port).
- * The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.
+ * The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">
+ * path templating</a>.
*
* @return The value of the <property>host</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -144,11 +146,12 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>host</property>.
* <p>
- * The host (name or ip) serving the API.
+ * The host (name or IP) serving the API.
* This MUST be the host only and does not include the scheme nor sub-paths.
* It MAY include a port.
* If the host is not included, the host serving the documentation is to be used (including the port).
- * The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.
+ * The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">
+ * path templating</a>.
*
* @param host The new value for the <property>host</property> property on this bean.
* @return This object (for method chaining).
@@ -174,7 +177,8 @@ public class Swagger extends SwaggerElement {
* The base path on which the API is served, which is relative to the <code>host</code>.
* If it is not included, the API is served directly under the <code>host</code>.
* The value MUST start with a leading slash (/).
- * The <code>basePath</code> does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.
+ * The <code>basePath</code> does not support <a class="doclink"
+ * href="http://swagger.io/specification/#pathTemplating">path templating</a>.
*
* @return The value of the <property>basePath</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -188,7 +192,8 @@ public class Swagger extends SwaggerElement {
* The base path on which the API is served, which is relative to the <code>host</code>.
* If it is not included, the API is served directly under the <code>host</code>.
* The value MUST start with a leading slash (/).
- * The <code>basePath</code> does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.
+ * The <code>basePath</code> does not support <a class="doclink"
+ * href="http://swagger.io/specification/#pathTemplating">path templating</a>.
*
* @param basePath The new value for the <property>basePath</property> property on this bean.
* @return This object (for method chaining).
@@ -213,7 +218,8 @@ public class Swagger extends SwaggerElement {
* <p>
* The transfer protocol of the API.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.
+ * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ * definition itself.
*
* @return The value of the <property>schemes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -226,7 +232,8 @@ public class Swagger extends SwaggerElement {
* <p>
* The transfer protocol of the API.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.
+ * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ * definition itself.
*
* @param schemes The new value for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
@@ -241,7 +248,8 @@ public class Swagger extends SwaggerElement {
* <p>
* The transfer protocol of the API.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.
+ * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ * definition itself.
*
* @param schemes The values to add for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
@@ -255,7 +263,8 @@ public class Swagger extends SwaggerElement {
* <p>
* The transfer protocol of the API.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.
+ * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ * definition itself.
*
* @param schemes The values to add for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
@@ -284,7 +293,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can consume.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @return The value of the <property>consumes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -297,7 +307,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can consume.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param consumes The new value for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
@@ -312,7 +323,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can consume.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param consumes The values to add for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
@@ -326,7 +338,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can consume.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param consumes The values to add for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
@@ -365,7 +378,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can produce.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @return The value of the <property>produces</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -378,7 +392,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can produce.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
@@ -393,7 +408,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can produce.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param produces The values to add for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
@@ -407,7 +423,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can produce.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param produces The values to add for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
@@ -504,7 +521,8 @@ public class Swagger extends SwaggerElement {
* <p>
* An object to hold data types produced and consumed by operations.
*
- * @return The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Map<String,SchemaInfo> getDefinitions() {
return definitions;
@@ -663,7 +681,8 @@ public class Swagger extends SwaggerElement {
* <p>
* Security scheme definitions that can be used across the specification.
*
- * @return The value of the <property>securityDefinitions</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>securityDefinitions</property> property on this bean, or <jk>null</jk> if it
+ * is not set.
*/
public Map<String,SecurityScheme> getSecurityDefinitions() {
return securityDefinitions;
@@ -713,7 +732,8 @@ public class Swagger extends SwaggerElement {
* Bean property getter: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for the API as a whole.
- * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ * between the security requirements).
* Individual operations can override this definition.
*
* @return The value of the <property>security</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -726,7 +746,8 @@ public class Swagger extends SwaggerElement {
* Bean property setter: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for the API as a whole.
- * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ * between the security requirements).
* Individual operations can override this definition.
*
* @param security The new value for the <property>security</property> property on this bean.
@@ -741,7 +762,8 @@ public class Swagger extends SwaggerElement {
* Bean property adder: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for the API as a whole.
- * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ * between the security requirements).
* Individual operations can override this definition.
*
* @param security The value to add for the <property>security</property> property on this bean.
@@ -758,7 +780,8 @@ public class Swagger extends SwaggerElement {
* Synonym for {@link #addSecurity(Map)}.
*
* @param scheme The security scheme that applies to this operation
- * @param alternatives The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * @param alternatives The list of values describes alternative security schemes that can be used (that is, there
+ * is a logical OR between the security requirements).
* @return This object (for method chaining).
*/
public Swagger security(String scheme, String...alternatives) {
@@ -772,7 +795,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of tags used by the specification with additional metadata.
* The order of the tags can be used to reflect on their order by the parsing tools.
- * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a> must be declared.
+ * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">
+ * Operation Object</a> must be declared.
* The tags that are not declared may be organized randomly or based on the tools' logic.
* Each tag name in the list MUST be unique.
*
@@ -787,7 +811,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of tags used by the specification with additional metadata.
* The order of the tags can be used to reflect on their order by the parsing tools.
- * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a> must be declared.
+ * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">
+ * Operation Object</a> must be declared.
* The tags that are not declared may be organized randomly or based on the tools' logic.
* Each tag name in the list MUST be unique.
*
@@ -804,7 +829,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of tags used by the specification with additional metadata.
* The order of the tags can be used to reflect on their order by the parsing tools.
- * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a> must be declared.
+ * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">
+ * Operation Object</a> must be declared.
* The tags that are not declared may be organized randomly or based on the tools' logic.
* Each tag name in the list MUST be unique.
*
@@ -843,7 +869,8 @@ public class Swagger extends SwaggerElement {
* <p>
* Additional external documentation.
*
- * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public ExternalDocumentation getExternalDocs() {
return externalDocs;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
index aa71038..20d5fff 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
@@ -21,7 +21,8 @@ import org.apache.juneau.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -32,6 +33,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Contact} element.
+ *
* @return The new element.
*/
public static final Contact contact() {
@@ -40,6 +42,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Contact} element with the specified {@link Contact#name(String)} attribute.
+ *
* @param name The {@link Contact#name(String)} attribute.
* @return The new element.
*/
@@ -48,7 +51,9 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link Contact} element with the specified {@link Contact#name(String)}, {@link Contact#url(Object)}, and {@link Contact#email(String)}, attributes.
+ * Creates an {@link Contact} element with the specified {@link Contact#name(String)}, {@link Contact#url(Object)},
+ * and {@link Contact#email(String)}, attributes.
+ *
* @param name The {@link Contact#name(String)} attribute.
* @param url The {@link Contact#url(Object)} attribute.
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
@@ -63,6 +68,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link ExternalDocumentation} element.
+ *
* @return The new element.
*/
public static final ExternalDocumentation externalDocumentation() {
@@ -70,11 +76,13 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link ExternalDocumentation} element with the specified {@link ExternalDocumentation#url(Object)} attribute.
+ * Creates an {@link ExternalDocumentation} element with the specified {@link ExternalDocumentation#url(Object)}
+ * attribute.
+ *
* @param url The {@link ExternalDocumentation#url(Object)} attribute.
- * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
- * <br>Strings must be valid URIs.
- * <br>URIs defined by {@link UriResolver} can be used for values.
+ * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
+ * <br>Strings must be valid URIs.
+ * <br>URIs defined by {@link UriResolver} can be used for values.
* @return The new element.
*/
public static final ExternalDocumentation externalDocumentation(Object url) {
@@ -82,11 +90,13 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link ExternalDocumentation} element with the specified {@link ExternalDocumentation#url(Object)} and {@link ExternalDocumentation#description(String)} attributes.
+ * Creates an {@link ExternalDocumentation} element with the specified {@link ExternalDocumentation#url(Object)}
+ * and {@link ExternalDocumentation#description(String)} attributes.
+ *
* @param url The {@link ExternalDocumentation#url(Object)} attribute.
- * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
- * <br>Strings must be valid URIs.
- * <br>URIs defined by {@link UriResolver} can be used for values.
+ * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
+ * <br>Strings must be valid URIs.
+ * <br>URIs defined by {@link UriResolver} can be used for values.
* @param description The {@link ExternalDocumentation#description(String)} attribute.
* @return The new element.
*/
@@ -96,6 +106,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link HeaderInfo} element.
+ *
* @return The new element.
*/
public static final HeaderInfo headerInfo() {
@@ -104,6 +115,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link HeaderInfo} element with the specified {@link HeaderInfo#type(String)} attribute.
+ *
* @param type The {@link HeaderInfo#type(String)} attribute.
* @return The new element.
*/
@@ -113,6 +125,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link HeaderInfo} element with the specified {@link HeaderInfo#type(String)} attribute.
+ *
* @param type The {@link HeaderInfo#type(String)} attribute.
* @return The new element.
*/
@@ -122,6 +135,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Info} element.
+ *
* @return The new element.
*/
public static final Info info() {
@@ -129,7 +143,9 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link Info} element with the specified {@link Info#title(String)} and {@link Info#version(String)} attributes.
+ * Creates an {@link Info} element with the specified {@link Info#title(String)} and {@link Info#version(String)}
+ * attributes.
+ *
* @param title The {@link Info#title(String)} attribute.
* @param version The {@link Info#version(String)} attribute.
* @return The new element.
@@ -140,6 +156,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Items} element.
+ *
* @return The new element.
*/
public static final Items items() {
@@ -148,6 +165,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Items} element with the specified {@link Items#type(String)} attribute.
+ *
* @param type The {@link Items#type(String)} attribute.
* @return The new element.
*/
@@ -157,6 +175,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Items} element with the specified {@link Items#type(String)} attribute.
+ *
* @param type The {@link Items#type(String)} attribute.
* @return The new element.
*/
@@ -166,6 +185,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link License} element.
+ *
* @return The new element.
*/
public static final License license() {
@@ -174,6 +194,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link License} element with the specified {@link License#name(String)} attribute.
+ *
* @param name The {@link License#name(String)} attribute.
* @return The new element.
*/
@@ -183,6 +204,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Operation} element.
+ *
* @return The new element.
*/
public static final Operation operation() {
@@ -191,6 +213,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link ParameterInfo} element.
+ *
* @return The new element.
*/
public static final ParameterInfo parameterInfo() {
@@ -198,7 +221,9 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link ParameterInfo} element with the specified {@link ParameterInfo#in(String)} and {@link ParameterInfo#name(String)} attributes.
+ * Creates an {@link ParameterInfo} element with the specified {@link ParameterInfo#in(String)} and
+ * {@link ParameterInfo#name(String)} attributes.
+ *
* @param in The {@link ParameterInfo#in(String)} attribute.
* @param name The {@link ParameterInfo#name(String)} attribute.
* @return The new element.
@@ -208,7 +233,9 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link ParameterInfo} element with the specified {@link ParameterInfo#in(String)} and {@link ParameterInfo#name(String)} attributes.
+ * Creates an {@link ParameterInfo} element with the specified {@link ParameterInfo#in(String)} and
+ * {@link ParameterInfo#name(String)} attributes.
+ *
* @param in The {@link ParameterInfo#in(String)} attribute.
* @param name The {@link ParameterInfo#name(String)} attribute.
* @return The new element.
@@ -219,6 +246,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link ResponseInfo} element.
+ *
* @return The new element.
*/
public static final ResponseInfo responseInfo() {
@@ -228,6 +256,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link ResponseInfo} element with the specified {@link ResponseInfo#description(String)} attribute.
* @param description The {@link ResponseInfo#description(String)} attribute.
+ *
* @return The new element.
*/
public static final ResponseInfo responseInfo(String description) {
@@ -236,6 +265,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link SchemaInfo} element.
+ *
* @return The new element.
*/
public static final SchemaInfo schemaInfo() {
@@ -244,6 +274,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link SecurityScheme} element.
+ *
* @return The new element.
*/
public static final SecurityScheme securityScheme() {
@@ -252,6 +283,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link SecurityScheme} element with the specified {@link SecurityScheme#type(String)} attribute.
+ *
* @param type The {@link SecurityScheme#type(String)} attribute.
* @return The new element.
*/
@@ -261,6 +293,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link SecurityScheme} element with the specified {@link SecurityScheme#type(String)} attribute.
+ *
* @param type The {@link SecurityScheme#type(String)} attribute.
* @return The new element.
*/
@@ -270,6 +303,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Swagger} element.
+ *
* @return The new element.
*/
public static final Swagger swagger() {
@@ -278,6 +312,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Swagger} element with the specified {@link Swagger#info(Info)} attribute.
+ *
* @param info The {@link Swagger#info(Info)} attribute.
* @return The new element.
*/
@@ -287,6 +322,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Tag} element.
+ *
* @return The new element.
*/
public static final Tag tag() {
@@ -295,6 +331,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Tag} element with the specified {@link Tag#name(String)} attribute.
+ *
* @param name The {@link Tag#name(String)} attribute.
* @return The new element.
*/
@@ -304,6 +341,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Xml} element.
+ *
* @return The new element.
*/
public static final Xml xml() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
index d6ae5c9..a768d59 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
@@ -17,7 +17,8 @@ package org.apache.juneau.dto.swagger;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
index c6e13cd..3c2d504 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
@@ -15,7 +15,8 @@ package org.apache.juneau.dto.swagger;
import org.apache.juneau.annotation.*;
/**
- * Allows adding meta data to a single tag that is used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a>.
+ * Allows adding meta data to a single tag that is used by the <a class="doclink"
+ * href="http://swagger.io/specification/#operationObject">Operation Object</a>.
* <p>
* It is not mandatory to have a Tag Object per tag used there.
*
@@ -29,7 +30,8 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -82,9 +84,11 @@ public class Tag extends SwaggerElement {
* Bean property getter: <property>description</property>.
* <p>
* A short description for the tag.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
- * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getDescription() {
return description;
@@ -94,7 +98,8 @@ public class Tag extends SwaggerElement {
* Bean property setter: <property>description</property>.
* <p>
* A short description for the tag.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
@@ -119,7 +124,8 @@ public class Tag extends SwaggerElement {
* <p>
* Additional external documentation for this tag.
*
- * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public ExternalDocumentation getExternalDocs() {
return externalDocs;
[22/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanSession.java b/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
index cf957d0..54b9fcc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
@@ -145,7 +145,7 @@ public class BeanSession extends Session {
/**
* Same as {@link #convertToType(Object, Class)}, except used for instantiating inner member classes that must
- * be instantiated within another class instance.
+ * be instantiated within another class instance.
*
* @param <T> The class type to convert the value to.
* @param outer If class is a member class, this is the instance of the containing class.
@@ -162,129 +162,136 @@ public class BeanSession extends Session {
/**
* Casts the specified value into the specified type.
* <p>
- * If the value isn't an instance of the specified type, then converts
- * the value if possible.<br>
+ * If the value isn't an instance of the specified type, then converts the value if possible.
* <p>
* The following conversions are valid:
- * <table class='styled'>
- * <tr><th>Convert to type</th><th>Valid input value types</th><th>Notes</th></tr>
- * <tr>
- * <td>
- * A class that is the normal type of a registered {@link PojoSwap}.
- * </td>
- * <td>
- * A value whose class matches the transformed type of that registered {@link PojoSwap}.
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * A class that is the transformed type of a registered {@link PojoSwap}.
- * </td>
- * <td>
- * A value whose class matches the normal type of that registered {@link PojoSwap}.
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * {@code Number} (e.g. {@code Integer}, {@code Short}, {@code Float},...)<br>
- * <code>Number.<jsf>TYPE</jsf></code> (e.g. <code>Integer.<jsf>TYPE</jsf></code>, <code>Short.<jsf>TYPE</jsf></code>, <code>Float.<jsf>TYPE</jsf></code>,...)
- * </td>
- * <td>
- * {@code Number}, {@code String}, <jk>null</jk>
- * </td>
- * <td>
- * For primitive {@code TYPES}, <jk>null</jk> returns the JVM default value for that type.
- * </td>
- * </tr>
- * <tr>
- * <td>
- * {@code Map} (e.g. {@code Map}, {@code HashMap}, {@code TreeMap}, {@code ObjectMap})
- * </td>
- * <td>
- * {@code Map}
- * </td>
- * <td>
- * If {@code Map} is not constructible, a {@code ObjectMap} is created.
- * </td>
- * </tr>
- * <tr>
- * <td>
- * {@code Collection} (e.g. {@code List}, {@code LinkedList}, {@code HashSet}, {@code ObjectList})
- * </td>
- * <td>
- * {@code Collection<Object>}<br>
- * {@code Object[]}
- * </td>
- * <td>
- * If {@code Collection} is not constructible, a {@code ObjectList} is created.
- * </td>
- * </tr>
- * <tr>
- * <td>
- * {@code X[]} (array of any type X)<br>
- * </td>
- * <td>
- * {@code List<X>}<br>
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * {@code X[][]} (multi-dimensional arrays)<br>
- * </td>
- * <td>
- * {@code List<List<X>>}<br>
- * {@code List<X[]>}<br>
- * {@code List[]<X>}<br>
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * {@code Enum}<br>
- * </td>
- * <td>
- * {@code String}<br>
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * Bean<br>
- * </td>
- * <td>
- * {@code Map}<br>
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * {@code String}<br>
- * </td>
- * <td>
- * Anything<br>
- * </td>
- * <td>
- * Arrays are converted to JSON arrays<br>
- * </td>
- * </tr>
- * <tr>
- * <td>
- * Anything with one of the following methods:<br>
- * <code><jk>public static</jk> T fromString(String)</code><br>
- * <code><jk>public static</jk> T valueOf(String)</code><br>
- * <code><jk>public</jk> T(String)</code><br>
- * </td>
- * <td>
- * <code>String</code><br>
- * </td>
- * <td>
- * <br>
- * </td>
- * </tr>
- * </table>
+ * <table class='styled'>
+ * <tr><th>Convert to type</th><th>Valid input value types</th><th>Notes</th></tr>
+ * <tr>
+ * <td>
+ * A class that is the normal type of a registered {@link PojoSwap}.
+ * </td>
+ * <td>
+ * A value whose class matches the transformed type of that registered {@link PojoSwap}.
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * A class that is the transformed type of a registered {@link PojoSwap}.
+ * </td>
+ * <td>
+ * A value whose class matches the normal type of that registered {@link PojoSwap}.
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code Number} (e.g. {@code Integer}, {@code Short}, {@code Float},...)
+ * <br>
+ * <code>Number.<jsf>TYPE</jsf></code> (e.g. <code>Integer.<jsf>TYPE</jsf></code>,
+ * <code>Short.<jsf>TYPE</jsf></code>, <code>Float.<jsf>TYPE</jsf></code>,...)
+ * </td>
+ * <td>
+ * {@code Number}, {@code String}, <jk>null</jk>
+ * </td>
+ * <td>
+ * For primitive {@code TYPES}, <jk>null</jk> returns the JVM default value for that type.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code Map} (e.g. {@code Map}, {@code HashMap}, {@code TreeMap}, {@code ObjectMap})
+ * </td>
+ * <td>
+ * {@code Map}
+ * </td>
+ * <td>
+ * If {@code Map} is not constructible, a {@code ObjectMap} is created.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code Collection} (e.g. {@code List}, {@code LinkedList}, {@code HashSet}, {@code ObjectList})
+ * </td>
+ * <td>
+ * {@code Collection<Object>}
+ * <br>
+ * {@code Object[]}
+ * </td>
+ * <td>
+ * If {@code Collection} is not constructible, a {@code ObjectList} is created.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code X[]} (array of any type X)
+ * </td>
+ * <td>
+ * {@code List<X>}
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code X[][]} (multi-dimensional arrays)
+ * </td>
+ * <td>
+ * {@code List<List<X>>}
+ * <br>
+ * {@code List<X[]>}
+ * <br>
+ * {@code List[]<X>}
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code Enum}
+ * </td>
+ * <td>
+ * {@code String}
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * Bean
+ * </td>
+ * <td>
+ * {@code Map}
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code String}
+ * </td>
+ * <td>
+ * Anything
+ * </td>
+ * <td>
+ * Arrays are converted to JSON arrays
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * Anything with one of the following methods:
+ * <br>
+ * <code><jk>public static</jk> T fromString(String)</code>
+ * <br>
+ * <code><jk>public static</jk> T valueOf(String)</code>
+ * <br>
+ * <code><jk>public</jk> T(String)</code>
+ * </td>
+ * <td>
+ * <code>String</code>
+ * </td>
+ * <td>
+ * <br>
+ * </td>
+ * </tr>
+ * </table>
*
* @param <T> The class type to convert the value to.
* @param value The value to be converted.
@@ -663,7 +670,8 @@ public class BeanSession extends Session {
/**
* Wraps an object inside a {@link BeanMap} object (i.e. a modifiable {@link Map}).
* <p>
- * If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a bean.
+ * If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a
+ * bean.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -741,9 +749,11 @@ public class BeanSession extends Session {
}
/**
- * Creates a new {@link BeanMap} object (i.e. a modifiable {@link Map}) of the given class with uninitialized property values.
+ * Creates a new {@link BeanMap} object (i.e. a modifiable {@link Map}) of the given class with uninitialized
+ * property values.
* <p>
- * If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a bean.
+ * If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a
+ * bean.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -855,9 +865,11 @@ public class BeanSession extends Session {
* Used to resolve <code>ClassMetas</code> of type <code>Collection</code> and <code>Map</code> that have
* <code>ClassMeta</code> values that themselves could be collections or maps.
* <p>
- * <code>Collection</code> meta objects are assumed to be followed by zero or one meta objects indicating the element type.
+ * <code>Collection</code> meta objects are assumed to be followed by zero or one meta objects indicating the
+ * element type.
* <p>
- * <code>Map</code> meta objects are assumed to be followed by zero or two meta objects indicating the key and value types.
+ * <code>Map</code> meta objects 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.
*
@@ -866,17 +878,23 @@ public class BeanSession extends Session {
* <li><code>getClassMeta(String.<jk>class</jk>);</code> - A normal type.
* <li><code>getClassMeta(List.<jk>class</jk>);</code> - A list containing objects.
* <li><code>getClassMeta(List.<jk>class</jk>, String.<jk>class</jk>);</code> - A list containing strings.
- * <li><code>getClassMeta(LinkedList.<jk>class</jk>, String.<jk>class</jk>);</code> - A linked-list containing strings.
- * <li><code>getClassMeta(LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);</code> - A linked-list containing linked-lists of strings.
+ * <li><code>getClassMeta(LinkedList.<jk>class</jk>, String.<jk>class</jk>);</code> - A linked-list containing
+ * strings.
+ * <li><code>getClassMeta(LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);</code> -
+ * A linked-list containing linked-lists of strings.
* <li><code>getClassMeta(Map.<jk>class</jk>);</code> - A map containing object keys/values.
- * <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);</code> - A map containing string keys/values.
- * <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);</code> - A map containing string keys and values of lists containing beans.
+ * <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);</code> - A map
+ * containing string keys/values.
+ * <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);</code> -
+ * A map containing string keys and values of lists containing beans.
* </ul>
*
* @param type The class to resolve.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* <br>Ignored if the main type is not a map or collection.
* @return The class meta.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java b/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
index c63c3e9..2c153de 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
@@ -687,7 +687,8 @@ public final class ClassMeta<T> implements Type {
* <p>
* If <jk>null</jk>, <js>"_type"</js> should be assumed.
*
- * @return The type property name associated with this bean class, or <jk>null</jk> if there is no explicit type property name defined or this isn't a bean.
+ * @return The type property name associated with this bean class, or <jk>null</jk> if there is no explicit type
+ * property name defined or this isn't a bean.
*/
public String getBeanTypePropertyName() {
return typePropertyName;
@@ -698,7 +699,8 @@ public final class ClassMeta<T> implements Type {
* <p>
* The lexical name is defined by {@link Bean#typeName()}.
*
- * @return The type name associated with this bean class, or <jk>null</jk> if there is no type name defined or this isn't a bean.
+ * @return The type name associated with this bean class, or <jk>null</jk> if there is no type name defined or this
+ * isn't a bean.
*/
public String getDictionaryName() {
return dictionaryName;
@@ -760,7 +762,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the {@link PojoSwap} where the specified class is the same/subclass of the normal class of
- * one of the child pojo swaps associated with this class.
+ * one of the child POJO swaps associated with this class.
*
* @param normalClass The normal class being resolved.
* @return The resolved {@link PojoSwap} or <jk>null</jk> if none were found.
@@ -787,7 +789,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the {@link PojoSwap} where the specified class is the same/subclass of the swap class of
- * one of the child pojo swaps associated with this class.
+ * one of the child POJO swaps associated with this class.
*
* @param swapClass The swap class being resolved.
* @return The resolved {@link PojoSwap} or <jk>null</jk> if none were found.
@@ -856,7 +858,8 @@ public final class ClassMeta<T> implements Type {
}
/**
- * For array and {@code Collection} types, returns the class type of the components of the array or {@code Collection}.
+ * For array and {@code Collection} types, returns the class type of the components of the array or
+ * {@code Collection}.
*
* @return The element class type, or <jk>null</jk> if this class is not an array or Collection.
*/
@@ -1179,7 +1182,8 @@ public final class ClassMeta<T> implements Type {
}
/**
- * All methods on this class annotated with {@link Remoteable @Remotable}, or all public methods if class is annotated.
+ * All methods on this class annotated with {@link Remoteable @Remotable}, or all public methods if class is
+ * annotated.
* Keys are method signatures.
*
* @return All remoteable methods on this class.
@@ -1268,8 +1272,10 @@ public final class ClassMeta<T> implements Type {
* Returns <jk>false</jk> if this is a non-static member class and the outer object does not match
* the class type of the defining class.
*
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
- * @return <jk>true</jk> if a new instance of this class can be created within the context of the specified outer object.
+ * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
+ * classes.
+ * @return <jk>true</jk> if a new instance of this class can be created within the context of the specified outer
+ * object.
*/
public boolean canCreateNewInstance(Object outer) {
if (isMemberClass)
@@ -1282,8 +1288,10 @@ public final class ClassMeta<T> implements Type {
* Returns <jk>false</jk> if this is a non-static member class and the outer object does not match
* the class type of the defining class.
*
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
- * @return <jk>true</jk> if a new instance of this bean can be created within the context of the specified outer object.
+ * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
+ * classes.
+ * @return <jk>true</jk> if a new instance of this bean can be created within the context of the specified outer
+ * object.
*/
public boolean canCreateNewBean(Object outer) {
if (beanMeta == null)
@@ -1298,7 +1306,8 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class can call the {@link #newInstanceFromString(Object, String)} method.
*
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
+ * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
+ * classes.
* @return <jk>true</jk> if this class has a no-arg constructor or invocation handler.
*/
public boolean canCreateNewInstanceFromString(Object outer) {
@@ -1315,7 +1324,8 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class can call the {@link #newInstanceFromString(Object, String)} method.
*
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
+ * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
+ * classes.
* @return <jk>true</jk> if this class has a no-arg constructor or invocation handler.
*/
public boolean canCreateNewInstanceFromNumber(Object outer) {
@@ -1340,7 +1350,8 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the method or field annotated with {@link NameProperty @NameProperty}.
*
- * @return The method or field annotated with {@link NameProperty @NameProperty} or <jk>null</jk> if method does not exist.
+ * @return The method or field annotated with {@link NameProperty @NameProperty} or <jk>null</jk> if method does
+ * not exist.
*/
public Setter getNameProperty() {
return namePropertyMethod;
@@ -1349,7 +1360,8 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the method or field annotated with {@link ParentProperty @ParentProperty}.
*
- * @return The method or field annotated with {@link ParentProperty @ParentProperty} or <jk>null</jk> if method does not exist.
+ * @return The method or field annotated with {@link ParentProperty @ParentProperty} or <jk>null</jk> if method
+ * does not exist.
*/
public Setter getParentProperty() {
return parentPropertyMethod;
@@ -1402,10 +1414,12 @@ public final class ClassMeta<T> implements Type {
* <li><code><jk>public</jk> T(String in);</code>
* </ul>
*
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
+ * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
+ * classes.
* @param arg The input argument value.
* @return A new instance of the object, or <jk>null</jk> if there is no string constructor on the object.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is inaccessible.
+ * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
+ * the underlying constructor is inaccessible.
* @throws IllegalArgumentException If the parameter type on the method was invalid.
* @throws InstantiationException If the class that declares the underlying constructor represents an abstract class, or
* does not have one of the methods described above.
@@ -1434,13 +1448,15 @@ public final class ClassMeta<T> implements Type {
* </ul>
*
* @param session The current bean session.
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
+ * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
+ * classes.
* @param arg The input argument value.
* @return A new instance of the object, or <jk>null</jk> if there is no numeric constructor on the object.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is inaccessible.
+ * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
+ * the underlying constructor is inaccessible.
* @throws IllegalArgumentException If the parameter type on the method was invalid.
- * @throws InstantiationException If the class that declares the underlying constructor represents an abstract class, or
- * does not have one of the methods described above.
+ * @throws InstantiationException If the class that declares the underlying constructor represents an abstract
+ * class, or does not have one of the methods described above.
* @throws InvocationTargetException If the underlying constructor throws an exception.
*/
public T newInstanceFromNumber(BeanSession session, Object outer, Number arg) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, InstantiationException {
@@ -1458,12 +1474,14 @@ public final class ClassMeta<T> implements Type {
* Create a new instance of the main class of this declared type.
*
* @return A new instance of the object, or <jk>null</jk> if there is no no-arg constructor on the object.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is inaccessible.
+ * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
+ * the underlying constructor is inaccessible.
* @throws IllegalArgumentException If one of the following occurs:
* <ul class='spaced-list'>
* <li>The number of actual and formal parameters differ.
* <li>An unwrapping conversion for primitive arguments fails.
- * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion.
+ * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
+ * conversion.
* <li>The constructor pertains to an enum type.
* </ul>
* @throws InstantiationException If the class that declares the underlying constructor represents an abstract class.
@@ -1487,14 +1505,17 @@ public final class ClassMeta<T> implements Type {
/**
* Same as {@link #newInstance()} except for instantiating non-static member classes.
*
- * @param outer The instance of the owning object of the member class instance. Can be <jk>null</jk> if instantiating a non-member or static class.
+ * @param outer The instance of the owning object of the member class instance. Can be <jk>null</jk> if
+ * instantiating a non-member or static class.
* @return A new instance of the object, or <jk>null</jk> if there is no no-arg constructor on the object.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is inaccessible.
+ * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
+ * the underlying constructor is inaccessible.
* @throws IllegalArgumentException If one of the following occurs:
* <ul class='spaced-list'>
* <li>The number of actual and formal parameters differ.
* <li>An unwrapping conversion for primitive arguments fails.
- * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion.
+ * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
+ * conversion.
* <li>The constructor pertains to an enum type.
* </ul>
* @throws InstantiationException If the class that declares the underlying constructor represents an abstract class.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/Context.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Context.java b/juneau-core/src/main/java/org/apache/juneau/Context.java
index 1a5a37c..df8bf27 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Context.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Context.java
@@ -17,7 +17,8 @@ import org.apache.juneau.json.*;
import org.apache.juneau.serializer.*;
/**
- * A reusable stateless thread-safe read-only configuration, typically used for creating one-time use {@link Session} objects.
+ * A reusable stateless thread-safe read-only configuration, typically used for creating one-time use {@link Session}
+ * objects.
* <p>
* Contexts are created through the {@link PropertyStore#getContext(Class)} method.
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java b/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
index 8e00384..6bda4e1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
@@ -317,7 +317,8 @@ public abstract class CoreObjectBuilder {
}
/**
- * <b>Configuration property:</b> {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property value.
+ * <b>Configuration property:</b> {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
+ * value.
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMapPutReturnsOldValue"</js>
@@ -326,7 +327,8 @@ public abstract class CoreObjectBuilder {
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
* <p>
- * If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property values.
+ * If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
+ * values.
* Otherwise, it returns <jk>null</jk>.
* <p>
* Disabled by default because it introduces a slight performance penalty.
@@ -490,8 +492,8 @@ public abstract class CoreObjectBuilder {
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
* <p>
- * If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an {@link InvocationHandler}
- * if there is no other way of instantiating them.
+ * If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an
+ * {@link InvocationHandler} if there is no other way of instantiating them.
* <p>
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -1305,8 +1307,10 @@ public abstract class CoreObjectBuilder {
* This list can consist of the following class types:
* <ul>
* <li>Any bean class that specifies a value for {@link Bean#typeName() @Bean.typeName()}.
- * <li>Any subclass of {@link BeanDictionaryList} containing a collection of bean classes with type name annotations.
- * <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name annotations.
+ * <li>Any subclass of {@link BeanDictionaryList} containing a collection of bean classes with type name
+ * annotations.
+ * <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name
+ * annotations.
* </ul>
* <p>
* <h5 class='section'>Notes:</h5>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java b/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
index 9d640a3..f4fc490 100644
--- a/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
+++ b/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
@@ -19,7 +19,8 @@ import org.apache.juneau.json.*;
/**
* General invalid conversion exception.
* <p>
- * Exception that gets thrown if you try to perform an invalid conversion, such as when calling {@code ObjectMap.getInt(...)} on a non-numeric <code>String</code>.
+ * Exception that gets thrown if you try to perform an invalid conversion, such as when calling
+ * {@code ObjectMap.getInt(...)} on a non-numeric <code>String</code>.
*/
public final class InvalidDataConversionException extends FormattedRuntimeException {
@@ -31,7 +32,8 @@ public final class InvalidDataConversionException extends FormattedRuntimeExcept
* @param value The value being converted.
*/
public InvalidDataConversionException(Object value, Class<?> toType, Exception cause) {
- super(cause, "Invalid data conversion from type ''{0}'' to type ''{1}''. Value={2}.", getReadableClassNameForObject(value), getReadableClassName(toType), getValue(value));
+ super(cause, "Invalid data conversion from type ''{0}'' to type ''{1}''. Value={2}.",
+ getReadableClassNameForObject(value), getReadableClassName(toType), getValue(value));
}
/**
@@ -40,7 +42,8 @@ public final class InvalidDataConversionException extends FormattedRuntimeExcept
* @param value The value being converted.
*/
public InvalidDataConversionException(Object value, ClassMeta<?> toType, Exception cause) {
- super(cause, "Invalid data conversion from type ''{0}'' to type ''{1}''. Value={2}.", getReadableClassNameForObject(value), toType.toString(), getValue(value));
+ super(cause, "Invalid data conversion from type ''{0}'' to type ''{1}''. Value={2}.",
+ getReadableClassNameForObject(value), toType.toString(), getValue(value));
}
private static String getValue(Object o) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ObjectList.java b/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
index d5f8939..916e862 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
@@ -143,7 +143,8 @@ public class ObjectList extends LinkedList<Object> {
if (s != null)
p.parseIntoCollection(s, this, session.object());
} catch (ParseException e) {
- throw new ParseException("Invalid input for {0} parser.\n---start---\n{1}\n---end---", p.getClass().getSimpleName(), s).initCause(e);
+ throw new ParseException("Invalid input for {0} parser.\n---start---\n{1}\n---end---",
+ p.getClass().getSimpleName(), s).initCause(e);
}
}
@@ -160,7 +161,8 @@ public class ObjectList extends LinkedList<Object> {
/**
* Construct a JSON array directly from a reader using the specified parser.
*
- * @param r The reader to read from. Will automatically be wrapped in a {@link BufferedReader} if it isn't already a BufferedReader.
+ * @param r The reader to read from. Will automatically be wrapped in a {@link BufferedReader} if it isn't already
+ * a BufferedReader.
* @param p The parser to use to parse the input.
* @throws ParseException If the input contains a syntax error or is malformed.
* @throws IOException If a problem occurred trying to read from the reader.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java b/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
index 5e00901..42a27b1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
@@ -47,7 +47,8 @@ import org.apache.juneau.utils.*;
* m = <jk>new</jk> ObjectMap(json);
*
* <jc>// Construct a Map using the append method</jc>
- * m = <jk>new</jk> ObjectMap().append(<js>"foo"</js>,<js>"x"</js>).append(<js>"bar"</js>,123).append(<js>"baz"</js>,<jk>true</jk>);
+ * m = <jk>new</jk> ObjectMap().append(<js>"foo"</js>,<js>"x"</js>).append(<js>"bar"</js>,123)
+ * .append(<js>"baz"</js>,<jk>true</jk>);
*
* <jc>// Construct a Map from XML generated by XmlSerializer</jc>
* String xml = <js>"<object><a type='string'>A</a><b type='object'><c type='string'>C</c><d type='number'>123</d></b></object>"</js>;
@@ -154,7 +155,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
if (! StringUtils.isEmpty(s))
p.parseIntoMap(s, this, session.string(), session.object());
} catch (ParseException e) {
- throw new ParseException("Invalid input for {0} parser.\n---start---\n{1}\n---end---", p.getClass().getSimpleName(), s).initCause(e);
+ throw new ParseException("Invalid input for {0} parser.\n---start---\n{1}\n---end---",
+ p.getClass().getSimpleName(), s).initCause(e);
}
}
@@ -254,7 +256,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Searches for the specified key in this map ignoring case.
*
- * @param key The key to search for. For performance reasons, it's preferrable that the key be all lowercase.
+ * @param key The key to search for. For performance reasons, it's preferable that the key be all lowercase.
* @return The key, or <jk>null</jk> if map does not contain this key.
*/
public String findKeyIgnoreCase(String key) {
@@ -353,7 +355,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Same as {@link Map#get(Object) get()}, but converts the raw value to the specified class type using the specified beanFilter.
+ * Same as {@link Map#get(Object) get()}, but converts the raw value to the specified class type using the specified
+ * beanFilter.
*
* @param <T> The transformed class type.
* @param pojoSwap The swap class used to convert the raw type to a transformed type.
@@ -470,7 +473,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* ObjectMap m = getObjectMap();
*
* <jc>// Long way</jc>
- * <jk>long</jk> l = m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).getObjectMap(<js>"0"</js>).getLong(<js>"baz"</js>);
+ * <jk>long</jk> l = m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).getObjectMap(<js>"0"</js>)
+ * .getLong(<js>"baz"</js>);
*
* <jc>// Using this method</jc>
* <jk>long</jk> l = m.getAt(<jk>long</jk>.<jk>class</jk>, <js>"foo/bar/0/baz"</js>);
@@ -498,7 +502,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* ObjectMap m = getObjectMap();
*
* <jc>// Long way</jc>
- * m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).getObjectMap(<js>"0"</js>).put(<js>"baz"</js>, 123);
+ * m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).getObjectMap(<js>"0"</js>)
+ * .put(<js>"baz"</js>, 123);
*
* <jc>// Using this method</jc>
* m.putAt(<js>"foo/bar/0/baz"</js>, 123);
@@ -1111,7 +1116,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/*
* Combines the class specified by a "_type" attribute with the ClassMeta
* passed in through the cast(ClassMeta) method.
- * The rule is that child classes superceed parent classes, and c2 superceeds c1
+ * The rule is that child classes supersede parent classes, and c2 supersedes c1
* if one isn't the parent of another.
*/
private ClassMeta<?> narrowClassMeta(ClassMeta<?> c1, ClassMeta<?> c2) {
@@ -1197,10 +1202,13 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
} catch (Exception e) {
- throw new BeanRuntimeException(cm.innerClass, "Error occurred attempting to cast to an object of type ''{0}''", cm.innerClass.getName()).initCause(e);
+ throw new BeanRuntimeException(cm.innerClass,
+ "Error occurred attempting to cast to an object of type ''{0}''", cm.innerClass.getName()).initCause(e);
}
- throw new BeanRuntimeException(cm.innerClass, "Cannot convert to class type ''{0}''. Only beans and maps can be converted using this method.", cm.innerClass.getName());
+ throw new BeanRuntimeException(cm.innerClass,
+ "Cannot convert to class type ''{0}''. Only beans and maps can be converted using this method.",
+ cm.innerClass.getName());
}
private PojoRest getPojoRest() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java b/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
index 9e2a33c..35ef6dd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
+++ b/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
@@ -30,12 +30,17 @@ import org.apache.juneau.parser.*;
* <p>
* The hierarchy of these objects are...
* <ul class='spaced-list'>
- * <li>{@link PropertyStore} - A thread-safe, modifiable context property store.<br>
+ * <li>{@link PropertyStore} - A thread-safe, modifiable context property store.
+ * <br>
* Used to create {@link Context} objects.
- * <li>{@link Context} - A reusable, cachable, thread-safe, read-only context with configuration properties copied from the store.<br>
+ *
+ * <li>{@link Context} - A reusable, cacheable, thread-safe, read-only context with configuration properties copied
+ * from the store.
+ * <br>
* Often used to create {@link Session} objects.
- * <li>{@link Session} - A one-time-use non-thread-safe object.<br>
- * Used by serializers and parsers to retrieve context properties and to be used as scratchpads.
+ *
+ * <li>{@link Session} - A one-time-use non-thread-safe object.
+ * <br>Used by serializers and parsers to retrieve context properties and to be used as scratchpads.
* </ul>
*
* <h6 class='topic'>PropertyStore objects</h6>
@@ -48,69 +53,96 @@ import org.apache.juneau.parser.*;
* <p>
* Property stores are used to create and cache {@link Context} objects using the {@link #getContext(Class)} method.
* <p>
- * As a general rule, {@link PropertyStore} objects are 'slow'.<br>
- * Setting and retrieving properties on a store can involve relatively slow data conversion and synchronization.<br>
- * However, the {@link #getContext(Class)} method is fast, and will return cached context objects if the context properties have not changed.
+ * As a general rule, {@link PropertyStore} objects are 'slow'.
+ * <br>
+ * Setting and retrieving properties on a store can involve relatively slow data conversion and synchronization.
+ * <br>
+ * However, the {@link #getContext(Class)} method is fast, and will return cached context objects if the context
+ * properties have not changed.
* <p>
- * Property stores can be used to store context properties for a variety of contexts.<br>
+ * Property stores can be used to store context properties for a variety of contexts.
+ * <br>
* For example, a single store can store context properties for the JSON serializer, XML serializer, HTML serializer
- * etc... and can thus be used to retrieve context objects for those serializers.<br>
+ * etc... and can thus be used to retrieve context objects for those serializers.
* <p>
*
* <h6 class='topic'>Context properties</h6>
* <p>
- * Context properties are 'settings' for serializers and parsers.<br>
- * For example, the {@link BeanContext#BEAN_sortProperties} context property defines whether
- * bean properties should be serialized in alphabetical order.
+ * Context properties are 'settings' for serializers and parsers.
+ * <br>
+ * For example, the {@link BeanContext#BEAN_sortProperties} context property defines whether bean properties should be
+ * serialized in alphabetical order.
* <p>
- * Each {@link Context} object should contain the context properties that apply to it as static
- * fields (e.g {@link BeanContext#BEAN_sortProperties}).
+ * Each {@link Context} object should contain the context properties that apply to it as static fields
+ * (e.g {@link BeanContext#BEAN_sortProperties}).
* <p>
* Context properties can be of the following types:
* <ul class='spaced-list'>
- * <li><l>SIMPLE</l> - A simple property.<br>
- * Examples include: booleans, integers, Strings, Classes, etc...<br>
+ * <li><l>SIMPLE</l> - A simple property.
+ * <br>
+ * Examples include: booleans, integers, Strings, Classes, etc...
+ * <br><br>
+ * An example of this would be the {@link BeanContext#BEAN_sortProperties} property.
* <br>
- * An example of this would be the {@link BeanContext#BEAN_sortProperties} property.<br>
* It's name is simply <js>"BeanContext.sortProperties"</js>.
*
- * <li><l>SET</l> - A sorted set of objects.<br>
- * These are denoted by appending <js>".set"</js> to the property name.<br>
- * Objects can be of any type, even complex types.<br>
- * Sorted sets use tree sets to maintain the value in alphabetical order.<br>
+ * <li><l>SET</l> - A sorted set of objects.
+ * <br>
+ * These are denoted by appending <js>".set"</js> to the property name.
+ * <br>
+ * Objects can be of any type, even complex types.
+ * <br>
+ * Sorted sets use tree sets to maintain the value in alphabetical order.
+ * <br>
+ * For example, the {@link BeanContext#BEAN_notBeanClasses} property is used to store classes that should not be
+ * treated like beans.
* <br>
- * For example, the {@link BeanContext#BEAN_notBeanClasses} property is used to store classes that should not be treated like beans.<br>
* It's name is <js>"BeanContext.notBeanClasses.set"</js>.
*
- * <li><l>LIST</l> - A list of unique objects.<br>
- * These are denoted by appending <js>".list"</js> to the property name.<br>
- * Objects can be of any type, even complex types.<br>
- * Use lists if the ordering of the values in the set is important (similar to how the order of entries in a classpath is important).<br>
+ * <li><l>LIST</l> - A list of unique objects.
+ * <br>
+ * These are denoted by appending <js>".list"</js> to the property name.
+ * <br>
+ * Objects can be of any type, even complex types.
+ * <br>
+ * Use lists if the ordering of the values in the set is important (similar to how the order of entries in a
+ * classpath is important).
+ * <br>
+ * <br>
+ * For example, the {@link BeanContext#BEAN_beanFilters} property is used to store bean filters.
* <br>
- * For example, the {@link BeanContext#BEAN_beanFilters} property is used to store bean filters.<br>
* It's name is <js>"BeanContext.transforms.list"</js>.
*
- * <li><l>MAP</l> - A sorted map of key-value pairs.<br>
- * These are denoted by appending <js>".map"</js> to the property name.<br>
- * Keys can be any type directly convertable to and from Strings.
- * Values can be of any type, even complex types.<br>
+ * <li><l>MAP</l> - A sorted map of key-value pairs.
+ * <br>
+ * These are denoted by appending <js>".map"</js> to the property name.
+ * <br>
+ * Keys can be any type directly convertible to and from Strings.
+ * Values can be of any type, even complex types.
* <br>
- * For example, the {@link BeanContext#BEAN_implClasses} property is used to specify the names of implementation classes for interfaces.<br>
- * It's name is <js>"BeanContext.implClasses.map"</js>.<br>
+ * <br>
+ * For example, the {@link BeanContext#BEAN_implClasses} property is used to specify the names of implementation
+ * classes for interfaces.
+ * <br>
+ * It's name is <js>"BeanContext.implClasses.map"</js>.
* </ul>
* <p>
* All context properties are set using the {@link #setProperty(String, Object)} method.
* <p>
- * Default values for context properties can be specified globally as system properties.<br>
+ * Default values for context properties can be specified globally as system properties.
+ * <br>
* Example: <code>System.<jsm>setProperty</jsm>(<jsf>BEAN_sortProperties</jsf>, <jk>true</jk>);</code>
* <p>
- * SET and LIST properties can be added to using the {@link #addToProperty(String, Object)} method and removed from using the {@link #removeFromProperty(String, Object)} method.
+ * SET and LIST properties can be added to using the {@link #addToProperty(String, Object)} method and removed from
+ * using the {@link #removeFromProperty(String, Object)} method.
* <p>
- * SET and LIST properties can also be added to and removed from by appending <js>".add"</js> or <js>".remove"</js> to the property name and using the {@link #setProperty(String, Object)} method.
+ * SET and LIST properties can also be added to and removed from by appending <js>".add"</js> or <js>".remove"</js> to
+ * the property name and using the {@link #setProperty(String, Object)} method.
* <p>
* The following shows the two different ways to append to a set or list property:
* <p class='bcode'>
- * PropertyStore ps = <jk>new</jk> PropertyStore().setProperty(<js>"BeanContext.notBeanClasses.set"</js>, Collections.<jsm>emptySet</jsm>());
+ * PropertyStore ps = <jk>new</jk> PropertyStore().setProperty(<js>"BeanContext.notBeanClasses.set"</js>,
+ * Collections.<jsm>emptySet</jsm>());
*
* <jc>// Append to set property using addTo().</jc>
* ps.addToProperty(<js>"BeanContext.notBeanClasses.set"</js>, MyNotBeanClass.<jk>class</jk>);
@@ -136,13 +168,19 @@ import org.apache.juneau.parser.*;
* ps.removeFromProperty(<js>"BeanContext.notBeanClasses.set"</js>, <js>"['com.my.MyNotBeanClass3']"</js>);
* </p>
* <p>
- * MAP properties can be added to using the {@link #putToProperty(String, Object, Object)} and {@link #putToProperty(String, Object)} methods.<br>
- * MAP property entries can be removed by setting the value to <jk>null</jk> (e.g. <code>putToProperty(<js>"BEAN_implClasses"</js>, MyNotBeanClass.<jk>class</jk>, <jk>null</jk>);</code>.<br>
- * MAP properties can also be added to by appending <js>".put"</js> to the property name and using the {@link #setProperty(String, Object)} method.<br>
+ * MAP properties can be added to using the {@link #putToProperty(String, Object, Object)} and
+ * {@link #putToProperty(String, Object)} methods.
+ * <br>
+ * MAP property entries can be removed by setting the value to <jk>null</jk>
+ * (e.g. <code>putToProperty(<js>"BEAN_implClasses"</js>, MyNotBeanClass.<jk>class</jk>, <jk>null</jk>);</code>.
+ * <br>
+ * MAP properties can also be added to by appending <js>".put"</js> to the property name and using the
+ * {@link #setProperty(String, Object)} method.
* <p>
* The following shows the two different ways to append to a set property:
* <p class='bcode'>
- * PropertyStore ps = PropertyStore.<jsm>create</jsm>().setProperty(<js>"BeanContext.implClasses.map"</js>, Collections.<jsm>emptyMap</jsm>());
+ * PropertyStore ps = PropertyStore.<jsm>create</jsm>().setProperty(<js>"BeanContext.implClasses.map"</js>,
+ * Collections.<jsm>emptyMap</jsm>());
*
* <jc>// Append to map property using putTo().</jc>
* ps.putToProperty(<js>"BeanContext.implClasses.map"</js>, MyInterface.<jk>class</jk>, MyInterfaceImpl.<jk>class</jk>);
@@ -157,10 +195,12 @@ import org.apache.juneau.parser.*;
* PropertyStore ps = PropertyStore.<jsm>create</jsm>();
*
* <jc>// Set MAP value using JSON object.</jc>
- * ps.setProperty(<js>"BeanContext.implClasses.map"</js>, <js>"{'com.my.MyInterface1':'com.my.MyInterfaceImpl1'}"</js>);
+ * ps.setProperty(<js>"BeanContext.implClasses.map"</js>,
+ * <js>"{'com.my.MyInterface1':'com.my.MyInterfaceImpl1'}"</js>);
*
* <jc>// Add to MAP using JSON object.</jc>
- * ps.putToProperty(<js>"BeanContext.implClasses.map"</js>, <js>"{'com.my.MyInterface2':'com.my.MyInterfaceImpl2'}"</js>);
+ * ps.putToProperty(<js>"BeanContext.implClasses.map"</js>,
+ * <js>"{'com.my.MyInterface2':'com.my.MyInterfaceImpl2'}"</js>);
*
* <jc>// Remove from MAP using JSON object.</jc>
* ps.putToProperty(<js>"BeanContext.implClasses.map"</js>, <js>"{'com.my.MyInterface2':null}"</js>);
@@ -168,22 +208,27 @@ import org.apache.juneau.parser.*;
* <p>
* Context properties are retrieved from this store using the following 3 methods:
* <ul class='spaced-list'>
- * <li>{@link #getProperty(String, Class, Object)} - Retrieve a SIMPLE or SET property converted to the specified class type.
- * <li>{@link #getMap(String, Class, Class, Map)} - Retrieve a MAP property with keys/values converted to the specified class types.
- * <li>{@link #getPropertyMap(String)} - Retrieve a map of all context properties with the specified prefix (e.g. <js>"BeanContext"</js> for {@link BeanContext} properties).
+ * <li>{@link #getProperty(String, Class, Object)} - Retrieve a SIMPLE or SET property converted to the specified
+ * class type.
+ * <li>{@link #getMap(String, Class, Class, Map)} - Retrieve a MAP property with keys/values converted to the
+ * specified class types.
+ * <li>{@link #getPropertyMap(String)} - Retrieve a map of all context properties with the specified prefix
+ * (e.g. <js>"BeanContext"</js> for {@link BeanContext} properties).
* </ul>
* <p>
* As a general rule, only {@link Context} objects will use these read methods.
*
* <h6 class='topic'>Context objects</h6>
* <p>
- * A Context object can be thought of as unmodifiable snapshot of a store.<br>
- * They should be 'fast' by avoiding synchronization by using final fields whenever possible.<br>
+ * A Context object can be thought of as unmodifiable snapshot of a store.
+ * <br>
+ * They should be 'fast' by avoiding synchronization by using final fields whenever possible.
+ * <br>
* However, they MUST be thread safe.
* <p>
- * Context objects are created using the {@link #getContext(Class)} method.<br>
- * As long as the properties on a store have not been modified, the store will return a cached copy
- * of a context.
+ * Context objects are created using the {@link #getContext(Class)} method.
+ * <br>
+ * As long as the properties on a store have not been modified, the store will return a cached copy of a context.
* <p class='bcode'>
* PropertyStore ps = PropertyStore.<jsm>create</jsm>();
*
@@ -204,13 +249,16 @@ import org.apache.juneau.parser.*;
*
* <h6 class='topic'>Session objects</h6>
* <p>
- * Session objects are created through {@link Context} objects, typically through a <code>createContext()</code> method.<br>
- * Unlike context objects, they are NOT reusable and NOT thread safe.<br>
- * They are meant to be used one time and then thrown away.<br>
+ * Session objects are created through {@link Context} objects, typically through a <code>createContext()</code> method.
+ * <br>
+ * Unlike context objects, they are NOT reusable and NOT thread safe.
+ * <br>
+ * They are meant to be used one time and then thrown away.
+ * <br>
* They should NEVER need to use synchronization.
* <p>
- * Session objects are also often used as scratchpads for information such as keeping track of call stack
- * information to detect recursive loops when serializing beans.
+ * Session objects are also often used as scratchpads for information such as keeping track of call stack information
+ * to detect recursive loops when serializing beans.
*/
public final class PropertyStore {
@@ -226,7 +274,8 @@ public final class PropertyStore {
// Global Context cache.
// Property stores that are the 'same' will use the same maps from this cache.
// 'same' means the context properties are all the same when converted to strings.
- private static final ConcurrentHashMap<Integer, ConcurrentHashMap<Class<? extends Context>,Context>> globalContextCache = new ConcurrentHashMap<Integer, ConcurrentHashMap<Class<? extends Context>,Context>>();
+ private static final ConcurrentHashMap<Integer, ConcurrentHashMap<Class<? extends Context>,Context>>
+ globalContextCache = new ConcurrentHashMap<Integer, ConcurrentHashMap<Class<? extends Context>,Context>>();
private ReadWriteLock lock = new ReentrantReadWriteLock();
private Lock rl = lock.readLock(), wl = lock.writeLock();
@@ -342,7 +391,8 @@ public final class PropertyStore {
* <tr>
* <td>Add/Remove <l>SET/LIST</l></td>
* <td><js>"Foo.x.set.add"</js></td>
- * <td>If a collection, adds or removes the entries in the collection. Otherwise, adds/removes a single entry.</td>
+ * <td>If a collection, adds or removes the entries in the collection. Otherwise, adds/removes a single
+ * entry.</td>
* </tr>
* <tr>
* <td>Set <l>MAP</l></td>
@@ -356,18 +406,16 @@ public final class PropertyStore {
* </tr>
* </table>
*
- * @param name The configuration property name.<br>
- * If name ends with <l>.add</l>, then the specified value is added to the
- * existing property value as an entry in a SET or LIST property.<br>
- * If name ends with <l>.put</l>, then the specified value is added to the
- * existing property value as a key/value pair in a MAP property.<br>
- * If name ends with <l>.remove</l>, then the specified value is removed from the
- * existing property property value in a SET or LIST property.<br>
- *
+ * @param name The configuration property name.
+ * <br>If name ends with <l>.add</l>, then the specified value is added to the existing property value as an entry
+ * in a SET or LIST property.
+ * <br>If name ends with <l>.put</l>, then the specified value is added to the existing property value as a
+ * key/value pair in a MAP property.
+ * <br>If name ends with <l>.remove</l>, then the specified value is removed from the existing property property
+ * value in a SET or LIST property.
* @param value The new value.
- * If <jk>null</jk>, the property value is deleted.<br>
- * In general, the value type can be anything.<br>
- *
+ * If <jk>null</jk>, the property value is deleted.
+ * In general, the value type can be anything.
* @return This object (for method chaining).
*/
public PropertyStore setProperty(String name, Object value) {
@@ -532,14 +580,12 @@ public final class PropertyStore {
}
/**
- * Returns an instance of the specified context initialized with the properties
- * in this store.
+ * Returns an instance of the specified context initialized with the properties in this store.
* <p>
- * Multiple calls to this method for the same store class will return the same
- * cached value as long as the properties on this store are not touched.
+ * Multiple calls to this method for the same store class will return the same cached value as long as the
+ * properties on this store are not touched.
* <p>
- * As soon as any properties are modified on this store, all cached entries
- * are discarded and recreated as needed.
+ * As soon as any properties are modified on this store, all cached entries are discarded and recreated as needed.
*
* @param c The context class to instantiate.
* @return The context instance.
@@ -574,8 +620,8 @@ public final class PropertyStore {
/**
* Returns the configuration properties with the specified prefix.
* <p>
- * For example, if <l>prefix</l> is <js>"BeanContext"</js>, then retrieves
- * all configuration properties that are prefixed with <js>"BeanContext."</js>.
+ * For example, if <l>prefix</l> is <js>"BeanContext"</js>, then retrieves all configuration properties that are
+ * prefixed with <js>"BeanContext."</js>.
*
* @param prefix The prefix of properties to retrieve.
* @return The configuration properties with the specified prefix, never <jk>null</jk>.
@@ -593,8 +639,8 @@ public final class PropertyStore {
/**
* Specifies the classloader to use when resolving classes from strings.
* <p>
- * Can be used for resolving class names when the classes being created are in a different
- * classloader from the Juneau code.
+ * Can be used for resolving class names when the classes being created are in a different classloader from the
+ * Juneau code.
* <p>
* If <jk>null</jk>, the system classloader will be used to resolve classes.
*
@@ -625,7 +671,6 @@ public final class PropertyStore {
* @param name The full name of the property (e.g. <js>"BeanContext.sortProperties"</js>)
* @param type The class type to convert the property value to.
* @param def The default value if the property is not set.
- *
* @return The property value.
* @throws ConfigException If property has a value that cannot be converted to a boolean.
*/
@@ -654,7 +699,6 @@ public final class PropertyStore {
* @param type The class type to convert the property value to.
* @param def The type to instantiate if the property is not set.
* @param args The arguments to pass to the default type constructor.
- *
* @return The property either cast to the specified type, or instantiated from a <code>Class</code> object.
* @throws ConfigException If property has a value that cannot be converted to a boolean.
*/
@@ -672,21 +716,21 @@ public final class PropertyStore {
return null;
if (ClassUtils.isParentClass(type, o.getClass()))
return (T)o;
- throw new FormattedRuntimeException("Invalid object of type {0} found in call to PropertyStore.getTypeProperty({1},{2},{3},...)", o.getClass(), name, type, def);
+ throw new FormattedRuntimeException(
+ "Invalid object of type {0} found in call to PropertyStore.getTypeProperty({1},{2},{3},...)",
+ o.getClass(), name, type, def);
} finally {
rl.unlock();
}
}
/**
- * Returns a property value converted to a {@link LinkedHashMap} with the specified
- * key and value types.
+ * Returns a property value converted to a {@link LinkedHashMap} with the specified key and value types.
*
* @param name The full name of the property (e.g. <js>"BeanContext.sortProperties"</js>)
* @param keyType The class type of the keys in the map.
* @param valType The class type of the values in the map.
* @param def The default value if the property is not set.
- *
* @return The property value.
* @throws ConfigException If property has a value that cannot be converted to a boolean.
*/
@@ -870,8 +914,8 @@ public final class PropertyStore {
* <p>
* Instances of this map are immutable from outside this class.
* <p>
- * The {@link PropertyMap#hashCode()} and {@link PropertyMap#equals(Object)} methods
- * can be used to compare with other property maps.
+ * The {@link PropertyMap#hashCode()} and {@link PropertyMap#equals(Object)} methods can be used to compare with
+ * other property maps.
*/
@SuppressWarnings("hiding")
public class PropertyMap {
@@ -918,7 +962,6 @@ public final class PropertyStore {
* @param name The property name.
* @param type The type of object to convert the value to.
* @param def The default value if the specified property is not set.
- *
* @return The property value.
*/
public <T> T get(String name, Class<T> type, T def) {
@@ -932,7 +975,8 @@ public final class PropertyStore {
return def;
return getBeanSession().convertToType(p.value, type);
} catch (InvalidDataConversionException e) {
- throw new ConfigException("Could not retrieve property store property ''{0}''. {1}", p.name, e.getMessage());
+ throw new ConfigException("Could not retrieve property store property ''{0}''. {1}", p.name,
+ e.getMessage());
}
} finally {
rl.unlock();
@@ -948,7 +992,6 @@ public final class PropertyStore {
* @param keyType The class type of the keys of the map.
* @param valueType The class type of the values of the map.
* @param def The default value if the specified property is not set.
- *
* @return The property value.
*/
@SuppressWarnings("unchecked")
@@ -961,11 +1004,13 @@ public final class PropertyStore {
try {
if (isBeanSessionAvailable()) {
BeanSession session = getBeanSession();
- return (Map<K,V>)session.convertToType(p.value, session.getClassMeta(LinkedHashMap.class, keyType, valueType));
+ return (Map<K,V>)session.convertToType(p.value,
+ session.getClassMeta(LinkedHashMap.class, keyType, valueType));
}
return def;
} catch (InvalidDataConversionException e) {
- throw new ConfigException("Could not retrieve property store property ''{0}''. {1}", p.name, e.getMessage());
+ throw new ConfigException("Could not retrieve property store property ''{0}''. {1}", p.name,
+ e.getMessage());
}
} finally {
rl.unlock();
@@ -1110,19 +1155,24 @@ public final class PropertyStore {
}
void add(Object val) {
- throw new ConfigException("Cannot add value {0} ({1}) to property ''{2}'' ({3}).", JsonSerializer.DEFAULT_LAX.toString(val), getReadableClassNameForObject(val), name, type);
+ throw new ConfigException("Cannot add value {0} ({1}) to property ''{2}'' ({3}).",
+ JsonSerializer.DEFAULT_LAX.toString(val), getReadableClassNameForObject(val), name, type);
}
void remove(Object val) {
- throw new ConfigException("Cannot remove value {0} ({1}) from property ''{2}'' ({3}).", JsonSerializer.DEFAULT_LAX.toString(val), getReadableClassNameForObject(val), name, type);
+ throw new ConfigException("Cannot remove value {0} ({1}) from property ''{2}'' ({3}).",
+ JsonSerializer.DEFAULT_LAX.toString(val), getReadableClassNameForObject(val), name, type);
}
void put(Object val) {
- throw new ConfigException("Cannot put value {0} ({1}) to property ''{2}'' ({3}).", JsonSerializer.DEFAULT_LAX.toString(val), getReadableClassNameForObject(val), name, type);
+ throw new ConfigException("Cannot put value {0} ({1}) to property ''{2}'' ({3}).",
+ JsonSerializer.DEFAULT_LAX.toString(val), getReadableClassNameForObject(val), name, type);
}
void put(Object key, Object val) {
- throw new ConfigException("Cannot put value {0}({1})->{2}({3}) to property ''{4}'' ({5}).", JsonSerializer.DEFAULT_LAX.toString(key), getReadableClassNameForObject(key), JsonSerializer.DEFAULT_LAX.toString(val), getReadableClassNameForObject(val), name, type);
+ throw new ConfigException("Cannot put value {0}({1})->{2}({3}) to property ''{4}'' ({5}).",
+ JsonSerializer.DEFAULT_LAX.toString(key), getReadableClassNameForObject(key),
+ JsonSerializer.DEFAULT_LAX.toString(val), getReadableClassNameForObject(val), name, type);
}
protected Object value() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/Session.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Session.java b/juneau-core/src/main/java/org/apache/juneau/Session.java
index 4f253d4..43f0189 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Session.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Session.java
@@ -116,7 +116,7 @@ public abstract class Session {
* Can be used to store objects for reuse during a session.
*
* @param key The key. Can be any string.
- * @param val The cahed object.
+ * @param val The cached object.
*/
public void addToCache(String key, Object val) {
if (cache == null)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/UriContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/UriContext.java b/juneau-core/src/main/java/org/apache/juneau/UriContext.java
index 0401230..1c8be0b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/UriContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/UriContext.java
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* </p>
* <p>
* This class allows you to convert URL strings to absolute (e.g. <js>"http://host:port/foo/bar"</js>) or root-relative
- * (e.g. <js>"/foo/bar"</js>) URLs.
+ * (e.g. <js>"/foo/bar"</js>) URLs.
*/
@Bean
public class UriContext {
@@ -51,7 +51,8 @@ public class UriContext {
* Any parameter can be <jk>null</jk>. Blanks and nulls are equivalent.
*
* @param authority - The authority portion of URL (e.g. <js>"http://hostname:port"</js>)
- * @param contextRoot - The context root of the application (e.g. <js>"/context-root"</js>, or <js>"context-root"</js>)
+ * @param contextRoot - The context root of the application (e.g. <js>"/context-root"</js>, or
+ * <js>"context-root"</js>)
* @param servletPath - The servlet path (e.g. <js>"/servlet-path"</js>, or <js>"servlet-path"</js>)
* @param pathInfo - The path info (e.g. <js>"/path-info"</js>, or <js>"path-info"</js>)
*/
@@ -61,7 +62,8 @@ public class UriContext {
this.contextRoot = nullIfEmpty(trimSlashes(contextRoot));
this.servletPath = nullIfEmpty(trimSlashes(servletPath));
this.pathInfo = nullIfEmpty(trimSlashes(pathInfo));
- this.parentPath = this.pathInfo == null || this.pathInfo.indexOf('/') == -1 ? null : this.pathInfo.substring(0, this.pathInfo.lastIndexOf('/'));
+ this.parentPath = this.pathInfo == null || this.pathInfo.indexOf('/') == -1 ? null
+ : this.pathInfo.substring(0, this.pathInfo.lastIndexOf('/'));
}
/**
@@ -99,7 +101,11 @@ public class UriContext {
if (authority == null)
aContextRoot = getRootRelativeContextRoot();
else
- aContextRoot = (contextRoot == null ? authority : (authority + '/' + contextRoot));
+ aContextRoot = (
+ contextRoot == null
+ ? authority
+ : (authority + '/' + contextRoot)
+ );
}
return aContextRoot;
}
@@ -132,9 +138,17 @@ public class UriContext {
aServletPath = getRootRelativeServletPath();
else {
if (contextRoot == null)
- aServletPath = (servletPath == null ? authority : authority + '/' + servletPath);
+ aServletPath = (
+ servletPath == null
+ ? authority
+ : authority + '/' + servletPath
+ );
else
- aServletPath = (servletPath == null ? (authority + '/' + contextRoot) : (authority + '/' + contextRoot + '/' + servletPath));
+ aServletPath = (
+ servletPath == null
+ ? (authority + '/' + contextRoot)
+ : (authority + '/' + contextRoot + '/' + servletPath)
+ );
}
}
return aServletPath;
@@ -151,9 +165,17 @@ public class UriContext {
public String getRootRelativeServletPath() {
if (rResource == null) {
if (contextRoot == null)
- rResource = (servletPath == null ? "/" : ('/' + servletPath));
+ rResource = (
+ servletPath == null
+ ? "/"
+ : ('/' + servletPath)
+ );
else
- rResource = (servletPath == null ? ('/' + contextRoot) : ('/' + contextRoot + '/' + servletPath));
+ rResource = (
+ servletPath == null
+ ? ('/' + contextRoot)
+ : ('/' + contextRoot + '/' + servletPath)
+ );
}
return rResource;
}
@@ -191,14 +213,29 @@ public class UriContext {
else {
if (contextRoot == null) {
if (servletPath == null)
- aPathInfo = (pathInfo == null ? authority : (authority + '/' + pathInfo));
+ aPathInfo = (
+ pathInfo == null
+ ? authority : (authority + '/' + pathInfo)
+ );
else
- aPathInfo = (pathInfo == null ? (authority + '/' + servletPath) : (authority + '/' + servletPath + '/' + pathInfo));
+ aPathInfo = (
+ pathInfo == null
+ ? (authority + '/' + servletPath)
+ : (authority + '/' + servletPath + '/' + pathInfo)
+ );
} else {
if (servletPath == null)
- aPathInfo = (pathInfo == null ? authority + '/' + contextRoot : (authority + '/' + contextRoot + '/' + pathInfo));
+ aPathInfo = (
+ pathInfo == null
+ ? authority + '/' + contextRoot
+ : (authority + '/' + contextRoot + '/' + pathInfo)
+ );
else
- aPathInfo = (pathInfo == null ? (authority + '/' + contextRoot + '/' + servletPath) : (authority + '/' + contextRoot + '/' + servletPath + '/' + pathInfo));
+ aPathInfo = (
+ pathInfo == null
+ ? (authority + '/' + contextRoot + '/' + servletPath)
+ : (authority + '/' + contextRoot + '/' + servletPath + '/' + pathInfo)
+ );
}
}
}
@@ -217,14 +254,30 @@ public class UriContext {
if (rPath == null) {
if (contextRoot == null) {
if (servletPath == null)
- rPath = (pathInfo == null ? "/" : ('/' + pathInfo));
+ rPath = (
+ pathInfo == null
+ ? "/"
+ : ('/' + pathInfo)
+ );
else
- rPath = (pathInfo == null ? ('/' + servletPath) : ('/' + servletPath + '/' + pathInfo));
+ rPath = (
+ pathInfo == null
+ ? ('/' + servletPath)
+ : ('/' + servletPath + '/' + pathInfo)
+ );
} else {
if (servletPath == null)
- rPath = (pathInfo == null ? ('/' + contextRoot) : ('/' + contextRoot + '/' + pathInfo));
+ rPath = (
+ pathInfo == null
+ ? ('/' + contextRoot)
+ : ('/' + contextRoot + '/' + pathInfo)
+ );
else
- rPath = (pathInfo == null ? ('/' + contextRoot + '/' + servletPath) : ('/' + contextRoot + '/' + servletPath + '/' + pathInfo));
+ rPath = (
+ pathInfo == null
+ ? ('/' + contextRoot + '/' + servletPath)
+ : ('/' + contextRoot + '/' + servletPath + '/' + pathInfo)
+ );
}
}
return rPath;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/UriResolver.java b/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
index 995569a..b279cef 100644
--- a/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
+++ b/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
@@ -29,7 +29,8 @@ import org.apache.juneau.internal.*;
* ({@link UriRelativity}) to define simple {@link #resolve(Object)} and {@link #append(Appendable, Object)}
* methods.
* <p>
- * Three special protocols are used to represent context-root-relative, servlet-relative, and request-path-relative URIs:
+ * Three special protocols are used to represent context-root-relative, servlet-relative, and request-path-relative
+ * URIs:
* <js>"context:/"</js>, <js>"servlet:/"</js>, and <js>"request:/"</js>.
*
* The following list shows the protocols of URLs that can be resolved with this class:
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
index 0db3256..ba1ede3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
@@ -47,8 +47,8 @@ public @interface Bean {
* output so that the class can be determined during parsing.
* It is also used to specify element names in XML.
* <p>
- * The name is used in combination with the bean dictionary defined through {@link BeanProperty#beanDictionary()} or {@link BeanContext#BEAN_beanDictionary}. Together, they make up
- * a simple name/value mapping of names to classes.
+ * The name is used in combination with the bean dictionary defined through {@link BeanProperty#beanDictionary()} or
+ * {@link BeanContext#BEAN_beanDictionary}. Together, they make up a simple name/value mapping of names to classes.
* Names do not need to be universally unique. However, they must be unique within a dictionary.
*
* <h5 class='section'>Example:</h5>
@@ -123,16 +123,19 @@ public @interface Bean {
* common HTML attribute names.
* </ul>
*
- * The default value if not specified is <js>"_type"</js> unless overridden by the {@link BeanContext#BEAN_beanTypePropertyName} setting.
+ * The default value if not specified is <js>"_type"</js> unless overridden by the
+ * {@link BeanContext#BEAN_beanTypePropertyName} setting.
*/
String typePropertyName() default "";
/**
* The set and order of names of properties associated with a bean class.
* <p>
- * The order specified is the same order that the entries will be returned by the {@link BeanMap#entrySet()} and related methods.
+ * The order specified is the same order that the entries will be returned by the {@link BeanMap#entrySet()} and
+ * related methods.
* <p>
- * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getProperties()} method.
+ * This annotation is an alternative to using the {@link BeanFilter} class with an implemented
+ * {@link BeanFilter#getProperties()} method.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -152,7 +155,7 @@ public @interface Bean {
* Otherwise, the natural order of the bean properties is used which is dependent on the
* JVM vendor.
* On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.
- * On Oracle JVMs, the bean properties are not ordered (which follows the offical JVM specs).
+ * On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).
* <p>
* This property is disabled by default so that IBM JVM users don't have to use {@link Bean @Bean} annotations
* to force bean properties to be in a particular order and can just alter the order of the fields/methods
@@ -166,7 +169,8 @@ public @interface Bean {
/**
* Specifies a list of properties that should be excluded from {@link BeanMap#entrySet()}.
* <p>
- * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getExcludeProperties()} method.
+ * This annotation is an alternative to using the {@link BeanFilter} class with an implemented
+ * {@link BeanFilter#getExcludeProperties()} method.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -183,10 +187,11 @@ public @interface Bean {
* Associates a {@link PropertyNamer} with this bean to tailor the names of the bean properties.
* <p>
* Property namers are used to transform bean property names from standard form to some other form.
- * For example, the {@link PropertyNamerDLC} will convert property names to dashed-lowercase, and
- * these will be used as attribute names in JSON, and element names in XML.
+ * For example, the {@link PropertyNamerDLC} will convert property names to dashed-lowercase, and these will be used
+ * as attribute names in JSON, and element names in XML.
* <p>
- * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getPropertyNamer()} method.
+ * This annotation is an alternative to using the {@link BeanFilter} class with an implemented
+ * {@link BeanFilter#getPropertyNamer()} method.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -225,7 +230,8 @@ public @interface Bean {
* Note that this annotation can be used on the parent class so that it filters to all child classes,
* or can be set individually on the child classes.
* <p>
- * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getInterfaceClass()} method.
+ * This annotation is an alternative to using the {@link BeanFilter} class with an implemented
+ * {@link BeanFilter#getInterfaceClass()} method.
*/
Class<?> interfaceClass() default Object.class;
@@ -233,10 +239,10 @@ public @interface Bean {
* Identifies a stop class for the annotated class.
* <p>
* Identical in purpose to the stop class specified by {@link Introspector#getBeanInfo(Class, Class)}.
- * Any properties in the stop class or in its baseclasses will be ignored during analysis.
+ * Any properties in the stop class or in its base classes will be ignored during analysis.
* <p>
- * For example, in the following class hierarchy, instances of <code>C3</code> will include property <code>p3</code>, but
- * not <code>p1</code> or <code>p2</code>.
+ * For example, in the following class hierarchy, instances of <code>C3</code> will include property <code>p3</code>,
+ * but not <code>p1</code> or <code>p2</code>.
* <p class='bcode'>
* <jk>public class</jk> C1 {
* <jk>public int</jk> getP1();
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
index 68a4c63..c7b6af8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
@@ -22,10 +22,11 @@ import org.apache.juneau.*;
/**
* Maps constructor arguments to property names on beans with read-only properties.
* <p>
- * This annotation can be used in the case of beans with properties whose values can only be set by passing
- * them in through a constructor on the class.<br>
- * Since method parameter names are lost during compilation, this annotation essentially redefines them
- * so that they are available at runtime.
+ * This annotation can be used in the case of beans with properties whose values can only be set by passing them in
+ * through a constructor on the class.
+ * <br>
+ * Since method parameter names are lost during compilation, this annotation essentially redefines them so that they
+ * are available at runtime.
* <p>
* The definition of a read-only bean is a bean with properties with only getters, like shown below...
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
index 5f8dc70..c7c1d30 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
@@ -21,8 +21,8 @@ import java.lang.annotation.*;
* Ignore classes, fields, and methods from being interpreted as bean or bean components.
* <p>
* Applied to classes that may look like beans, but you want to be treated as non-beans.
- * For example, if you want to force a bean to be converted to a string using the <code>toString()</code>
- * method, use this annoation on the class.
+ * For example, if you want to force a bean to be converted to a string using the <code>toString()</code> method, use
+ * this annotation on the class.
* <p>
* Applies to fields that should not be interpreted as bean property fields.
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
index fbd8f3d..c106d66 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
@@ -31,8 +31,10 @@ import org.apache.juneau.transform.*;
* <li>Identify a specific subclass for a property with a general class type.
* <li>Identify class types of elements in properties of type <code>Collection</code> or <code>Map</code>.
* <li>Hide properties during serialization.
- * <li>Associate transforms with bean property values, such as a POJO swap to convert a <code>Calendar</code> field to a string.
- * <li>Override the list of properties during serialization on child elements of a property of type <code>Collection</code> or <code>Map</code>.
+ * <li>Associate transforms with bean property values, such as a POJO swap to convert a <code>Calendar</code> field
+ * to a string.
+ * <li>Override the list of properties during serialization on child elements of a property of type
+ * <code>Collection</code> or <code>Map</code>.
* <li>Identify a property as the URL for a bean.
* <li>Identify a property as the ID for a bean.
* </ul>
@@ -49,16 +51,19 @@ public @interface BeanProperty {
* Identifies the name of the property.
* <p>
* Normally, this is automatically inferred from the field name or getter method name
- * of the property. However, this property can be used to assign a different
- * property name from the automatically inferred value.
+ * of the property. However, this property can be used to assign a different
+ * property name from the automatically inferred value.
* <p>
- * If the {@link BeanContext#BEAN_beanFieldVisibility} setting on the bean context excludes this field (e.g. the visibility
- * is set to PUBLIC, but the field is PROTECTED), this annotation can be used to force the field to be identified as a property.
+ * If the {@link BeanContext#BEAN_beanFieldVisibility} setting on the bean context excludes this field (e.g. the
+ * visibility is set to PUBLIC, but the field is PROTECTED), this annotation can be used to force the field to be
+ * identified as a property.
* <p>
* <h6 class='topic'>Dynamic beans</h6>
- * The bean property named <js>"*"</js> is the designated "dynamic property" which allows for "extra" bean properties not otherwise defined.
+ * The bean property named <js>"*"</js> is the designated "dynamic property" which allows for "extra" bean
+ * properties not otherwise defined.
* This is similar in concept to the Jackson <ja>@JsonGetterAll</ja> and <ja>@JsonSetterAll</ja> annotations.
- * The primary purpose is for backwards compatibility in parsing newer streams with addition information into older beans.
+ * The primary purpose is for backwards compatibility in parsing newer streams with addition information into older
+ * beans.
* <p>
* The following examples show how to define dynamic bean properties.
* <p class='bcode'>
@@ -98,8 +103,8 @@ public @interface BeanProperty {
* }
* </p>
* <p>
- * Similar rules apply for value types and swaps. The property values optionally can be any serializable type
- * or use swaps.
+ * Similar rules apply for value types and swaps. The property values optionally can be any serializable type or
+ * use swaps.
* <p class='bcode'>
* <jc>// A serializable type other than Object.</jc>
* <jk>public class</jk> BeanWithDynaFieldWithListValues {
@@ -122,8 +127,9 @@ public @interface BeanProperty {
* <p>
* <ul class='doctree'>
* <li class='info'>
- * Note that if you're not interested in these additional properties, you can also use the {@link BeanContext#BEAN_ignoreUnknownBeanProperties} setting
- * to ignore values that don't fit into existing properties.
+ * Note that if you're not interested in these additional properties, you can also use the
+ * {@link BeanContext#BEAN_ignoreUnknownBeanProperties} setting to ignore values that don't fit into existing
+ * properties.
* </ul>
*/
String name() default "";
@@ -145,9 +151,9 @@ public @interface BeanProperty {
* Identifies a specialized class type for the property.
* <p>
* Normally this can be inferred through reflection of the field type or getter return type.
- * However, you'll want to specify this value if you're parsing beans where the bean property class
- * is an interface or abstract class to identify the bean type to instantiate. Otherwise, you may
- * cause an {@link InstantiationException} when trying to set these fields.
+ * However, you'll want to specify this value if you're parsing beans where the bean property class is an interface
+ * or abstract class to identify the bean type to instantiate.
+ * Otherwise, you may cause an {@link InstantiationException} when trying to set these fields.
* <p>
* This property must denote a concrete bean class with a no-arg constructor.
*
@@ -164,9 +170,8 @@ public @interface BeanProperty {
Class<?> type() default Object.class;
/**
- * For bean properties of maps and collections, this annotation can be used to identify
- * the class types of the contents of the bean property object when the generic parameter
- * types are interfaces or abstract classes.
+ * For bean properties of maps and collections, this annotation can be used to identify the class types of the
+ * contents of the bean property object when the generic parameter types are interfaces or abstract classes.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -182,13 +187,11 @@ public @interface BeanProperty {
/**
* Associates a {@link PojoSwap} or {@link SurrogateSwap} with this bean property that will swap the value object
- * with another object during serialization and parsing.
+ * with another object during serialization and parsing.
* <p>
- * This annotation supersedes any swaps associated with the bean property type
- * class itself.
+ * This annotation supersedes any swaps associated with the bean property type class itself.
* <p>
- * Typically used for rendering {@link Date Dates} and {@link Calendar Calendars}
- * as a particular string format.
+ * Typically used for rendering {@link Date Dates} and {@link Calendar Calendars} as a particular string format.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -236,7 +239,8 @@ public @interface BeanProperty {
/**
* The list of classes that make up the bean dictionary for this bean property.
* <p>
- * The dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred through reflection.
+ * The dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred
+ * through reflection.
* The names are defined through the {@link Bean#typeName()} annotation defined on the bean class.
* <p>
* This list can consist of the following class types:
@@ -255,8 +259,8 @@ public @interface BeanProperty {
* <p>
* Note that this is usually a one-way conversion during serialization.
* <p>
- * During parsing, we will attempt to convert the value to the original form by using the {@link BeanSession#convertToType(Object, Class)}
- * but there is no guarantee that this will succeed.
+ * During parsing, we will attempt to convert the value to the original form by using the
+ * {@link BeanSession#convertToType(Object, Class)} but there is no guarantee that this will succeed.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
[08/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 2db986e..3c71cf9 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,7 +26,8 @@ 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='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>
*/
@@ -78,13 +79,15 @@ public class RemoteableMethodMeta {
httpMethod = rm == null ? "POST" : rm.httpMethod();
if (! isOneOf(httpMethod, "DELETE", "GET", "POST", "PUT"))
- throw new RemoteableMetadataException(m, "Invalid value specified for @RemoteMethod.httpMethod() annotation. Valid values are [DELTE,GET,POST,PUT].");
+ throw new RemoteableMetadataException(m,
+ "Invalid value specified for @RemoteMethod.httpMethod() annotation. Valid values are [DELTE,GET,POST,PUT].");
String path = rm == null || rm.path().isEmpty() ? null : rm.path();
String methodPaths = r == null ? "NAME" : r.methodPaths();
if (! isOneOf(methodPaths, "NAME", "SIGNATURE"))
- throw new RemoteableMetadataException(m, "Invalid value specified for @Remoteable.methodPaths() annotation. Valid values are [NAME,SIGNATURE].");
+ throw new RemoteableMetadataException(m,
+ "Invalid value specified for @Remoteable.methodPaths() annotation. Valid values are [NAME,SIGNATURE].");
returnValue = rm == null ? ReturnValue.BODY : rm.returns();
@@ -127,7 +130,8 @@ public class RemoteableMethodMeta {
if (bodyArg == null)
bodyArg = index;
else
- throw new RemoteableMetadataException(m, "Multiple @Body parameters found. Only one can be specified per Java method.");
+ throw new RemoteableMetadataException(m,
+ "Multiple @Body parameters found. Only one can be specified per Java method.");
}
}
if (! annotated)
@@ -136,12 +140,14 @@ public class RemoteableMethodMeta {
}
if (bodyArg != null && otherArgs.size() > 0)
- throw new RemoteableMetadataException(m, "@Body and non-annotated parameters found together. Non-annotated parameters cannot be used when @Body is used.");
+ throw new RemoteableMetadataException(m,
+ "@Body and non-annotated parameters found together. Non-annotated parameters cannot be used when @Body is used.");
}
}
/**
* Returns the value of the {@link RemoteMethod#httpMethod()} annotation on this Java method.
+ *
* @return The value of the {@link RemoteMethod#httpMethod()} annotation, never <jk>null</jk>.
*/
public String getHttpMethod() {
@@ -150,6 +156,7 @@ public class RemoteableMethodMeta {
/**
* Returns the absolute URL of the REST interface invoked by this Java method.
+ *
* @return The absolute URL of the REST interface, never <jk>null</jk>.
*/
public String getUrl() {
@@ -158,6 +165,7 @@ public class RemoteableMethodMeta {
/**
* Returns the {@link Path @Path} annotated arguments on this Java method.
+ *
* @return A map of {@link Path#value() @Path.value()} names to zero-indexed argument indices.
*/
public RemoteMethodArg[] getPathArgs() {
@@ -166,6 +174,7 @@ public class RemoteableMethodMeta {
/**
* Returns the {@link Query @Query} annotated arguments on this Java method.
+ *
* @return A map of {@link Query#value() @Query.value()} names to zero-indexed argument indices.
*/
public RemoteMethodArg[] getQueryArgs() {
@@ -174,6 +183,7 @@ public class RemoteableMethodMeta {
/**
* Returns the {@link FormData @FormData} annotated arguments on this Java method.
+ *
* @return A map of {@link FormData#value() @FormData.value()} names to zero-indexed argument indices.
*/
public RemoteMethodArg[] getFormDataArgs() {
@@ -182,6 +192,7 @@ public class RemoteableMethodMeta {
/**
* Returns the {@link Header @Header} annotated arguments on this Java method.
+ *
* @return A map of {@link Header#value() @Header.value()} names to zero-indexed argument indices.
*/
public RemoteMethodArg[] getHeaderArgs() {
@@ -190,6 +201,7 @@ public class RemoteableMethodMeta {
/**
* Returns the {@link RequestBean @RequestBean} annotated arguments on this Java method.
+ *
* @return A list of zero-indexed argument indices.
*/
public RemoteMethodArg[] getRequestBeanArgs() {
@@ -198,6 +210,7 @@ public class RemoteableMethodMeta {
/**
* Returns the remaining non-annotated arguments on this Java method.
+ *
* @return A list of zero-indexed argument indices.
*/
public Integer[] getOtherArgs() {
@@ -206,6 +219,7 @@ public class RemoteableMethodMeta {
/**
* Returns the argument annotated with {@link Body @Body}.
+ *
* @return A index of the argument with the {@link Body @Body} annotation, or <jk>null</jk> if no argument exists.
*/
public Integer getBodyArg() {
@@ -214,6 +228,7 @@ public class RemoteableMethodMeta {
/**
* Returns whether the method returns the HTTP response body or status code.
+ *
* @return Whether the method returns the HTTP response body or status code.
*/
public ReturnValue getReturns() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 76b4c4a..5c46a90 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
@@ -83,7 +83,8 @@ 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='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>
*/
@@ -97,7 +98,7 @@ public @interface RequestBean {
* Specifies the {@link PartSerializer} class used for serializing values to strings.
* <p>
* The default value defaults to the using the part serializer defined on the client which by default is
- * {@link UrlEncodingSerializer}.
+ * {@link UrlEncodingSerializer}.
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/serializer/OutputStreamSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/OutputStreamSerializer.java b/juneau-core/src/main/java/org/apache/juneau/serializer/OutputStreamSerializer.java
index d751fdc..c181a02 100644
--- a/juneau-core/src/main/java/org/apache/juneau/serializer/OutputStreamSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/serializer/OutputStreamSerializer.java
@@ -35,19 +35,20 @@ import org.apache.juneau.annotation.*;
* The media types that this serializer can produce is specified through the {@link Produces @Produces} annotation.
* <p>
* However, the media types can also be specified programmatically by overriding the {@link #getMediaTypes()}
- * and {@link #getResponseContentType()} methods.
+ * and {@link #getResponseContentType()} methods.
*/
public abstract class OutputStreamSerializer extends Serializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
protected OutputStreamSerializer(PropertyStore propertyStore) {
super(propertyStore);
}
- @Override /* Serializer */
+ @Override /* Serializer */
public boolean isWriterSerializer() {
return false;
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/serializer/Serializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/Serializer.java b/juneau-core/src/main/java/org/apache/juneau/serializer/Serializer.java
index 655ec0c..70bbd4f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/serializer/Serializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/serializer/Serializer.java
@@ -38,7 +38,7 @@ import org.apache.juneau.soap.*;
* The media types that this serializer can produce is specified through the {@link Produces @Produces} annotation.
* <p>
* However, the media types can also be specified programmatically by overriding the {@link #getMediaTypes()}
- * and {@link #getResponseContentType()} methods.
+ * and {@link #getResponseContentType()} methods.
*/
public abstract class Serializer extends CoreObject {
@@ -85,10 +85,10 @@ public abstract class Serializer extends CoreObject {
* Serializes a POJO to the specified output stream or writer.
* <p>
* This method should NOT close the context object.
- * @param session The serializer session object return by {@link #createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType, UriContext)}.<br>
+ * @param session The serializer session object return by {@link #createSession(Object, ObjectMap, Method, Locale,
+ * TimeZone, MediaType, UriContext)}.
* If <jk>null</jk>, session is created using {@link #createSession(Object)}.
* @param o The object to serialize.
- *
* @throws Exception If thrown from underlying stream, or if the input contains a syntax error or is malformed.
*/
protected abstract void doSerialize(SerializerSession session, Object o) throws Exception;
@@ -100,8 +100,8 @@ public abstract class Serializer extends CoreObject {
*
* @param o The object to serialize.
* @return The serialized object.
- * <br>Character-based serializers will return a <code>String</code>
- * <br>Stream-based serializers will return a <code><jk>byte</jk>[]</code>
+ * <br>Character-based serializers will return a <code>String</code>
+ * <br>Stream-based serializers will return a <code><jk>byte</jk>[]</code>
* @throws SerializeException If a problem occurred trying to convert the output.
*/
public abstract Object serialize(Object o) throws SerializeException;
@@ -113,7 +113,8 @@ public abstract class Serializer extends CoreObject {
/**
* Serialize the specified object using the specified session.
*
- * @param session The serializer session object return by {@link #createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType, UriContext)}.<br>
+ * @param session The serializer session object return by {@link #createSession(Object, ObjectMap, Method, Locale,
+ * TimeZone, MediaType, UriContext)}.
* If <jk>null</jk>, session is created using {@link #createSession(Object)}.
* @param o The object to serialize.
* @throws SerializeException If a problem occurred trying to convert the output.
@@ -124,7 +125,8 @@ public abstract class Serializer extends CoreObject {
} catch (SerializeException e) {
throw e;
} catch (StackOverflowError e) {
- throw new SerializeException(session, "Stack overflow occurred. This can occur when trying to serialize models containing loops. It's recommended you use the SerializerContext.SERIALIZER_detectRecursions setting to help locate the loop.").initCause(e);
+ throw new SerializeException(session,
+ "Stack overflow occurred. This can occur when trying to serialize models containing loops. It's recommended you use the SerializerContext.SERIALIZER_detectRecursions setting to help locate the loop.").initCause(e);
} catch (Exception e) {
throw new SerializeException(session, e);
} finally {
@@ -139,17 +141,17 @@ public abstract class Serializer extends CoreObject {
*
* @param o The object to serialize.
* @param output The output object.
- * <br>Character-based serializers can handle the following output class types:
- * <ul>
- * <li>{@link Writer}
- * <li>{@link OutputStream} - Output will be written as UTF-8 encoded stream.
- * <li>{@link File} - Output will be written as system-default encoded stream.
- * </ul>
- * <br>Stream-based serializers can handle the following output class types:
- * <ul>
- * <li>{@link OutputStream}
- * <li>{@link File}
- * </ul>
+ * <br>Character-based serializers can handle the following output class types:
+ * <ul>
+ * <li>{@link Writer}
+ * <li>{@link OutputStream} - Output will be written as UTF-8 encoded stream.
+ * <li>{@link File} - Output will be written as system-default encoded stream.
+ * </ul>
+ * <br>Stream-based serializers can handle the following output class types:
+ * <ul>
+ * <li>{@link OutputStream}
+ * <li>{@link File}
+ * </ul>
* @throws SerializeException If a problem occurred trying to convert the output.
*/
public final void serialize(Object o, Object output) throws SerializeException {
@@ -160,21 +162,21 @@ public abstract class Serializer extends CoreObject {
/**
* Create the session object that will be passed in to the serialize method.
* <p>
- * It's up to implementers to decide what the session object looks like, although typically
- * it's going to be a subclass of {@link SerializerSession}.
+ * It's up to implementers to decide what the session object looks like, although typically it's going to be a
+ * subclass of {@link SerializerSession}.
*
* @param output The output object.
- * <br>Character-based serializers can handle the following output class types:
- * <ul>
- * <li>{@link Writer}
- * <li>{@link OutputStream} - Output will be written as UTF-8 encoded stream.
- * <li>{@link File} - Output will be written as system-default encoded stream.
- * </ul>
- * <br>Stream-based serializers can handle the following output class types:
- * <ul>
- * <li>{@link OutputStream}
- * <li>{@link File}
- * </ul>
+ * <br>Character-based serializers can handle the following output class types:
+ * <ul>
+ * <li>{@link Writer}
+ * <li>{@link OutputStream} - Output will be written as UTF-8 encoded stream.
+ * <li>{@link File} - Output will be written as system-default encoded stream.
+ * </ul>
+ * <br>Stream-based serializers can handle the following output class types:
+ * <ul>
+ * <li>{@link OutputStream}
+ * <li>{@link File}
+ * </ul>
* @param op Optional additional properties.
* @param javaMethod Java method that invoked this serializer.
* When using the REST API, this is the Java method invoked by the REST call.
@@ -188,7 +190,8 @@ public abstract class Serializer extends CoreObject {
* Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
* @return The new session.
*/
- public SerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ public SerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale,
+ TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
return new SerializerSession(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
}
@@ -198,17 +201,17 @@ public abstract class Serializer extends CoreObject {
* Equivalent to calling <code>createSession(<jk>null</jk>, <jk>null</jk>)</code>.
*
* @param output The output object.
- * <br>Character-based serializers can handle the following output class types:
- * <ul>
- * <li>{@link Writer}
- * <li>{@link OutputStream} - Output will be written as UTF-8 encoded stream.
- * <li>{@link File} - Output will be written as system-default encoded stream.
- * </ul>
- * <br>Stream-based serializers can handle the following output class types:
- * <ul>
- * <li>{@link OutputStream}
- * <li>{@link File}
- * </ul>
+ * <br>Character-based serializers can handle the following output class types:
+ * <ul>
+ * <li>{@link Writer}
+ * <li>{@link OutputStream} - Output will be written as UTF-8 encoded stream.
+ * <li>{@link File} - Output will be written as system-default encoded stream.
+ * </ul>
+ * <br>Stream-based serializers can handle the following output class types:
+ * <ul>
+ * <li>{@link OutputStream}
+ * <li>{@link File}
+ * </ul>
* @return The new session.
*/
protected SerializerSession createSession(Object output) {
@@ -220,9 +223,9 @@ public abstract class Serializer extends CoreObject {
* <p>
* Works on both object and primitive arrays.
* <p>
- * In the case of multi-dimensional arrays, the outgoing list will
- * contain elements of type n-1 dimension. i.e. if {@code type} is <code><jk>int</jk>[][]</code>
- * then {@code list} will have entries of type <code><jk>int</jk>[]</code>.
+ * In the case of multi-dimensional arrays, the outgoing list will contain elements of type n-1 dimension.
+ * i.e. if {@code type} is <code><jk>int</jk>[][]</code> then {@code list} will have entries of type
+ * <code><jk>int</jk>[]</code>.
*
* @param type The type of array.
* @param array The array being converted.
@@ -243,7 +246,7 @@ public abstract class Serializer extends CoreObject {
/**
* Returns the media types handled based on the value of the {@link Produces} annotation on the serializer class.
* <p>
- * This method can be overridden by subclasses to determine the media types programatically.
+ * This method can be overridden by subclasses to determine the media types programmatically.
*
* @return The list of media types. Never <jk>null</jk>.
*/
@@ -265,9 +268,11 @@ public abstract class Serializer extends CoreObject {
* <p>
* For example, {@link SoapXmlSerializer} needs to set a <code>SOAPAction</code> header.
* <p>
- * This method is typically meaningless if the serializer is being used standalone (i.e. outside of a REST server or client).
+ * This method is typically meaningless if the serializer is being used stand-alone (i.e. outside of a REST server
+ * or client).
*
- * @param properties Optional run-time properties (the same that are passed to {@link WriterSerializer#doSerialize(SerializerSession, Object)}.
+ * @param properties Optional run-time properties (the same that are passed to
+ * {@link WriterSerializer#doSerialize(SerializerSession, Object)}.
* Can be <jk>null</jk>.
* @return The HTTP headers to set on HTTP requests.
* Can be <jk>null</jk>.
@@ -277,14 +282,16 @@ public abstract class Serializer extends CoreObject {
}
/**
- * Optional method that returns the response <code>Content-Type</code> for this serializer if it is different from the matched media type.
+ * Optional method that returns the response <code>Content-Type</code> for this serializer if it is different from
+ * the matched media type.
* <p>
* This method is specified to override the content type for this serializer.
- * For example, the {@link org.apache.juneau.json.JsonSerializer.Simple} class returns that it handles media type <js>"text/json+simple"</js>, but returns
- * <js>"text/json"</js> as the actual content type.
+ * For example, the {@link org.apache.juneau.json.JsonSerializer.Simple} class returns that it handles media type
+ * <js>"text/json+simple"</js>, but returns <js>"text/json"</js> as the actual content type.
* This allows clients to request specific 'flavors' of content using specialized <code>Accept</code> header values.
* <p>
- * This method is typically meaningless if the serializer is being used standalone (i.e. outside of a REST server or client).
+ * This method is typically meaningless if the serializer is being used stand-alone (i.e. outside of a REST server
+ * or client).
*
* @return The response content type. If <jk>null</jk>, then the matched media type is used.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 3a7ec4f..489a01c 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
@@ -34,6 +34,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public SerializerBuilder(PropertyStore propertyStore) {
@@ -117,11 +118,12 @@ public class SerializerBuilder extends CoreObjectBuilder {
* <p>
* Recursions can occur when serializing models that aren't true trees, but rather contain loops.
* <p>
- * The behavior when recursions are detected depends on the value for {@link SerializerContext#SERIALIZER_ignoreRecursions}.
+ * The behavior when recursions are detected depends on the value for
+ * {@link SerializerContext#SERIALIZER_ignoreRecursions}.
* <p>
* 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><br>
+ * the following when <jsf>SERIALIZER_ignoreRecursions</jsf> is <jk>true</jk>...
+ * <code>{A:{B:{C:null}}}</code>
* <p>
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -237,9 +239,11 @@ public class SerializerBuilder extends CoreObjectBuilder {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred through reflection.
+ * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
+ * through reflection.
* 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.
+ * 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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 da53f8f..f316fac 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
@@ -69,7 +69,7 @@ public class SerializerContext extends BeanContext {
* <p>
* 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><br>
+ * <code>{A:{B:{C:null}}}</code>
* <p>
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -139,9 +139,11 @@ public class SerializerContext extends BeanContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred through reflection.
+ * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
+ * through reflection.
* 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.
+ * For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined from
+ * the value type.
*/
public static final String SERIALIZER_addBeanTypeProperties = "Serializer.addBeanTypeProperties";
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 5a4db6e..0c1cf0e 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
@@ -76,8 +76,8 @@ public final class SerializerGroup {
* @param propertyStore The modifiable properties that were used to initialize the serializers.
* A snapshot of these will be made so that we can clone and modify this group.
* @param serializers The serializers defined in this group.
- * The order is important because they will be tried in reverse order (e.g.
- * newer first) in which they will be tried to match against media types.
+ * The order is important because they will be tried in reverse order (e.g.newer first) in which they will be tried
+ * to match against media types.
*/
public SerializerGroup(PropertyStore propertyStore, Serializer[] serializers) {
this.propertyStore = PropertyStore.create(propertyStore);
@@ -114,8 +114,9 @@ public final class SerializerGroup {
* accept-extension = ";" token [ "=" ( token | quoted-string ) ]
* </p>
* <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.
+ * 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...
* <p class='bcode'>
* String acceptHeaderValue = request.getHeader(<js>"Accept"</js>);
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroupBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroupBuilder.java b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroupBuilder.java
index a29449b..9636597 100644
--- a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroupBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroupBuilder.java
@@ -52,6 +52,7 @@ public class SerializerGroupBuilder {
/**
* Clone an existing serializer group builder.
+ *
* @param copyFrom The serializer group that we're copying settings and serializers from.
*/
public SerializerGroupBuilder(SerializerGroup copyFrom) {
@@ -1114,8 +1115,8 @@ public class SerializerGroupBuilder {
/**
* Specifies the classloader to use when resolving classes from strings for all serializers in this group.
* <p>
- * Can be used for resolving class names when the classes being created are in a different
- * classloader from the Juneau code.
+ * Can be used for resolving class names when the classes being created are in a different classloader from the
+ * Juneau code.
* <p>
* If <jk>null</jk>, the system classloader will be used to resolve classes.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerListener.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerListener.java b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerListener.java
index 50b967c..caa0bbb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerListener.java
+++ b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerListener.java
@@ -25,12 +25,12 @@ public class SerializerListener {
* Called when an exception is thrown when trying to call a bean getter method.
*
* @param session The serializer session.
- * Note that if
* @param t The throwable that was thrown by the getter method.
* @param p The bean property we had an issue on.
*/
public void onBeanGetterException(SerializerSession session, Throwable t, BeanPropertyMeta p) {
- onError(session, t, format("Could not call getValue() on property ''{0}'' of class ''{1}'', exception = {2}", p.getName(), p.getBeanMeta().getClassMeta(), t.getLocalizedMessage()));
+ onError(session, t, format("Could not call getValue() on property ''{0}'' of class ''{1}'', exception = {2}",
+ p.getName(), p.getBeanMeta().getClassMeta(), t.getLocalizedMessage()));
}
/**
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 357ccd2..80aa351 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
@@ -76,31 +76,32 @@ public class SerializerSession extends BeanSession {
* Create a new session using properties specified in the context.
*
* @param ctx The context creating this session object.
- * The context contains all the configuration settings for this object.
+ * The context contains all the configuration settings for this object.
* @param output The output object.
- * <br>Character-based serializers can handle the following output class types:
- * <ul>
- * <li>{@link Writer}
- * <li>{@link OutputStream} - Output will be written as UTF-8 encoded stream.
- * <li>{@link File} - Output will be written as system-default encoded stream.
- * </ul>
- * <br>Stream-based serializers can handle the following output class types:
- * <ul>
- * <li>{@link OutputStream}
- * <li>{@link File}
- * </ul>
+ * <br>Character-based serializers can handle the following output class types:
+ * <ul>
+ * <li>{@link Writer}
+ * <li>{@link OutputStream} - Output will be written as UTF-8 encoded stream.
+ * <li>{@link File} - Output will be written as system-default encoded stream.
+ * </ul>
+ * <br>Stream-based serializers can handle the following output class types:
+ * <ul>
+ * <li>{@link OutputStream}
+ * <li>{@link File}
+ * </ul>
* @param op The override properties.
- * These override any context properties defined in the context.
+ * These override any context properties defined in the context.
* @param javaMethod The java method that called this serializer, usually the method in a REST servlet.
* @param locale The session locale.
- * If <jk>null</jk>, then the locale defined on the context is used.
+ * If <jk>null</jk>, then the locale defined on the context is used.
* @param timeZone The session timezone.
- * If <jk>null</jk>, then the timezone defined on the context is used.
+ * If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
* @param uriContext The URI context.
- * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
+ * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
*/
- public SerializerSession(SerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ public SerializerSession(SerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale,
+ TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
super(ctx, op, locale, timeZone, mediaType);
this.javaMethod = javaMethod;
this.output = output;
@@ -229,6 +230,7 @@ public class SerializerSession extends BeanSession {
/**
* Sets the current bean property being serialized for proper error messages.
+ *
* @param currentProperty The current property being serialized.
*/
public void setCurrentProperty(BeanPropertyMeta currentProperty) {
@@ -237,6 +239,7 @@ public class SerializerSession extends BeanSession {
/**
* Sets the current class being serialized for proper error messages.
+ *
* @param currentClass The current class being serialized.
*/
public void setCurrentClass(ClassMeta<?> currentClass) {
@@ -396,8 +399,8 @@ public class SerializerSession extends BeanSession {
* @param attrName The attribute name.
* @param o The current object being serialized.
* @param eType The expected class type.
- * @return The {@link ClassMeta} of the object so that <code>instanceof</code> operations
- * only need to be performed once (since they can be expensive).<br>
+ * @return The {@link ClassMeta} of the object so that <code>instanceof</code> operations only need to be performed
+ * once (since they can be expensive).
* @throws SerializeException If recursion occurred.
*/
public ClassMeta<?> push(String attrName, Object o, ClassMeta<?> eType) throws SerializeException {
@@ -425,7 +428,7 @@ public class SerializerSession extends BeanSession {
/**
* Returns <jk>true</jk> if {@link SerializerContext#SERIALIZER_detectRecursions} is enabled, and the specified
- * object is already higher up in the serialization chain.
+ * object is already higher up in the serialization chain.
*
* @param attrName The bean property attribute name, or some other identifier.
* @param o The object to check for recursion.
@@ -454,7 +457,8 @@ public class SerializerSession extends BeanSession {
Object o = stack.removeLast().o;
Object o2 = set.remove(o);
if (o2 == null)
- onError(null, "Couldn't remove object of type ''{0}'' on attribute ''{1}'' from object stack.", o.getClass().getName(), stack);
+ onError(null, "Couldn't remove object of type ''{0}'' on attribute ''{1}'' from object stack.",
+ o.getClass().getName(), stack);
}
isBottom = false;
}
@@ -478,7 +482,8 @@ public class SerializerSession extends BeanSession {
if (listener != null)
listener.onBeanGetterException(this, t, p);
String prefix = (isDebug() ? getStack(false) + ": " : "");
- addWarning("{0}Could not call getValue() on property ''{1}'' of class ''{2}'', exception = {3}", prefix, p.getName(), p.getBeanMeta().getClassMeta(), t.getLocalizedMessage());
+ addWarning("{0}Could not call getValue() on property ''{1}'' of class ''{2}'', exception = {3}", prefix,
+ p.getName(), p.getBeanMeta().getClassMeta(), t.getLocalizedMessage());
}
/**
@@ -599,26 +604,26 @@ public class SerializerSession extends BeanSession {
* Converts a String to an absolute URI based on the {@link UriContext} on this session.
*
* @param uri The input URI.
- * Can be any of the following:
- * <ul>
- * <li>{@link java.net.URI}
- * <li>{@link java.net.URL}
- * <li>{@link CharSequence}
- * </ul>
- * URI can be any of the following forms:
- * <ul>
- * <li><js>"foo://foo"</js> - Absolute URI.
- * <li><js>"/foo"</js> - Root-relative URI.
- * <li><js>"/"</js> - Root URI.
- * <li><js>"context:/foo"</js> - Context-root-relative URI.
- * <li><js>"context:/"</js> - Context-root URI.
- * <li><js>"servlet:/foo"</js> - Servlet-path-relative URI.
- * <li><js>"servlet:/"</js> - Servlet-path URI.
- * <li><js>"request:/foo"</js> - Request-path-relative URI.
- * <li><js>"request:/"</js> - Request-path URI.
- * <li><js>"foo"</js> - Path-info-relative URI.
- * <li><js>""</js> - Path-info URI.
- * </ul>
+ * Can be any of the following:
+ * <ul>
+ * <li>{@link java.net.URI}
+ * <li>{@link java.net.URL}
+ * <li>{@link CharSequence}
+ * </ul>
+ * URI can be any of the following forms:
+ * <ul>
+ * <li><js>"foo://foo"</js> - Absolute URI.
+ * <li><js>"/foo"</js> - Root-relative URI.
+ * <li><js>"/"</js> - Root URI.
+ * <li><js>"context:/foo"</js> - Context-root-relative URI.
+ * <li><js>"context:/"</js> - Context-root URI.
+ * <li><js>"servlet:/foo"</js> - Servlet-path-relative URI.
+ * <li><js>"servlet:/"</js> - Servlet-path URI.
+ * <li><js>"request:/foo"</js> - Request-path-relative URI.
+ * <li><js>"request:/"</js> - Request-path URI.
+ * <li><js>"foo"</js> - Path-info-relative URI.
+ * <li><js>""</js> - Path-info URI.
+ * </ul>
* @return The resolved URI.
*/
public String resolveUri(Object uri) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerWriter.java b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerWriter.java
index 7f7784b..628fc11 100644
--- a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerWriter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerWriter.java
@@ -20,8 +20,8 @@ import org.apache.juneau.*;
/**
* Simple wrapper around a standard {@link Writer} with additional methods.
* <p>
- * Modeled after the Java ProcessBuilder class so that you can chain commands to reduce
- * the need for string concatenation for performance reasons.
+ * Modeled after the Java ProcessBuilder class so that you can chain commands to reduce the need for string
+ * concatenation for performance reasons.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -57,7 +57,8 @@ public class SerializerWriter extends Writer {
* @param quoteChar The character to write when {@link #q()} is called.
* @param uriResolver The URI resolver for resolving URIs to absolute or root-relative form.
*/
- public SerializerWriter(Writer out, boolean useWhitespace, int maxIndent, boolean trimStrings, char quoteChar, UriResolver uriResolver) {
+ public SerializerWriter(Writer out, boolean useWhitespace, int maxIndent, boolean trimStrings, char quoteChar,
+ UriResolver uriResolver) {
this.out = out;
this.useWhitespace = useWhitespace;
this.maxIndent = maxIndent;
@@ -97,8 +98,8 @@ public class SerializerWriter extends Writer {
}
/**
- * Writes an indent (if the {@code useWhitespace} setting is enabled), followed by text,
- * followed by a newline (if the {@code useWhitespace} setting is enabled).
+ * Writes an indent (if the {@code useWhitespace} setting is enabled), followed by text, followed by a newline
+ * (if the {@code useWhitespace} setting is enabled).
*
* @param indent The number of tabs to indent.
* @param text The text to write.
@@ -145,8 +146,8 @@ public class SerializerWriter extends Writer {
}
/**
- * Writes an indent (if the {@code useWhitespace} setting is enabled), followed by text,
- * optionally followed by a newline (if the {@code useWhitespace} setting is enabled).
+ * Writes an indent (if the {@code useWhitespace} setting is enabled), followed by text, optionally followed by a
+ * newline (if the {@code useWhitespace} setting is enabled).
*
* @param indent The number of tabs to indent.
* @param newline If <jk>true</jk>, then a newline is written.
@@ -165,8 +166,8 @@ public class SerializerWriter extends Writer {
/**
* Appends the specified object as a URI.
* <p>
- * Object is converted to a <code>String</code> using <code>toString()</code>, so this will work on {@link URL} or {@link URI} objects,
- * or any other type that returns a URI via it's <code>toString()</code> method.
+ * Object is converted to a <code>String</code> using <code>toString()</code>, so this will work on {@link URL} or
+ * {@link URI} objects, or any other type that returns a URI via it's <code>toString()</code> method.
* <p>
* The URI is resolved based on the {@link SerializerContext#SERIALIZER_uriRelativity} and
* {@link SerializerContext#SERIALIZER_uriResolution} settings and the {@link UriContext} that's part of the
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 e379415..699eb74 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
@@ -38,12 +38,13 @@ import org.apache.juneau.utils.*;
* The media types that this serializer can produce is specified through the {@link Produces @Produces} annotation.
* <p>
* However, the media types can also be specified programmatically by overriding the {@link #getMediaTypes()}
- * and {@link #getResponseContentType()} methods.
+ * and {@link #getResponseContentType()} methods.
*/
public abstract class WriterSerializer extends Serializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
protected WriterSerializer(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 00e5568..fc85f8b 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
@@ -70,9 +70,11 @@
<h2 class='topic' onclick='toggle(this)'>1 - Serializer API</h2>
<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 {@link org.apache.juneau.serializer.WriterSerializer}
- or {@link org.apache.juneau.serializer.OutputStreamSerializer}.<br>
+ 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
+ {@link org.apache.juneau.serializer.WriterSerializer} or
+ {@link org.apache.juneau.serializer.OutputStreamSerializer}.
</p>
<!-- ======================================================================================================== -->
@@ -80,7 +82,8 @@
<h3 class='topic' onclick='toggle(this)'>1.1 - The SerializerGroup class</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.serializer.SerializerGroup} class represents a group of serializers registered with the media types they handle.
+ The {@link org.apache.juneau.serializer.SerializerGroup} class represents a group of serializers registered
+ with the media types they handle.
</p>
<h6 class='topic'>Features</h6>
@@ -105,19 +108,22 @@
<h2 class='topic' onclick='toggle(this)'>2 - Defining a new Serializer</h2>
<div class='topic'>
<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 {@link org.apache.juneau.annotation.Produces} annotation.
+ 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
+ {@link org.apache.juneau.annotation.Produces} annotation.
</p>
<p>
- The following example shows a simple serializer that converts images to output streams using standard JRE classes.
+ The following example shows a simple serializer that converts images to output streams using standard JRE
+ classes.
</p>
<p class='bcode'>
<ja>@Produces</ja>(<js>"image/png,image/jpeg"</js>)
<jk>public static class</jk> ImageSerializer <jk>extends</jk> OutputStreamSerializer {
<ja>@Override</ja>
- <jk>public void</jk> serialize(Object o, OutputStream out, SerializerSession session) <jk>throws</jk> IOException, SerializeException {
+ <jk>public void</jk> serialize(Object o, OutputStream out, SerializerSession session)
+ <jk>throws</jk> IOException, SerializeException {
RenderedImage image = (RenderedImage)o;
String mediaType = ctx.getMediaType();
ImageIO.<jsm>write</jsm>(image, mediaType.substring(mediaType.indexOf(<js>'/'</js>)+1), out);
@@ -125,9 +131,11 @@
}
</p>
<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 {@link org.apache.juneau.json.JsonSerializer} class.
+ 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
+ {@link org.apache.juneau.json.JsonSerializer} class.
</p>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializer.java b/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializer.java
index b8bfc8c..7ea762b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializer.java
@@ -45,6 +45,7 @@ public final class SoapXmlSerializer extends XmlSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public SoapXmlSerializer(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 0b6e50e..f4dfb85 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
@@ -35,6 +35,7 @@ public class SoapXmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public SoapXmlSerializerBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 e13e10b..6d33b92 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,9 +29,12 @@ 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> - Properties associated with handling beans on serializers and parsers.
+ * <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.
+ * <li class='jc'><a class="doclink"
+ * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
* </ul>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/svl/DefaultingVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/DefaultingVar.java b/juneau-core/src/main/java/org/apache/juneau/svl/DefaultingVar.java
index a1142c2..e8674ce 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/DefaultingVar.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/DefaultingVar.java
@@ -17,8 +17,8 @@ import static org.apache.juneau.internal.StringUtils.*;
/**
* Interface for the resolution of vars with a default value if the <code>resolve()</code> method returns <jk>null</jk>.
* <p>
- * For example, to resolve the system property <js>"myProperty"</js> but resolve to <js>"not found"</js> if the property doesn't exist:
- * <js>"$S{myProperty,not found}"</js>
+ * For example, to resolve the system property <js>"myProperty"</js> but resolve to <js>"not found"</js> if the
+ * property doesn't exist: <js>"$S{myProperty,not found}"</js>
* <p>
* Subclasses must implement the {@link #resolve(VarResolverSession, String)} method.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/svl/SimpleVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/SimpleVar.java b/juneau-core/src/main/java/org/apache/juneau/svl/SimpleVar.java
index e286a73..9091698 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/SimpleVar.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/SimpleVar.java
@@ -17,10 +17,9 @@ import java.io.*;
/**
* Abstract superclass of all Simple Var Language variables that resolve to simple returned string values.
* <p>
- * Note the difference between this class and {@link StreamedVar} that streams
- * values to writers.
- * Unlike the {@link StreamedVar} class, the returned value from this class can
- * contain nested variables that will be recursively resolved by {@link VarResolver}.
+ * Note the difference between this class and {@link StreamedVar} that streams values to writers.
+ * Unlike the {@link StreamedVar} class, the returned value from this class can contain nested variables that will be
+ * recursively resolved by {@link VarResolver}.
* <p>
* Subclasses must implement the {@link #resolve(VarResolverSession, String)} method.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/svl/StreamedVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/StreamedVar.java b/juneau-core/src/main/java/org/apache/juneau/svl/StreamedVar.java
index 22b5d50..4ab4540 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/StreamedVar.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/StreamedVar.java
@@ -17,8 +17,8 @@ package org.apache.juneau.svl;
* <p>
* Note the difference between this class and {@link SimpleVar} that returns simple string values.
* Unlike the {@link SimpleVar} class, the output from this class cannot contain nested variables.
- * However, this class can be more efficient for variables that produce large amounts of output
- * so that the creation of large in-memory strings is avoided.
+ * However, this class can be more efficient for variables that produce large amounts of output so that the creation
+ * of large in-memory strings is avoided.
* <p>
* Subclasses must implement the {@link #resolveTo(VarResolverSession, java.io.Writer, String)} method.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/svl/Var.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/Var.java b/juneau-core/src/main/java/org/apache/juneau/svl/Var.java
index 29dc5f2..a68ecaa 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/Var.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/Var.java
@@ -19,15 +19,16 @@ import java.io.*;
/**
* Abstract superclass of all Simple Var Language variables.
* <p>
- * Vars are used to convert simple variables of the form <js>"$varName{varKey}"</js> into
- * something else by the {@link VarResolver} class.
+ * Vars are used to convert simple variables of the form <js>"$varName{varKey}"</js> into something else by the
+ * {@link VarResolver} class.
* <p>
* Subclasses must implement one of the following two methods:
* <ul>
* <li>{@link #resolve(VarResolverSession,String)} - For simple vars.
* <li>{@link #resolveTo(VarResolverSession,Writer,String)} - For streamed vars.
* </ul>
- * Subclasses MUST implement a no-arg constructor so that class names can be passed to the {@link VarResolverBuilder#vars(Class...)} method.
+ * Subclasses MUST implement a no-arg constructor so that class names can be passed to the
+ * {@link VarResolverBuilder#vars(Class...)} method.
* They must also be thread safe!
* <p>
* Two direct abstract subclasses are provided to differentiated between simple and streamed vars:
@@ -47,8 +48,9 @@ public abstract class Var {
* Constructor.
*
* @param name The name of this variable.
- * @param streamed Whether this variable is 'streamed', meaning the {@link #resolveTo(VarResolverSession, Writer, String)}
- * method is implemented. If <jk>false</jk>, then the {@link #resolve(VarResolverSession, String)} method is implemented.
+ * @param streamed Whether this variable is 'streamed', meaning the {@link #resolveTo(VarResolverSession, Writer,
+ * String)} method is implemented.
+ * If <jk>false</jk>, then the {@link #resolve(VarResolverSession, String)} method is implemented.
*/
public Var(String name, boolean streamed) {
this.name = name;
@@ -67,8 +69,8 @@ public abstract class Var {
/**
* Return the name of this variable.
* <p>
- * For example, the system property variable returns <js>"S"</js> since the format of the
- * variable is <js>"$S{system.property}"</js>.
+ * For example, the system property variable returns <js>"S"</js> since the format of the variable is
+ * <js>"$S{system.property}"</js>.
*
* @return The name of this variable.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 deb3eb3..aa9cceb 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
@@ -22,8 +22,9 @@ 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.
+ * 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.
* <p>
* Variables are defined through the {@link VarResolverBuilder#vars(Class[])} method.
* <p>
@@ -55,26 +56,28 @@ import org.apache.juneau.svl.vars.*;
* <p>
* Var resolvers can have zero or more context objects associated with them.
* <p>
- * Context objects are arbitrary objects associated with this var resolver, such as
- * a {@link ConfigFile} object.
+ * Context objects are arbitrary objects associated with this var resolver, such as a {@link ConfigFile} object.
* They can be any class type.
* <p>
- * Context objects can be retrieved by {@link Var} classes through the {@link VarResolverSession#getSessionObject(Class, String)} method.
+ * Context objects can be retrieved by {@link Var} classes through the
+ * {@link VarResolverSession#getSessionObject(Class, String)} method.
*
* <h6 class='topic'>Session objects</h6>
* <p>
* Session objects are considered more ephemeral than context objects.
- * While a context object is unlikely to ever change, a session object may change on every
- * use of the var resolver.
+ * While a context object is unlikely to ever change, a session object may change on every use of the var resolver.
* For example, the server API defines various <code>Var</code> objects that use the <code>RestRequest</code>
- * object as a session object for the duration of a single HTTP request.
+ * object as a session object for the duration of a single HTTP request.
* <p>
- * Session objects are used by calling the {@link #createSession()} or {@link #createSession(Map)} methods to create an instance
- * of a {@link VarResolverSession} object that contains {@link VarResolverSession#resolve(String)} and {@link VarResolverSession#resolveTo(String,Writer)} methods
- * that are identical to {@link VarResolver#resolve(String)} and {@link VarResolver#resolveTo(String, Writer)} except that the <code>Var</code> objects
- * have access to the session objects through the {@link VarResolverSession#getSessionObject(Class, String)} method.
+ * Session objects are used by calling the {@link #createSession()} or {@link #createSession(Map)} methods to create
+ * an instance of a {@link VarResolverSession} object that contains {@link VarResolverSession#resolve(String)}
+ * and {@link VarResolverSession#resolveTo(String,Writer)} methods that are identical to
+ * {@link VarResolver#resolve(String)} and {@link VarResolver#resolveTo(String, Writer)} except that the
+ * <code>Var</code> objects have access to the session objects through the
+ * {@link VarResolverSession#getSessionObject(Class, String)} method.
* <p>
- * Session objects are specified through either the {@link #createSession(Map)} method or the {@link VarResolverSession#sessionObject(String, Object)} methods.
+ * Session objects are specified through either the {@link #createSession(Map)} method or the
+ * {@link VarResolverSession#sessionObject(String, Object)} methods.
*
* <h6 class='topic'>Cloning</h6>
* <p>
@@ -84,7 +87,8 @@ import org.apache.juneau.svl.vars.*;
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a resolver that copies the default resolver and adds $C and $ARG vars.</jc>
- * VarResolver myVarResolver = VarResolver.<jsf>DEFAULT</jsf>.builder().vars(ConfigVar.<jk>class</jk>, ArgsVar.<jk>class</jk>).build();
+ * VarResolver myVarResolver = VarResolver.<jsf>DEFAULT</jsf>.builder().vars(ConfigVar.<jk>class</jk>,
+ * ArgsVar.<jk>class</jk>).build();
* </p>
*
* @see org.apache.juneau.svl
@@ -110,6 +114,7 @@ public class VarResolver {
/**
* Constructor.
+ *
* @param vars The var classes
* @param contextObjects
*/
@@ -130,6 +135,7 @@ public class VarResolver {
/**
* Returns the read-only properties on this variable resolver.
+ *
* @return The read-only properties on this variable resolver.
*/
public VarResolverContext getContext() {
@@ -139,7 +145,8 @@ public class VarResolver {
/**
* Creates a new resolver session with no session objects.
* <p>
- * Session objects can be associated with the specified session using the {@link VarResolverSession#sessionObject(String, Object)} method.
+ * Session objects can be associated with the specified session using the
+ * {@link VarResolverSession#sessionObject(String, Object)} method.
*
* @return A new resolver session.
*/
@@ -150,7 +157,7 @@ public class VarResolver {
/**
* Same as {@link #createSession()} except allows you to specify session objects as a map.
*
- * @param sessionObjects The session objects to associate with the sessino.
+ * @param sessionObjects The session objects to associate with the session.
* @return A new resolver session.
*/
public VarResolverSession createSession(Map<String,Object> sessionObjects) {
@@ -161,7 +168,8 @@ public class VarResolver {
* Resolve variables in the specified string.
* <p>
* This is a shortcut for calling <code>createSession(<jk>null</jk>).resolve(s);</code>.
- * This method can only be used if the string doesn't contain variables that rely on the existence of session variables.
+ * This method can only be used if the string doesn't contain variables that rely on the existence of session
+ * variables.
*
* @param s The input string.
* @return The string with variables resolved, or the same string if it doesn't contain any variables to resolve.
@@ -174,7 +182,8 @@ public class VarResolver {
* Resolve variables in the specified string and sends the results to the specified writer.
* <p>
* This is a shortcut for calling <code>createSession(<jk>null</jk>).resolveTo(s, w);</code>.
- * This method can only be used if the string doesn't contain variables that rely on the existence of session variables.
+ * This method can only be used if the string doesn't contain variables that rely on the existence of session
+ * variables.
*
* @param s The input string.
* @param w The writer to send the result to.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverBuilder.java b/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverBuilder.java
index d6df847..f4414dd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverBuilder.java
@@ -73,8 +73,8 @@ public class VarResolverBuilder {
/**
* Associates a context object with this resolver.
* <p>
- * A context object is essentially some environmental object that doesn't change
- * but is used by vars to customize output.
+ * A context object is essentially some environmental object that doesn't change but is used by vars to customize
+ * output.
*
* @param name The name of the context object.
* @param object The context object.
@@ -88,8 +88,8 @@ public class VarResolverBuilder {
/**
* Associates multiple context objects with this resolver.
* <p>
- * A context object is essentially some environmental object that doesn't change
- * but is used by vars to customize output.
+ * A context object is essentially some environmental object that doesn't change but is used by vars to customize
+ * output.
*
* @param map A map of context objects keyed by their name.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverContext.java b/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverContext.java
index 416ee57..1f9757d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverContext.java
@@ -32,6 +32,7 @@ public class VarResolverContext {
/**
* Constructor.
+ *
* @param vars The Var classes used for resolving string variables.
* @param contextObjects Read-only context objects.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverSession.java b/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverSession.java
index 8f7540b..ef012e3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/VarResolverSession.java
@@ -26,8 +26,8 @@ import org.apache.juneau.*;
* <p>
* This class contains the workhorse code for var resolution.
* <p>
- * Instances of this class are created through the {@link VarResolver#createSession()} and {@link VarResolver#createSession(Map)}
- * methods.
+ * Instances of this class are created through the {@link VarResolver#createSession()} and
+ * {@link VarResolver#createSession(Map)} methods.
* <p>
* Instances of this class are NOT guaranteed to be thread safe.
*
@@ -41,8 +41,8 @@ public class VarResolverSession {
/**
* Constructor.
*
- * @param context The {@link VarResolver} context object that contains the {@link Var Vars} and
- * context objects associated with that resolver.
+ * @param context The {@link VarResolver} context object that contains the {@link Var Vars} and context objects
+ * associated with that resolver.
* @param sessionObjects The session objects.
*
*/
@@ -144,8 +144,8 @@ public class VarResolverSession {
/**
* Resolves variables in the specified string and sends the output to the specified writer.
- * More efficient than first parsing to a string and then serializing to the writer since this
- * method doesn't need to construct a large string.
+ * More efficient than first parsing to a string and then serializing to the writer since this method doesn't need
+ * to construct a large string.
*
* @param s The string to resolve variables in.
* @param out The writer to write to.
@@ -276,10 +276,12 @@ public class VarResolverSession {
t = (T)sessionObjects.get(name);
}
} catch (Exception e) {
- throw new FormattedRuntimeException(e, "Session object ''{0}'' or context object ''SvlContext.{0}'' could not be converted to type ''{1}''.", name, c);
+ throw new FormattedRuntimeException(e,
+ "Session object ''{0}'' or context object ''SvlContext.{0}'' could not be converted to type ''{1}''.", name, c);
}
if (t == null)
- throw new FormattedRuntimeException("Session object ''{0}'' or context object ''SvlContext.{0}'' not found.", name);
+ throw new FormattedRuntimeException(
+ "Session object ''{0}'' or context object ''SvlContext.{0}'' not found.", name);
return t;
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 4cc559f..e282e01 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
@@ -80,8 +80,8 @@
</p>
<p>
The {@link org.apache.juneau.svl.VarResolver} class is used to resolve variables.
- The {@link org.apache.juneau.svl.VarResolver#DEFAULT} resolver will resolve <js>"$S{systemProperty}"</js> and <js>"$E{envVariable}"</js>
- variables.
+ The {@link org.apache.juneau.svl.VarResolver#DEFAULT} resolver will resolve <js>"$S{systemProperty}"</js>
+ and <js>"$E{envVariable}"</js> variables.
</p>
<p class='bcode'>
<jc>// Use the default variable resolver to resolve a string that contains $S (system property) variables</jc>
@@ -139,32 +139,47 @@
<ul>
<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} - Variables that define a default value if the resolve method returns null.
+ <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} - Variables that pull values from maps.
+ <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} - Resolves system properties.
+ <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} - Resolves variables from an {@link org.apache.juneau.utils.Args} object.
- <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} - Resolves environment variables.
- <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} - Resolves servlet initialization parameters.
+ <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}
+ - Resolves variables from a {@link org.apache.juneau.ini.ConfigFile} object.
+ <li class='jc'>{@link org.apache.juneau.svl.vars.EnvVariablesVar}
+ - Resolves environment variables.
+ <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}
+ - Resolves servlet initialization parameters.
</ul>
</li>
- <li class='jac'>{@link org.apache.juneau.svl.MultipartVar} - Variables that consist of 2 or more comma-delimited arguments.
+ <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} - Resolves localized strings for an HTTP request.
+ <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} - Resolves specialized HTTP request values.
- <li class='jc'>{@link org.apache.juneau.rest.vars.UrlEncodeVar} - URL-encodes the value inside the variable.
+ <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}
+ - URL-encodes the value inside the variable.
</ul>
</li>
- <li class='jac'>{@link org.apache.juneau.svl.StreamedVar} - Superclass of all vars that stream their value to writers.
+ <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>
@@ -181,47 +196,63 @@
Two methods are provided for resolving variables:
</p>
<ul class='doctree'>
- <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)} - Resolves variables and sends results to a writer.
+ <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)}
+ - Resolves variables and sends results to a writer.
</ul>
<p>
Var resolvers can have zero or more context objects associated with them.
- Some {@link org.apache.juneau.svl.Var Vars} rely on the existence of some other object, such as an {@link org.apache.juneau.utils.Args} object
- for {@link org.apache.juneau.svl.vars.ArgsVar} or a {@link org.apache.juneau.ini.ConfigFile} for a {@link org.apache.juneau.svl.vars.ConfigFileVar}.
+ Some {@link org.apache.juneau.svl.Var Vars} rely on the existence of some other object, such as an
+ {@link org.apache.juneau.utils.Args} object
+ for {@link org.apache.juneau.svl.vars.ArgsVar} or a {@link org.apache.juneau.ini.ConfigFile} for a
+ {@link org.apache.juneau.svl.vars.ConfigFileVar}.
These object dependencies are made by setting context objects on the var resolver.
</p>
<p>
- Context objects are set through the {@link org.apache.juneau.svl.VarResolverBuilder#contextObject(String,Object)} method.
+ Context objects are set through the {@link org.apache.juneau.svl.VarResolverBuilder
+ #contextObject(String,Object)} method.
They can be any class type.
</p>
<p>
- Context objects are used by {@link org.apache.juneau.svl.Var Vars} by calling the {@link org.apache.juneau.svl.VarResolverSession#getSessionObject(Class, String)} method.
+ Context objects are used by {@link org.apache.juneau.svl.Var Vars} by calling the
+ {@link org.apache.juneau.svl.VarResolverSession#getSessionObject(Class, String)} method.
</p>
<p>
In addition to context objects, there are also session objects.
Session objects are considered more ephemeral than context objects.
- While a context object is unlikely to ever change, a session object may change on every use of the var resolver.
+ While a context object is unlikely to ever change, a session object may change on every use of the var
+ resolver.
For example, the server API defines various <code>Var</code> objects that use the <code>RestRequest</code>
object as a session object for the duration of a single HTTP request.
</p>
<p>
- Session objects are used by calling the {@link org.apache.juneau.svl.VarResolver#createSession()} or {@link org.apache.juneau.svl.VarResolver#createSession(Map)} methods to create an instance
- of a {@link org.apache.juneau.svl.VarResolverSession} object that contains {@link org.apache.juneau.svl.VarResolverSession#resolve(String)} and {@link org.apache.juneau.svl.VarResolverSession#resolveTo(String,Writer)} methods
- that are identical to {@link org.apache.juneau.svl.VarResolver#resolve(String)} and {@link org.apache.juneau.svl.VarResolver#resolveTo(String, Writer)} except that the <code>Var</code> objects
- have access to the session objects through the {@link org.apache.juneau.svl.VarResolverSession#getSessionObject(Class, String)} method.
- Session objects are specified through either the {@link org.apache.juneau.svl.VarResolver#createSession(Map)} method or the {@link org.apache.juneau.svl.VarResolverSession#sessionObject(String, Object)} methods.
+ Session objects are used by calling the {@link org.apache.juneau.svl.VarResolver#createSession()} or
+ {@link org.apache.juneau.svl.VarResolver#createSession(Map)} methods to create an instance of a
+ {@link org.apache.juneau.svl.VarResolverSession} object that contains
+ {@link org.apache.juneau.svl.VarResolverSession#resolve(String)} and
+ {@link org.apache.juneau.svl.VarResolverSession#resolveTo(String,Writer)} methods that are identical to
+ {@link org.apache.juneau.svl.VarResolver#resolve(String)} and
+ {@link org.apache.juneau.svl.VarResolver#resolveTo(String, Writer)} except that the <code>Var</code> objects
+ have access to the session objects through the
+ {@link org.apache.juneau.svl.VarResolverSession#getSessionObject(Class, String)} method.
+ Session objects are specified through either the {@link org.apache.juneau.svl.VarResolver#createSession(Map)}
+ method or the {@link org.apache.juneau.svl.VarResolverSession#sessionObject(String, Object)} methods.
</p>
<p>
- Like Context object, Session objects are used by {@link org.apache.juneau.svl.Var Vars} by calling the {@link org.apache.juneau.svl.VarResolverSession#getSessionObject(Class, String)} method.
+ Like Context object, Session objects are used by {@link org.apache.juneau.svl.Var Vars} by calling the
+ {@link org.apache.juneau.svl.VarResolverSession#getSessionObject(Class, String)} method.
</p>
<p>
- Var resolvers can be cloned and extended by using the {@link org.apache.juneau.svl.VarResolver#builder()} method.
+ Var resolvers can be cloned and extended by using the {@link org.apache.juneau.svl.VarResolver#builder()}
+ 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>
- VarResolver myVarResolver = VarResolver.<jsf>DEFAULT</jsf>.builder().vars(ConfigFileVar.<jk>class</jk>, ArgsVar.<jk>class</jk>).build();
+ VarResolver myVarResolver = VarResolver.<jsf>DEFAULT</jsf>.builder().vars(ConfigFileVar.<jk>class</jk>,
+ ArgsVar.<jk>class</jk>).build();
</p>
</div>
@@ -230,13 +261,17 @@
<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: <code>$ , { }</code>
- <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>).
+ <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
+ 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 needed.<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.
+ <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.
+ <code>resolver.resolve(<js>"foobar"</js>)</code>) will simply be a no-op and return the same string.
</ul>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java b/juneau-core/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
index 6ec840e..5597a8b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
@@ -21,7 +21,7 @@ import org.apache.juneau.utils.*;
* The format for this var is <js>"$ARG{argNameOrNum}"</js> or <js>"$ARG{argNameOrNum,defaultValue}"</js>
* <p>
* This variable resolver requires that an {@link Args} object be set as a context object on the resolver or a
- * session object on the resolver session.
+ * session object on the resolver session.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -29,7 +29,8 @@ import org.apache.juneau.utils.*;
* Args args = new Args(argv);
*
* <jc>// Create a variable resolver that resolves JVM arguments (e.g. "$ARG{1}")</jc>
- * VarResolver r = <jk>new</jk> VarResolver().addVars(ArgsVar.<js>class</js>).addContextObject(<jsf>SESSION_args</jsf>, args);
+ * VarResolver r = <jk>new</jk> VarResolver().addVars(ArgsVar.<js>class</js>)
+ * .addContextObject(<jsf>SESSION_args</jsf>, args);
*
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"Arg #1 is set to $ARG{1}"</js>));
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/svl/vars/ConfigFileVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/vars/ConfigFileVar.java b/juneau-core/src/main/java/org/apache/juneau/svl/vars/ConfigFileVar.java
index 77023dc..04e704f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/vars/ConfigFileVar.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/vars/ConfigFileVar.java
@@ -22,7 +22,7 @@ import org.apache.juneau.svl.*;
* See {@link ConfigFile#getString(String)} for the format of the key.
* <p>
* This variable resolver requires that a {@link ConfigFile} object be set as a context object on the resolver or a
- * session object on the resolver session.
+ * session object on the resolver session.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -30,7 +30,8 @@ import org.apache.juneau.svl.*;
* ConfigFile configFile = new ConfigFileBuilder().build(<js>"MyConfig.cfg"</js>);
*
* <jc>// Create a variable resolver that resolves config file entries (e.g. "$C{MySection/myKey}")</jc>
- * VarResolver r = <jk>new</jk> VarResolver().addVars(ConfigVar.<js>class</js>).addContextObject(<jsf>SESSION_config</jsf>, configFile);
+ * VarResolver r = <jk>new</jk> VarResolver().addVars(ConfigVar.<js>class</js>)
+ * .addContextObject(<jsf>SESSION_config</jsf>, configFile);
*
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"Value for myKey in section MySection is $C{MySection/myKey}"</js>));
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 f7eca79..922fb99 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,8 +26,11 @@ 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>,<js>"T"</js>,<js>"1"</js>.
- * <br>All else are interpreted as <jk>false</jk>
+ * <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>
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java b/juneau-core/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
index f117102..35bea2d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
@@ -21,7 +21,7 @@ import org.apache.juneau.utils.*;
* The format for this var is <js>"$MF{key}"</js> or <js>"$MF{key,defaultValue}"</js>
* <p>
* This variable resolver requires that a {@link ManifestFile} object be set as a context object on the resolver or a
- * session object on the resolver session.
+ * session object on the resolver session.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -29,7 +29,8 @@ import org.apache.juneau.utils.*;
* ManifestFile mf = <jk>new</jk> ManifestFile(<jk>this</jk>.getClass());
*
* <jc>// Create a variable resolver that resolves manifest file entries (e.g. "$MF{Main-Class}")</jc>
- * VarResolver r = <jk>new</jk> VarResolver().addVars(ManifestFile.<js>class</js>).addContextObject(<jsf>SESSION_manifest</jsf>, mf);
+ * VarResolver r = <jk>new</jk> VarResolver().addVars(ManifestFile.<js>class</js>)
+ * .addContextObject(<jsf>SESSION_manifest</jsf>, mf);
*
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"The main class is $MF{Main-Class}"</js>));
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java b/juneau-core/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
index 1f66516..caa6108 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
@@ -30,7 +30,8 @@ import org.apache.juneau.svl.*;
* <li>...
* </ul>
* <p>
- * The pattern can be any string optionally containing <js>'*'</js> or <js>'?'</js> representing any or one character respectively.
+ * The pattern can be any string optionally containing <js>'*'</js> or <js>'?'</js> representing any or one character
+ * respectively.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
[09/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 2e3bfa4..f646040 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
@@ -35,87 +35,91 @@ import org.apache.juneau.utils.*;
* <p>
* However, the media types can also be specified programmatically by overriding the {@link #getMediaTypes()} method.
*
- * <a id='ValidDataConversions'></a><h6 class='topic'>Valid data conversions</h6>
- * Parsers can parse any parsable POJO types, as specified in the <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a>.
+ * <h6 class='topic'>Valid data conversions</h6>
+ * Parsers can parse any parsable POJO types, as specified in the <a class="doclink"
+ * href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a>.
* <p>
* Some examples of conversions are shown below...
* </p>
- * <table class='styled'>
- * <tr>
- * <th>Data type</th>
- * <th>Class type</th>
- * <th>JSON example</th>
- * <th>XML example</th>
- * <th>Class examples</th>
- * </tr>
- * <tr>
- * <td>object</td>
- * <td>Maps, Java beans</td>
- * <td class='code'>{name:<js>'John Smith'</js>,age:21}</td>
- * <td class='code'><xt><object>
+ * <table class='styled'>
+ * <tr>
+ * <th>Data type</th>
+ * <th>Class type</th>
+ * <th>JSON example</th>
+ * <th>XML example</th>
+ * <th>Class examples</th>
+ * </tr>
+ * <tr>
+ * <td>object</td>
+ * <td>Maps, Java beans</td>
+ * <td class='code'>{name:<js>'John Smith'</js>,age:21}</td>
+ * <td class='code'><xt><object>
* <name</xt> <xa>type</xa>=<xs>'string'</xs><xt>></xt>John Smith<xt></name>
* <age</xt> <xa>type</xa>=<xs>'number'</xs><xt>></xt>21<xt></age>
* </object></xt></td>
- * <td class='code'>HashMap, TreeMap<String,Integer></td>
- * </tr>
- * <tr>
- * <td>array</td>
- * <td>Collections, Java arrays</td>
- * <td class='code'>[1,2,3]</td>
- * <td class='code'><xt><array>
+ * <td class='code'>HashMap, TreeMap<String,Integer></td>
+ * </tr>
+ * <tr>
+ * <td>array</td>
+ * <td>Collections, Java arrays</td>
+ * <td class='code'>[1,2,3]</td>
+ * <td class='code'><xt><array>
* <number></xt>1<xt></number>
* <number></xt>2<xt></number>
* <number></xt>3<xt></number>
* </array></xt></td>
- * <td class='code'>List<Integer>, <jk>int</jk>[], Float[], Set<Person></td>
- * </tr>
- * <tr>
- * <td>number</td>
- * <td>Numbers</td>
- * <td class='code'>123</td>
- * <td class='code'><xt><number></xt>123<xt></number></xt></td>
- * <td class='code'>Integer, Long, Float, <jk>int</jk></td>
- * </tr>
- * <tr>
- * <td>boolean</td>
- * <td>Booleans</td>
- * <td class='code'><jk>true</jk></td>
- * <td class='code'><xt><boolean></xt>true<xt></boolean></xt></td>
- * <td class='code'>Boolean</td>
- * </tr>
- * <tr>
- * <td>string</td>
- * <td>CharSequences</td>
- * <td class='code'><js>'foobar'</js></td>
- * <td class='code'><xt><string></xt>foobar<xt></string></xt></td>
- * <td class='code'>String, StringBuilder</td>
- * </tr>
- * </table>
+ * <td class='code'>List<Integer>, <jk>int</jk>[], Float[], Set<Person></td>
+ * </tr>
+ * <tr>
+ * <td>number</td>
+ * <td>Numbers</td>
+ * <td class='code'>123</td>
+ * <td class='code'><xt><number></xt>123<xt></number></xt></td>
+ * <td class='code'>Integer, Long, Float, <jk>int</jk></td>
+ * </tr>
+ * <tr>
+ * <td>boolean</td>
+ * <td>Booleans</td>
+ * <td class='code'><jk>true</jk></td>
+ * <td class='code'><xt><boolean></xt>true<xt></boolean></xt></td>
+ * <td class='code'>Boolean</td>
+ * </tr>
+ * <tr>
+ * <td>string</td>
+ * <td>CharSequences</td>
+ * <td class='code'><js>'foobar'</js></td>
+ * <td class='code'><xt><string></xt>foobar<xt></string></xt></td>
+ * <td class='code'>String, StringBuilder</td>
+ * </tr>
+ * </table>
* <p>
* In addition, any class types with {@link PojoSwap PojoSwaps} associated with them on the registered
* {@link #getBeanContext() beanContext} can also be passed in.
* <p>
- * For example, if the {@link CalendarSwap} transform is used to generalize {@code Calendar} objects to {@code String} objects. When registered
- * with this parser, you can construct {@code Calendar} objects from {@code Strings} using the following syntax...
+ * For example, if the {@link CalendarSwap} transform is used to generalize {@code Calendar} objects to {@code String}
+ * objects.
+ * When registered with this parser, you can construct {@code Calendar} objects from {@code Strings} using the
+ * following syntax...
* <p class='bcode'>
* Calendar c = parser.parse(<js>"'Sun Mar 03 04:05:06 EST 2001'"</js>, GregorianCalendar.<jk>class</jk>);
* <p>
- * If <code>Object.<jk>class</jk></code> is specified as the target type, then the parser
- * automatically determines the data types and generates the following object types...
+ * If <code>Object.<jk>class</jk></code> is specified as the target type, then the parser automatically determines the
+ * data types and generates the following object types...
* </p>
* <table class='styled'>
* <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}, {@link Double}, {@link Float}, etc...)</td></tr>
+ * <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>
* <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...
+ * 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...
* </p>
* <ul>
* <li>{@link ClassMeta}
@@ -125,10 +129,10 @@ import org.apache.juneau.utils.*;
* </ul>
* <p>
* However, {@code ParameterizedTypes} and {@code GenericArrayTypes} should not contain
- * {@link WildcardType WildcardTypes} or {@link TypeVariable TypeVariables}.
+ * {@link WildcardType WildcardTypes} or {@link TypeVariable TypeVariables}.
* <p>
* Passing in <jk>null</jk> or <code>Object.<jk>class</jk></code> typically signifies that it's up to the parser
- * to determine what object type is being parsed parsed based on the rules above.
+ * to determine what object type is being parsed parsed based on the rules above.
*/
public abstract class Parser extends CoreObject {
@@ -163,11 +167,14 @@ public abstract class Parser extends CoreObject {
/**
* Workhorse method. Subclasses are expected to implement this method.
- * @param session The runtime session object returned by {@link #createSession(Object, ObjectMap, Method, Object, Locale, TimeZone, MediaType)}.
+ *
+ * @param session The runtime session object returned by {@link #createSession(Object, ObjectMap, Method, Object,
+ * Locale, TimeZone, MediaType)}.
* If <jk>null</jk>, one will be created using {@link #createSession(Object)}.
* @param type The class type of the object to create.
* If <jk>null</jk> or <code>Object.<jk>class</jk></code>, object type is based on what's being parsed.
- * For example, when parsing JSON text, it may return a <code>String</code>, <code>Number</code>, <code>ObjectMap</code>, etc...
+ * For example, when parsing JSON text, it may return a <code>String</code>, <code>Number</code>,
+ * <code>ObjectMap</code>, etc...
* @param <T> The class type of the object to create.
* @return The parsed object.
* @throws Exception If thrown from underlying stream, or if the input contains a syntax error or is malformed.
@@ -188,12 +195,16 @@ public abstract class Parser extends CoreObject {
/**
* Entry point for all parsing calls.
* <p>
- * Calls the {@link #doParse(ParserSession, ClassMeta)} implementation class and catches/rewraps any exceptions thrown.
- * @param session The runtime session returned by {@link #createSession(Object, ObjectMap, Method, Object, Locale, TimeZone, MediaType)}.
+ * Calls the {@link #doParse(ParserSession, ClassMeta)} implementation class and catches/rewraps any exceptions
+ * thrown.
+ *
+ * @param session The runtime session returned by {@link #createSession(Object, ObjectMap, Method, Object, Locale,
+ * TimeZone, MediaType)}.
* @param type The class type of the object to create.
* @param <T> The class type of the object to create.
* @return The parsed object.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.
+ * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified
+ * type.
*/
public final <T> T parseSession(ParserSession session, ClassMeta<T> type) throws ParseException {
try {
@@ -205,9 +216,11 @@ public abstract class Parser extends CoreObject {
} catch (StackOverflowError e) {
throw new ParseException(session, "Depth too deep. Stack overflow occurred.");
} catch (IOException e) {
- throw new ParseException(session, "I/O exception occurred. exception={0}, message={1}.", e.getClass().getSimpleName(), e.getLocalizedMessage()).initCause(e);
+ throw new ParseException(session, "I/O exception occurred. exception={0}, message={1}.",
+ e.getClass().getSimpleName(), e.getLocalizedMessage()).initCause(e);
} catch (Exception e) {
- throw new ParseException(session, "Exception occurred. exception={0}, message={1}.", e.getClass().getSimpleName(), e.getLocalizedMessage()).initCause(e);
+ throw new ParseException(session, "Exception occurred. exception={0}, message={1}.",
+ e.getClass().getSimpleName(), e.getLocalizedMessage()).initCause(e);
} finally {
session.close();
}
@@ -250,29 +263,37 @@ public abstract class Parser extends CoreObject {
*
* @param <T> The class type of the object to create.
* @param input The input.
- * <br>Character-based parsers can handle the following input class types:
- * <ul>
- * <li><jk>null</jk>
- * <li>{@link Reader}
- * <li>{@link CharSequence}
- * <li>{@link InputStream} containing UTF-8 encoded text (or charset defined by {@link ParserContext#PARSER_inputStreamCharset} property value).
- * <li><code><jk>byte</jk>[]</code> containing UTF-8 encoded text (or charset defined by {@link ParserContext#PARSER_inputStreamCharset} property value).
- * <li>{@link File} containing system encoded text (or charset defined by {@link ParserContext#PARSER_fileCharset} property value).
- * </ul>
- * <br>Stream-based parsers can handle the following input class types:
- * <ul>
- * <li><jk>null</jk>
- * <li>{@link InputStream}
- * <li><code><jk>byte</jk>[]</code>
- * <li>{@link File}
- * </ul>
+ * <br>
+ * Character-based parsers can handle the following input class types:
+ * <ul>
+ * <li><jk>null</jk>
+ * <li>{@link Reader}
+ * <li>{@link CharSequence}
+ * <li>{@link InputStream} containing UTF-8 encoded text (or charset defined by
+ * {@link ParserContext#PARSER_inputStreamCharset} property value).
+ * <li><code><jk>byte</jk>[]</code> containing UTF-8 encoded text (or charset defined by
+ * {@link ParserContext#PARSER_inputStreamCharset} property value).
+ * <li>{@link File} containing system encoded text (or charset defined by
+ * {@link ParserContext#PARSER_fileCharset} property value).
+ * </ul>
+ * <br>
+ * Stream-based parsers can handle the following input class types:
+ * <ul>
+ * <li><jk>null</jk>
+ * <li>{@link InputStream}
+ * <li><code><jk>byte</jk>[]</code>
+ * <li>{@link File}
+ * </ul>
* @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @return The parsed object.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.
+ * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified
+ * type.
* @see BeanSession#getClassMeta(Type,Type...) for argument syntax for maps and collections.
*/
@SuppressWarnings("unchecked")
@@ -310,7 +331,8 @@ public abstract class Parser extends CoreObject {
* See {@link #parse(Object, Type, Type...)} for details.
* @param type The object type to create.
* @return The parsed object.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.
+ * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified
+ * type.
*/
public final <T> T parse(Object input, Class<T> type) throws ParseException {
ParserSession session = createSession(input);
@@ -318,7 +340,8 @@ public abstract class Parser extends CoreObject {
}
/**
- * Same as {@link #parse(Object, Type, Type...)} except the type has already been converted into a {@link ClassMeta} object.
+ * Same as {@link #parse(Object, Type, Type...)} except the type has already been converted into a {@link ClassMeta}
+ * object.
* <p>
* This is mostly an internal method used by the framework.
*
@@ -327,7 +350,8 @@ public abstract class Parser extends CoreObject {
* See {@link #parse(Object, Type, Type...)} for details.
* @param type The object type to create.
* @return The parsed object.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.
+ * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified
+ * type.
*/
public final <T> T parse(Object input, ClassMeta<T> type) throws ParseException {
return parseSession(createSession(input), type);
@@ -336,8 +360,8 @@ public abstract class Parser extends CoreObject {
/**
* Create the session object that will be passed in to the parse method.
* <p>
- * It's up to implementers to decide what the session object looks like, although typically
- * it's going to be a subclass of {@link ParserSession}.
+ * It's up to implementers to decide what the session object looks like, although typically it's going to be a
+ * subclass of {@link ParserSession}.
*
* @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.
* @param op Optional additional properties.
@@ -352,7 +376,8 @@ public abstract class Parser extends CoreObject {
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
* @return The new session.
*/
- public ParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public ParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale,
+ TimeZone timeZone, MediaType mediaType) {
return new ParserSession(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);
}
@@ -380,15 +405,16 @@ 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. {@link ObjectMap#ObjectMap(CharSequence,Parser)}).
+ * <li>The various character-based constructors in {@link ObjectMap} (e.g.
+ * {@link ObjectMap#ObjectMap(CharSequence,Parser)}).
* </ul>
*
* @param <K> The key class type.
* @param <V> The value class type.
* @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.
* @param m The map being loaded.
- * @param keyType The class type of the keys, or <jk>null</jk> to default to <code>String.<jk>class</jk></code>.<br>
- * @param valueType The class type of the values, or <jk>null</jk> to default to whatever is being parsed.<br>
+ * @param keyType The class type of the keys, or <jk>null</jk> to default to <code>String.<jk>class</jk></code>.
+ * @param valueType The class type of the values, or <jk>null</jk> to default to whatever is being parsed.
* @return The same map that was passed in to allow this method to be chained.
* @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.
* @throws UnsupportedOperationException If not implemented.
@@ -409,12 +435,13 @@ public abstract class Parser extends CoreObject {
/**
* Implementation method.
* Default implementation throws an {@link UnsupportedOperationException}.
- * @param session The runtime session object returned by {@link #createSession(Object, ObjectMap, Method, Object, Locale, TimeZone, MediaType)}.
+ *
+ * @param session The runtime session object returned by
+ * {@link #createSession(Object, ObjectMap, Method, Object, Locale, TimeZone, MediaType)}.
* If <jk>null</jk>, one will be created using {@link #createSession(Object)}.
* @param m The map being loaded.
- * @param keyType The class type of the keys, or <jk>null</jk> to default to <code>String.<jk>class</jk></code>.<br>
- * @param valueType The class type of the values, or <jk>null</jk> to default to whatever is being parsed.<br>
- *
+ * @param keyType The class type of the keys, or <jk>null</jk> to default to <code>String.<jk>class</jk></code>.
+ * @param valueType The class type of the values, or <jk>null</jk> to default to whatever is being parsed.
* @return The same map that was passed in to allow this method to be chained.
* @throws Exception If thrown from underlying stream, or if the input contains a syntax error or is malformed.
*/
@@ -427,7 +454,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. {@link ObjectList#ObjectList(CharSequence,Parser)}.
+ * <li>The various character-based constructors in {@link ObjectList} (e.g.
+ * {@link ObjectList#ObjectList(CharSequence,Parser)}.
* </ul>
*
* @param <E> The element class type.
@@ -435,10 +463,12 @@ public abstract class Parser extends CoreObject {
* @param c The collection being loaded.
* @param elementType The class type of the elements, or <jk>null</jk> to default to whatever is being parsed.
* @return The same collection that was passed in to allow this method to be chained.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.
+ * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified
+ * type.
* @throws UnsupportedOperationException If not implemented.
*/
- public final <E> Collection<E> parseIntoCollection(Object input, Collection<E> c, Type elementType) throws ParseException {
+ public final <E> Collection<E> parseIntoCollection(Object input, Collection<E> c, Type elementType)
+ throws ParseException {
ParserSession session = createSession(input);
try {
return doParseIntoCollection(session, c, elementType);
@@ -454,11 +484,12 @@ public abstract class Parser extends CoreObject {
/**
* Implementation method.
* Default implementation throws an {@link UnsupportedOperationException}.
- * @param session The runtime session object returned by {@link #createSession(Object, ObjectMap, Method, Object, Locale, TimeZone, MediaType)}.
+ *
+ * @param session The runtime session object returned by {@link #createSession(Object, ObjectMap, Method, Object,
+ * Locale, TimeZone, MediaType)}.
* If <jk>null</jk>, one will be created using {@link #createSession(Object)}.
* @param c The collection being loaded.
* @param elementType The class type of the elements, or <jk>null</jk> to default to whatever is being parsed.
- *
* @return The same collection that was passed in to allow this method to be chained.
* @throws Exception If thrown from underlying stream, or if the input contains a syntax error or is malformed.
*/
@@ -471,7 +502,7 @@ public abstract class Parser extends CoreObject {
* argument.
* <p>
* Used for converting arrays (e.g. <js>"[arg1,arg2,...]"</js>) into an {@code Object[]} that can be passed
- * to the {@code Method.invoke(target, args)} method.
+ * to the {@code Method.invoke(target, args)} method.
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
@@ -481,7 +512,8 @@ public abstract class Parser extends CoreObject {
* @param input The input. Subclasses can support different input types.
* @param argTypes Specifies the type of objects to create for each entry in the array.
* @return An array of parsed objects.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.
+ * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified
+ * type.
*/
public final Object[] parseArgs(Object input, Type[] argTypes) throws ParseException {
if (argTypes == null || argTypes.length == 0)
@@ -507,7 +539,8 @@ public abstract class Parser extends CoreObject {
* Converts the specified string to the specified type.
*
* @param session The session object.
- * @param outer The outer object if we're converting to an inner object that needs to be created within the context of an outer object.
+ * @param outer The outer object if we're converting to an inner object that needs to be created within the context
+ * of an outer object.
* @param s The string to convert.
* @param type The class type to convert the string to.
* @return The string converted as an object of the specified type.
@@ -548,8 +581,8 @@ public abstract class Parser extends CoreObject {
}
/**
- * Convenience method for calling the {@link ParentProperty @ParentProperty} method on
- * the specified object if it exists.
+ * Convenience method for calling the {@link ParentProperty @ParentProperty} method on the specified object if it
+ * exists.
*
* @param cm The class type of the object.
* @param o The object.
@@ -563,8 +596,7 @@ public abstract class Parser extends CoreObject {
}
/**
- * Convenience method for calling the {@link NameProperty @NameProperty} method on
- * the specified object if it exists.
+ * Convenience method for calling the {@link NameProperty @NameProperty} method on the specified object if it exists.
*
* @param cm The class type of the object.
* @param o The object.
@@ -582,7 +614,7 @@ public abstract class Parser extends CoreObject {
/**
* Returns the media types handled based on the value of the {@link Consumes} annotation on the parser class.
* <p>
- * This method can be overridden by subclasses to determine the media types programatically.
+ * This method can be overridden by subclasses to determine the media types programmatically.
*
* @return The list of media types. Never <jk>null</jk>.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 b15ab39..9a8ee52 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
@@ -34,6 +34,7 @@ public class ParserBuilder extends CoreObjectBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public ParserBuilder(PropertyStore propertyStore) {
@@ -60,7 +61,8 @@ public class ParserBuilder extends CoreObjectBuilder {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to the POJO.
+ * 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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/parser/ParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/ParserContext.java b/juneau-core/src/main/java/org/apache/juneau/parser/ParserContext.java
index bff9dec..47d2384 100644
--- a/juneau-core/src/main/java/org/apache/juneau/parser/ParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/parser/ParserContext.java
@@ -30,7 +30,8 @@ public class ParserContext extends BeanContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to the POJO.
+ * If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
+ * the POJO.
*/
public static final String PARSER_trimStrings = "Parser.trimStrings";
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 47cfc44..65dcb94 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
@@ -80,8 +80,8 @@ public final class ParserGroup {
* @param propertyStore The modifiable properties that were used to initialize the parsers.
* A snapshot of these will be made so that we can clone and modify this group.
* @param parsers The parsers defined in this group.
- * The order is important because they will be tried in reverse order (e.g.
- * newer first) in which they will be tried to match against media types.
+ * The order is important because they will be tried in reverse order (e.g. newer first) in which they will be tried
+ * to match against media types.
*/
public ParserGroup(PropertyStore propertyStore, Parser[] parsers) {
this.propertyStore = PropertyStore.create(propertyStore);
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java b/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
index 1731af9..27335a6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
@@ -52,6 +52,7 @@ public class ParserGroupBuilder {
/**
* Clone an existing parser group builder.
+ *
* @param copyFrom The parser group that we're copying settings and parsers from.
*/
public ParserGroupBuilder(ParserGroup copyFrom) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/parser/ParserListener.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/ParserListener.java b/juneau-core/src/main/java/org/apache/juneau/parser/ParserListener.java
index dacc587..a870043 100644
--- a/juneau-core/src/main/java/org/apache/juneau/parser/ParserListener.java
+++ b/juneau-core/src/main/java/org/apache/juneau/parser/ParserListener.java
@@ -29,24 +29,29 @@ public class ParserListener {
*
* @param <T> The class type of the bean.
* @param session The parser session.
- * Note that if {@link BeanContext#BEAN_debug} is enabled on the parser, you can get the input as a string through
- * {@link ParserSession#getInputAsString()}.
+ * Note that if {@link BeanContext#BEAN_debug} is enabled on the parser, you can get the input as a string through
+ * {@link ParserSession#getInputAsString()}.
* @param propertyName The property name encountered in the document.
* @param beanClass The bean class.
* @param bean The bean.
- * @param line The line number where the unknown property was found (-1 if parser doesn't support line/column indicators).
- * @param col The column number where the unknown property was found (-1 if parser doesn't support line/column indicators).
+ * @param line The line number where the unknown property was found (-1 if parser doesn't support line/column
+ * indicators).
+ * @param col The column number where the unknown property was found (-1 if parser doesn't support line/column
+ * indicators).
*/
public <T> void onUnknownBeanProperty(ParserSession session, String propertyName, Class<T> beanClass, T bean, int line, int col) {
- onError(session, null, format("Unknown property ''{0}'' encountered while trying to parse into class ''{1}'' at line {2} column {3}", propertyName, beanClass, line, col));
+ onError(session, null,
+ format("Unknown property ''{0}'' encountered while trying to parse into class ''{1}'' at line {2} column {3}",
+ propertyName, beanClass, line, col)
+ );
}
/**
* Called when an error occurs during parsing but is ignored.
*
* @param session The parsers session.
- * Note that if {@link BeanContext#BEAN_debug} is enabled on the parser, you can get the input as a string through
- * {@link ParserSession#getInputAsString()}.
+ * Note that if {@link BeanContext#BEAN_debug} is enabled on the parser, you can get the input as a string through
+ * {@link ParserSession#getInputAsString()}.
* @param t The throwable that was thrown by the getter method.
* @param msg The error message.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/parser/ParserReader.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/ParserReader.java b/juneau-core/src/main/java/org/apache/juneau/parser/ParserReader.java
index fa93caa..c15e65f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/parser/ParserReader.java
+++ b/juneau-core/src/main/java/org/apache/juneau/parser/ParserReader.java
@@ -87,8 +87,8 @@ public class ParserReader extends Reader {
/**
* Reads a single character.
- * Note that this method does NOT process extended unicode characters (i.e. characters
- * above 0x10000), but rather returns them as two <jk>char</jk>s.
+ * Note that this method does NOT process extended unicode characters (i.e. characters above 0x10000), but rather
+ * returns them as two <jk>char</jk>s.
* Use {@link #readCodePoint()} to ensure proper handling of extended unicode.
*
* @return The character read, or -1 if the end of the stream has been reached.
@@ -123,8 +123,7 @@ public class ParserReader extends Reader {
}
/**
- * Same as {@link #read()} but detects and combines extended unicode characters (i.e. characters
- * above 0x10000).
+ * Same as {@link #read()} but detects and combines extended unicode characters (i.e. characters above 0x10000).
*
* @return The character read, or -1 if the end of the stream has been reached.
* @throws IOException If a problem occurred trying to read from the reader.
@@ -362,9 +361,8 @@ public class ParserReader extends Reader {
/**
* Replaces the last character in the marking buffer with the specified character.
- * <code>offset</code> must be at least <code>1</code> for normal characters, and
- * <code>2</code> for extended unicode characters in order for the replacement
- * to fit into the buffer.
+ * <code>offset</code> must be at least <code>1</code> for normal characters, and <code>2</code> for extended
+ * unicode characters in order for the replacement to fit into the buffer.
*
* @param c The new character.
* @param offset The offset.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/parser/ParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/ParserSession.java b/juneau-core/src/main/java/org/apache/juneau/parser/ParserSession.java
index 05f2f8b..40d6114 100644
--- a/juneau-core/src/main/java/org/apache/juneau/parser/ParserSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/parser/ParserSession.java
@@ -56,9 +56,12 @@ public class ParserSession extends BeanSession {
* <li><jk>null</jk>
* <li>{@link Reader}
* <li>{@link CharSequence}
- * <li>{@link InputStream} containing UTF-8 encoded text (or whatever the encoding specified by {@link ParserContext#PARSER_inputStreamCharset}).
- * <li><code><jk>byte</jk>[]</code> containing UTF-8 encoded text (or whatever the encoding specified by {@link ParserContext#PARSER_inputStreamCharset}).
- * <li>{@link File} containing system encoded text (or whatever the encoding specified by {@link ParserContext#PARSER_fileCharset}).
+ * <li>{@link InputStream} containing UTF-8 encoded text (or whatever the encoding specified by
+ * {@link ParserContext#PARSER_inputStreamCharset}).
+ * <li><code><jk>byte</jk>[]</code> containing UTF-8 encoded text (or whatever the encoding specified by
+ * {@link ParserContext#PARSER_inputStreamCharset}).
+ * <li>{@link File} containing system encoded text (or whatever the encoding specified by
+ * {@link ParserContext#PARSER_fileCharset}).
* </ul>
* <br>For byte-based parsers, this can be any of the following types:
* <ul>
@@ -67,6 +70,7 @@ public class ParserSession extends BeanSession {
* <li><code><jk>byte</jk>[]</code>
* <li>{@link File}
* </ul>
+ *
* @param op The override properties.
* These override any context properties defined in the context.
* @param javaMethod The java method that called this parser, usually the method in a REST servlet.
@@ -77,7 +81,8 @@ public class ParserSession extends BeanSession {
* If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
*/
- public ParserSession(ParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public ParserSession(ParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale,
+ TimeZone timeZone, MediaType mediaType) {
super(ctx, op, locale, timeZone, mediaType);
Class<?> listenerClass;
if (op == null || op.isEmpty()) {
@@ -167,9 +172,17 @@ public class ParserSession extends BeanSession {
return reader;
}
if (input instanceof InputStream || input instanceof byte[]) {
- InputStream is = (input instanceof InputStream ? (InputStream)input : new ByteArrayInputStream((byte[])input));
+ InputStream is = (
+ input instanceof InputStream
+ ? (InputStream)input
+ : new ByteArrayInputStream((byte[])input)
+ );
if (noCloseReader == null) {
- CharsetDecoder cd = ("default".equalsIgnoreCase(inputStreamCharset) ? Charset.defaultCharset() : Charset.forName(inputStreamCharset)).newDecoder();
+ CharsetDecoder cd = (
+ "default".equalsIgnoreCase(inputStreamCharset)
+ ? Charset.defaultCharset()
+ : Charset.forName(inputStreamCharset)
+ ).newDecoder();
if (strict) {
cd.onMalformedInput(CodingErrorAction.REPORT);
cd.onUnmappableCharacter(CodingErrorAction.REPORT);
@@ -187,7 +200,11 @@ public class ParserSession extends BeanSession {
}
if (input instanceof File) {
if (reader == null) {
- CharsetDecoder cd = ("default".equalsIgnoreCase(fileCharset) ? Charset.defaultCharset() : Charset.forName(fileCharset)).newDecoder();
+ CharsetDecoder cd = (
+ "default".equalsIgnoreCase(fileCharset)
+ ? Charset.defaultCharset()
+ : Charset.forName(fileCharset)
+ ).newDecoder();
if (strict) {
cd.onMalformedInput(CodingErrorAction.REPORT);
cd.onUnmappableCharacter(CodingErrorAction.REPORT);
@@ -253,6 +270,7 @@ public class ParserSession extends BeanSession {
/**
* Sets the current bean property being parsed for proper error messages.
+ *
* @param currentProperty The current property being parsed.
*/
public void setCurrentProperty(BeanPropertyMeta currentProperty) {
@@ -261,6 +279,7 @@ public class ParserSession extends BeanSession {
/**
* Sets the current class being parsed for proper error messages.
+ *
* @param currentClass The current class being parsed.
*/
public void setCurrentClass(ClassMeta<?> currentClass) {
@@ -289,7 +308,7 @@ public class ParserSession extends BeanSession {
* Trims the specified object if it's a <code>String</code> and {@link #isTrimStrings()} returns <jk>true</jk>.
*
* @param o The object to trim.
- * @return The trimmmed string if it's a string.
+ * @return The trimmed string if it's a string.
*/
@SuppressWarnings("unchecked")
public final <K> K trim(K o) {
@@ -312,14 +331,13 @@ public class ParserSession extends BeanSession {
}
/**
- * Converts the specified <code>ObjectMap</code> into a bean identified by the <js>"_type"</js>
- * property in the map.
+ * Converts the specified <code>ObjectMap</code> into a bean identified by the <js>"_type"</js> property in the map.
*
* @param m The map to convert to a bean.
* @param pMeta The current bean property being parsed.
* @param eType The current expected type being parsed.
- * @return The converted bean, or the same map if the <js>"_type"</js> entry wasn't found
- * or didn't resolve to a bean.
+ * @return The converted bean, or the same map if the <js>"_type"</js> entry wasn't found or didn't resolve to a
+ * bean.
*/
public final Object cast(ObjectMap m, BeanPropertyMeta pMeta, ClassMeta<?> eType) {
@@ -390,16 +408,19 @@ public class ParserSession extends BeanSession {
* @param line The line number where the property was found. <code>-1</code> if line numbers are not available.
* @param col The column number where the property was found. <code>-1</code> if column numbers are not available.
* @throws ParseException Automatically thrown if {@link BeanContext#BEAN_ignoreUnknownBeanProperties} setting
- * on this parser is <jk>false</jk>
+ * on this parser is <jk>false</jk>
* @param <T> The class type of the bean map that doesn't have the expected property.
*/
public <T> void onUnknownProperty(String propertyName, BeanMap<T> beanMap, int line, int col) throws ParseException {
if (propertyName.equals(getBeanTypePropertyName(beanMap.getClassMeta())))
return;
if (! isIgnoreUnknownBeanProperties())
- throw new ParseException(this, "Unknown property ''{0}'' encountered while trying to parse into class ''{1}''", propertyName, beanMap.getClassMeta());
+ throw new ParseException(this,
+ "Unknown property ''{0}'' encountered while trying to parse into class ''{1}''", propertyName,
+ beanMap.getClassMeta());
if (listener != null)
- listener.onUnknownBeanProperty(this, propertyName, beanMap.getClassMeta().getInnerClass(), beanMap.getBean(), line, col);
+ listener.onUnknownBeanProperty(this, propertyName, beanMap.getClassMeta().getInnerClass(), beanMap.getBean(),
+ line, col);
}
/**
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/parser/ReaderParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/ReaderParser.java b/juneau-core/src/main/java/org/apache/juneau/parser/ReaderParser.java
index 12d8677..39aa2b3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/parser/ReaderParser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/parser/ReaderParser.java
@@ -36,6 +36,7 @@ public abstract class ReaderParser extends Parser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
protected ReaderParser(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 ea6b20d..f60953c 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
@@ -70,9 +70,10 @@
<h2 class='topic' onclick='toggle(this)'>1 - Parser API</h2>
<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 {@link org.apache.juneau.parser.ReaderParser}
- or {@link org.apache.juneau.parser.InputStreamParser}.<br>
+ 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
+ {@link org.apache.juneau.parser.ReaderParser} or {@link org.apache.juneau.parser.InputStreamParser}.
</p>
<!-- ======================================================================================================== -->
@@ -80,7 +81,8 @@
<h3 class='topic' onclick='toggle(this)'>1.1 - The ParserGroup class</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.parser.ParserGroup} class represents a group of parser registered with the media types they handle.
+ The {@link org.apache.juneau.parser.ParserGroup} class represents a group of parser registered with the
+ media types they handle.
</p>
<h6 class='topic'>Features</h6>
@@ -106,8 +108,9 @@
<div class='topic'>
<p>
Defining a new parser is quite simple if you subclass directly from {@link org.apache.juneau.parser.ReaderParser}
- or {@link org.apache.juneau.parser.InputStreamParser}. In each case, you simply need to implement a single
- method and specify a {@link org.apache.juneau.annotation.Consumes} annotation.
+ or {@link org.apache.juneau.parser.InputStreamParser}.
+ In each case, you simply need to implement a single method and specify a
+ {@link org.apache.juneau.annotation.Consumes} annotation.
</p>
<p>
The following example shows a simple parser that converts input streams to images using standard JRE classes.
@@ -123,9 +126,10 @@
}
</p>
<p>
- Parsers that take advantage of the entire {@link org.apache.juneau.CoreObject} interface to be able to parse arbitrary beans and POJOs is
- considerably more complex and outside the scope of this document.
- If developing such a parser, the best course of action would be to replicate what occurs in the {@link org.apache.juneau.json.JsonParser} class.
+ Parsers that take advantage of the entire {@link org.apache.juneau.CoreObject} interface to be able to parse
+ arbitrary beans and POJOs is considerably more complex and outside the scope of this document.
+ If developing such a parser, the best course of action would be to replicate what occurs in the
+ {@link org.apache.juneau.json.JsonParser} class.
</p>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextParser.java b/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextParser.java
index 850d320..c0cc95c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextParser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextParser.java
@@ -20,7 +20,8 @@ import org.apache.juneau.parser.*;
import org.apache.juneau.transform.*;
/**
- * Parsers HTTP plain text request bodies into <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">Group 5</a> POJOs.
+ * Parsers HTTP plain text request bodies into <a class="doclink"
+ * href="../../../../overview-summary.html#Core.PojoCategories">Group 5</a> POJOs.
*
* <h5 class='section'>Media types:</h5>
* <p>
@@ -31,9 +32,10 @@ import org.apache.juneau.transform.*;
* <h5 class='section'>Description:</h5>
* <p>
* Essentially just converts plain text to POJOs via static <code>fromString()</code> or <code>valueOf()</code>, or
- * through constructors that take a single string argument.
+ * through constructors that take a single string argument.
* <p>
- * Also parses objects using a transform if the object class has an {@link PojoSwap PojoSwap<?,String>} transform defined on it.
+ * Also parses objects using a transform if the object class has an {@link PojoSwap PojoSwap<?,String>} transform
+ * defined on it.
*
* <h5 class='section'>Configurable properties:</h5>
* <p>
@@ -51,6 +53,7 @@ public class PlainTextParser extends ReaderParser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public PlainTextParser(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextParserBuilder.java
index 3540188..1721d0e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextParserBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextParserBuilder.java
@@ -32,6 +32,7 @@ public class PlainTextParserBuilder extends ParserBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public PlainTextParserBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java b/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java
index 6c0bd31..4f9dd12 100644
--- a/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java
@@ -30,7 +30,8 @@ import org.apache.juneau.transform.*;
* <p>
* Essentially converts POJOs to plain text using the <code>toString()</code> method.
* <p>
- * Also serializes objects using a transform if the object class has an {@link PojoSwap PojoSwap<?,String>} transform defined on it.
+ * Also serializes objects using a transform if the object class has an {@link PojoSwap PojoSwap<?,String>}
+ * transform defined on it.
*
* <h5 class='section'>Configurable properties:</h5>
* <p>
@@ -49,6 +50,7 @@ public class PlainTextSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public PlainTextSerializer(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerBuilder.java
index dd61eeb..56b684d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerBuilder.java
@@ -32,6 +32,7 @@ public class PlainTextSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public PlainTextSerializerBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 d0e8bf9..c896bf4 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
@@ -21,7 +21,8 @@ import java.lang.annotation.*;
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.
+ * 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'>
@@ -35,7 +36,8 @@ 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 <code>RestClient</code>.
+ * <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.
@@ -43,7 +45,7 @@ import org.apache.juneau.serializer.*;
* </ul>
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
- * {@link RequestBean @RequestBean}:
+ * {@link RequestBean @RequestBean}:
* <p>
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -62,7 +64,8 @@ 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='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>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 396eb6f..1468d12 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
@@ -21,7 +21,8 @@ import org.apache.juneau.serializer.*;
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.
+ * 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'>
@@ -31,7 +32,8 @@ import org.apache.juneau.urlencoding.*;
* <jc>// Explicit names specified for form data parameters.</jc>
* <jc>// pojo will be converted to UON notation (unless plain-text parts enabled).</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)
- * String myProxyMethod1(<ja>@FormData</ja>(<js>"foo"</js>)</ja> String foo, <ja>@FormData</ja>(<js>"bar"</js>)</ja> MyPojo pojo);
+ * String myProxyMethod1(<ja>@FormData</ja>(<js>"foo"</js>)</ja> String foo,
+ * <ja>@FormData</ja>(<js>"bar"</js>)</ja> MyPojo pojo);
*
* <jc>// Multiple values pulled from a NameValuePairs object.</jc>
* <jc>// Same as @FormData("*").</jc>
@@ -54,7 +56,7 @@ import org.apache.juneau.urlencoding.*;
* String myProxyMethod5(<ja>@FormData</ja> String string);
*
* <jc>// An entire form-data HTTP body as a Reader.</jc>
- * <jc>// Sames as @FormData("*").</jc>
+ * <jc>// Same as @FormData("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod6"</js>)
* String myProxyMethod6(<ja>@FormData</ja> Reader reader);
*
@@ -62,7 +64,7 @@ import org.apache.juneau.urlencoding.*;
* </p>
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
- * {@link RequestBean @RequestBean}:
+ * {@link RequestBean @RequestBean}:
* <p>
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -112,8 +114,10 @@ import org.apache.juneau.urlencoding.*;
* }
* </p>
* <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:
+ * 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>
* <p class='bcode'>
* <ja>@FormData</ja>(name=<js>"foo"</js>)
@@ -123,7 +127,8 @@ 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='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>
*/
@@ -139,7 +144,7 @@ public @interface FormData {
* Note that {@link #name()} and {@link #value()} are synonyms.
* <p>
* The value should be either <js>"*"</js> to represent multiple name/value pairs, or a label that defines the
- * form data parameter name.
+ * form data parameter name.
* <p>
* A blank value (the default) has the following behavior:
* <ul class='spaced-list'>
@@ -198,7 +203,7 @@ public @interface FormData {
* Specifies the {@link PartSerializer} class used for serializing values to strings.
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean} annotation,
- * then on the client which by default is {@link UrlEncodingSerializer}.
+ * then on the client which by default is {@link UrlEncodingSerializer}.
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 a835ee7..1beafaa 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,7 +25,8 @@ 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='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>
*/
@@ -37,12 +38,14 @@ public @interface FormDataIfNE {
/**
* The form post parameter name.
+ *
* @see FormData#name()
*/
String name() default "";
/**
* A synonym for {@link #name()}.
+ *
* @see FormData#value()
*/
String value() default "";
@@ -51,7 +54,7 @@ public @interface FormDataIfNE {
* Specifies the {@link PartSerializer} class used for serializing values to strings.
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean} annotation,
- * then on the client which by default is {@link UrlEncodingSerializer}.
+ * then on the client which by default is {@link UrlEncodingSerializer}.
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 5dba1df..5d2ebee 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
@@ -21,7 +21,8 @@ import org.apache.juneau.serializer.*;
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.
+ * 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'>
@@ -31,7 +32,8 @@ import org.apache.juneau.urlencoding.*;
* <jc>// Explicit names specified for HTTP headers.</jc>
* <jc>// pojo will be converted to UON notation (unless plain-text parts enabled).</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)
- * String myProxyMethod1(<ja>@Header</ja>(<js>"Foo"</js>)</ja> String foo, <ja>@Header</ja>(<js>"Bar"</js>)</ja> MyPojo pojo);
+ * String myProxyMethod1(<ja>@Header</ja>(<js>"Foo"</js>)</ja> String foo,
+ * <ja>@Header</ja>(<js>"Bar"</js>)</ja> MyPojo pojo);
*
* <jc>// Multiple values pulled from a NameValuePairs object.</jc>
* <jc>// Same as @Header("*").</jc>
@@ -51,7 +53,7 @@ import org.apache.juneau.urlencoding.*;
* </p>
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
- * {@link RequestBean @RequestBean}:
+ * {@link RequestBean @RequestBean}:
* <p>
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -96,8 +98,10 @@ import org.apache.juneau.urlencoding.*;
* }
* </p>
* <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:
+ * 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:
* <p>
* <p class='bcode'>
* <ja>@Header</ja>(name=<js>"Foo"</js>)
@@ -107,7 +111,8 @@ 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='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>
*/
@@ -122,9 +127,8 @@ public @interface Header {
* <p>
* A blank value (the default) indicates to reuse the bean property name when used on a request bean property.
* <p>
- * <p>
* The value should be either <js>"*"</js> to represent multiple name/value pairs, or a label that defines the
- * header name.
+ * header name.
* <p>
* A blank value (the default) has the following behavior:
* <ul class='spaced-list'>
@@ -184,7 +188,7 @@ public @interface Header {
* Specifies the {@link PartSerializer} class used for serializing values to strings.
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean} annotation,
- * then on the client which by default is {@link UrlEncodingSerializer}.
+ * then on the client which by default is {@link UrlEncodingSerializer}.
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 7046582..071c076 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,7 +25,8 @@ 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='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>
*/
@@ -37,12 +38,14 @@ public @interface HeaderIfNE {
/**
* The HTTP header name.
+ *
* @see Header#name()
*/
String name() default "";
/**
* A synonym for {@link #name()}.
+ *
* @see Header#value()
*/
String value() default "";
@@ -51,7 +54,7 @@ public @interface HeaderIfNE {
* Specifies the {@link PartSerializer} class used for serializing values to strings.
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean} annotation,
- * then on the client which by default is {@link UrlEncodingSerializer}.
+ * then on the client which by default is {@link UrlEncodingSerializer}.
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 fa0643f..8144c0b 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
@@ -51,7 +51,7 @@ import org.apache.juneau.urlencoding.*;
* </p>
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
- * {@link RequestBean @RequestBean}:
+ * {@link RequestBean @RequestBean}:
* <p>
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -96,8 +96,10 @@ import org.apache.juneau.urlencoding.*;
* }
* </p>
* <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:
+ * 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:
* <p>
* <p class='bcode'>
* <ja>@Path</ja>(name=<js>"foo"</js>)
@@ -107,7 +109,8 @@ 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='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>
*/
@@ -123,7 +126,7 @@ public @interface Path {
* Note that {@link #name()} and {@link #value()} are synonyms.
* <p>
* The value should be either <js>"*"</js> to represent multiple name/value pairs, or a label that defines the
- * path variable name.
+ * path variable name.
* <p>
* A blank value (the default) has the following behavior:
* <ul class='spaced-list'>
@@ -173,7 +176,7 @@ public @interface Path {
* Specifies the {@link PartSerializer} class used for serializing values to strings.
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean} annotation,
- * then on the client which by default is {@link UrlEncodingSerializer}.
+ * then on the client which by default is {@link UrlEncodingSerializer}.
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 6126408..97dbfbb 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
@@ -21,7 +21,8 @@ import org.apache.juneau.serializer.*;
import org.apache.juneau.urlencoding.*;
/**
- * Annotation applied to Java method arguments of interface proxies to denote that they are QUERY parameters on the request.
+ * 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'>
@@ -31,7 +32,8 @@ import org.apache.juneau.urlencoding.*;
* <jc>// Explicit names specified for query parameters.</jc>
* <jc>// pojo will be converted to UON notation (unless plain-text parts enabled).</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)
- * String myProxyMethod1(<ja>@Query</ja>(<js>"foo"</js>)</ja> String foo, <ja>@Query</ja>(<js>"bar"</js>)</ja> MyPojo pojo);
+ * String myProxyMethod1(<ja>@Query</ja>(<js>"foo"</js>)</ja> String foo,
+ * <ja>@Query</ja>(<js>"bar"</js>)</ja> MyPojo pojo);
*
* <jc>// Multiple values pulled from a NameValuePairs object.</jc>
* <jc>// Same as @Query("*").</jc>
@@ -61,7 +63,7 @@ import org.apache.juneau.urlencoding.*;
* </p>
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
- * {@link RequestBean @RequestBean}:
+ * {@link RequestBean @RequestBean}:
* <p>
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -111,8 +113,10 @@ import org.apache.juneau.urlencoding.*;
* }
* </p>
* <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:
+ * 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>
* <p class='bcode'>
* <ja>@Query</ja>(name=<js>"foo"</js>)
@@ -122,7 +126,8 @@ 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='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>
*/
@@ -138,7 +143,7 @@ public @interface Query {
* Note that {@link #name()} and {@link #value()} are synonyms.
* <p>
* The value should be either <js>"*"</js> to represent multiple name/value pairs, or a label that defines the
- * query parameter name.
+ * query parameter name.
* <p>
* A blank value (the default) has the following behavior:
* <ul class='spaced-list'>
@@ -197,7 +202,7 @@ public @interface Query {
* Specifies the {@link PartSerializer} class used for serializing values to strings.
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean} annotation,
- * then on the client which by default is {@link UrlEncodingSerializer}.
+ * then on the client which by default is {@link UrlEncodingSerializer}.
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 7e8e6a9..cec1aea 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,7 +25,8 @@ 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='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>
*/
@@ -37,12 +38,14 @@ public @interface QueryIfNE {
/**
* The query parameter name.
+ *
* @see Query#name()
*/
String name() default "";
/**
* A synonym for {@link #name()}.
+ *
* @see Query#value()
*/
String value() default "";
@@ -51,7 +54,7 @@ public @interface QueryIfNE {
* Specifies the {@link PartSerializer} class used for serializing values to strings.
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean} annotation,
- * then on the client which by default is {@link UrlEncodingSerializer}.
+ * then on the client which by default is {@link UrlEncodingSerializer}.
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 0169033..911f4f7 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
@@ -21,20 +21,22 @@ import java.lang.annotation.*;
/**
* Annotation applied to Java methods on interface proxy classes.
* <p>
- * TODO <i>(sorry)</i>
- * <p>
* 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 error HTTP status is returned.
- * <li>Any parsable POJO - The body of the response will be converted to the POJO using the parser defined on the <code>RestClient</code>.
- * <li><code>HttpResponse</code> - Returns the raw <code>HttpResponse</code> returned by the inner <code>HttpClient</code>.
+ * <li><jk>void</jk> - Don't parse any response. Note that the method will still throw an exception if an error
+ * HTTP status is returned.
+ * <li>Any parsable POJO - The body of the response will be converted to the POJO using the parser defined on the
+ * <code>RestClient</code>.
+ * <li><code>HttpResponse</code> - Returns the raw <code>HttpResponse</code> returned by the inner
+ * <code>HttpClient</code>.
* <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>
*
* <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='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>
*/
@@ -47,10 +49,10 @@ public @interface RemoteMethod {
/**
* The path to the REST service for this Java method relative to the parent proxy interface URL.
* <p>
- * The default value is the Java method name (e.g. <js>"http://localhost/root-url/org.foo.MyInterface/myMethod"</js>) if
- * {@link Remoteable#methodPaths() @Remoteable.methodPaths()} is <js>"NAME"</js>, or the Java method signature
- * (e.g. <js>"http://localhost/root-url/org.foo.MyInterface/myMethod(int,boolean,java.lang.String)"</js>) if
- * it's <js>"SIGNATURE"</js>.
+ * The default value is the Java method name (e.g. <js>"http://localhost/root-url/org.foo.MyInterface/myMethod"</js>)
+ * if {@link Remoteable#methodPaths() @Remoteable.methodPaths()} is <js>"NAME"</js>, or the Java method signature
+ * (e.g. <js>"http://localhost/root-url/org.foo.MyInterface/myMethod(int,boolean,java.lang.String)"</js>) if
+ * it's <js>"SIGNATURE"</js>.
*/
String path() default "";
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 140d9f8..00f58dd 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,7 +22,8 @@ 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='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>
*/
@@ -47,9 +48,9 @@ public class RemoteMethodArg {
* @param name2 The argument name pulled from value().
* @param index The zero-based index of the argument on the Java method.
* @param skipIfNE The value is skipped if it's null/empty.
- * @param serializer The class to use for serializing headers, query paramters, form-data parameters, and
- * path variables.
- * If {@link UrlEncodingSerializer}, then the url-encoding serializer defined on the client will be used.
+ * @param serializer The class to use for serializing headers, query parameters, form-data parameters, and
+ * path variables.
+ * If {@link UrlEncodingSerializer}, then the url-encoding serializer defined on the client will be used.
*/
protected RemoteMethodArg(String name, String name2, int index, boolean skipIfNE, Class<? extends PartSerializer> serializer) {
this.name = name.isEmpty() ? name2 : name;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 2ee97fd..788a04e 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
@@ -23,7 +23,8 @@ 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='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>
*/
@@ -39,7 +40,8 @@ public @interface Remoteable {
* When a relative path is specified, it's relative to the root-url defined on the <code>RestClient</code> used
* to instantiate the interface.
* <p>
- * When no path is specified, the path is assumed to be the class name (e.g. <js>"http://localhost/root-url/org.foo.MyInterface"</js>)
+ * When no path is specified, the path is assumed to be the class name (e.g.
+ * <js>"http://localhost/root-url/org.foo.MyInterface"</js>)
*/
String path() default "";
@@ -48,7 +50,8 @@ public @interface Remoteable {
* <p>
* The options are:
* <ul>
- * <li><js>"DECLARED"</js> (default) - Only methods declared on the immediate interface/class are exposed. Methods on parent interfaces/classes are ignored.
+ * <li><js>"DECLARED"</js> (default) - Only methods declared on the immediate interface/class are exposed.
+ * Methods on parent interfaces/classes are ignored.
* <li><js>"ANNOTATED"</js> - Only methods annotated with {@link RemoteMethod} are exposed.
* <li><js>"ALL"</js> - All methods defined on the interface or class are exposed.
* </ul>
@@ -56,7 +59,8 @@ public @interface Remoteable {
String expose() default "DECLARED";
/**
- * Defines the methodology to use for the path names of the methods when not explicitly defined via {@link RemoteMethod#path() @RemoteMethod.path()}.
+ * Defines the methodology to use for the path names of the methods when not explicitly defined via
+ * {@link RemoteMethod#path() @RemoteMethod.path()}.
* <p>
* The options are:
* <ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 60da20a..461cc1d 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,7 +27,8 @@ 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='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>
*/
[16/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html
index 1551244..17f1d36 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html
@@ -71,11 +71,15 @@
<h2 class='topic' onclick='toggle(this)'>1 - Overview</h2>
<div class='topic'>
<p>
- Juneau supports serializing and parsing of JSON-Schema documents through the use of beans defined in the <code>org.apache.juneau.dto.jsonschema</code> package.<br>
- These beans are used with the existing {@link org.apache.juneau.json.JsonSerializer} and {@link org.apache.juneau.json.JsonParser} classes to produce and consume JSON-Schema documents.
+ Juneau supports serializing and parsing of JSON-Schema documents through the use of beans defined in the
+ <code>org.apache.juneau.dto.jsonschema</code> package.
+ <br>
+ These beans are used with the existing {@link org.apache.juneau.json.JsonSerializer} and
+ {@link org.apache.juneau.json.JsonParser} classes to produce and consume JSON-Schema documents.
</p>
<p>
- <b>NOTE:</b> JSON-Schema is currently in draft form. This API may change as the JSON-Schema specification changes.
+ <b>NOTE:</b> JSON-Schema is currently in draft form.
+ This API may change as the JSON-Schema specification changes.
</p>
<!-- ======================================================================================================== -->
@@ -101,10 +105,12 @@
<js>"minimum"</js>: 0
},
<js>"positiveIntegerDefault0"</js>: {
- <js>"allOf"</js>: [ { <js>"$ref"</js>: <js>"#/definitions/positiveInteger"</js> }, { <js>"default"</js>: 0 } ]
+ <js>"allOf"</js>: [ { <js>"$ref"</js>: <js>"#/definitions/positiveInteger"</js> },
+ { <js>"default"</js>: 0 } ]
},
<js>"simpleTypes"</js>: {
- <js>"enum"</js>: [ <js>"array"</js>, <js>"boolean"</js>, <js>"integer"</js>, <js>"null"</js>, <js>"number"</js>, <js>"object"</js>, <js>"string"</js> ]
+ <js>"enum"</js>: [ <js>"array"</js>, <js>"boolean"</js>, <js>"integer"</js>, <js>"null"</js>,
+ <js>"number"</js>, <js>"object"</js>, <js>"string"</js> ]
},
<js>"stringArray"</js>: {
<js>"type"</js>: <js>"array"</js>,
@@ -242,8 +248,10 @@
</p>
<ul class='spaced-list'>
<li>{@link org.apache.juneau.dto.jsonschema.Schema} - Top level schema object.
- <li>{@link org.apache.juneau.dto.jsonschema.SchemaProperty} - A subclass of <code>Schema</code> for representing properties.
- <li>{@link org.apache.juneau.dto.jsonschema.SchemaPropertySimpleArray} - A convenience subclass of <code>SchemaProperty</code> for representing properties of simple array types.
+ <li>{@link org.apache.juneau.dto.jsonschema.SchemaProperty} - A subclass of <code>Schema</code> for
+ representing properties.
+ <li>{@link org.apache.juneau.dto.jsonschema.SchemaPropertySimpleArray} - A convenience subclass of
+ <code>SchemaProperty</code> for representing properties of simple array types.
<li>{@link org.apache.juneau.dto.jsonschema.SchemaRef} - Represents a URI reference to another schema.
<li>{@link org.apache.juneau.dto.jsonschema.SchemaArray} - An array of <code>Schema</code> objects.
<li>{@link org.apache.juneau.dto.jsonschema.JsonType} - An enum of possible JSON data types.
@@ -392,7 +400,8 @@
<h4 class='topic' onclick='toggle(this)'>1.2.1 - Serializing to other data types</h4>
<div class='topic'>
<p>
- Since the JSON-Schema DTOs are simple beans, they can be used to serialize to a variety of other language types as well as JSON.
+ Since the JSON-Schema DTOs are simple beans, they can be used to serialize to a variety of other
+ language types as well as JSON.
This also allows JSON-Schema documents to be easily served up using the Juneau REST API.
</p>
<p>
@@ -462,14 +471,15 @@
}
</p>
<p>
- When you point your browser to this resource, the default content type is HTML (since that's what the browser asks for
- by default).
+ When you point your browser to this resource, the default content type is HTML (since that's what the
+ browser asks for by default).
</p>
<h6 class='figure'>HTML</h6>
<img class='bordered' src="doc-files/Example_Html.png">
<p>
- The REST API allows you to specify the <code>Accept</code> header as a GET parameter, and the <code>plainText=true</code>
- parameter forces the returned <code>Content-Type</code> to be <code>text/plain</code>.
+ The REST API allows you to specify the <code>Accept</code> header as a GET parameter, and the
+ <code>plainText=true</code> parameter forces the returned <code>Content-Type</code> to be
+ <code>text/plain</code>.
We'll use this to view the JSON-Schema document in other languages.
</p>
@@ -489,7 +499,8 @@
<img class='bordered' src="doc-files/Example_Turtle.png">
<p>
- The full list of options for this resource can be accessed by the <code>options</code> link on the HTML page.
+ The full list of options for this resource can be accessed by the <code>options</code> link on the HTML
+ page.
</p>
<h6 class='figure'>Resource Options</h6>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
index 54102a8..85f8c04 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
@@ -34,7 +34,8 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
index 2679755..eb84844 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
@@ -33,7 +33,8 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -52,7 +53,8 @@ public class ExternalDocumentation extends SwaggerElement {
* <p>
* A short description of the target documentation. GFM syntax can be used for rich text representation.
*
- * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getDescription() {
return description;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
index 434598b..5ae1939 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
@@ -32,7 +32,8 @@ import org.apache.juneau.json.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -76,7 +77,8 @@ public class HeaderInfo extends SwaggerElement {
* <p>
* A short description of the header.
*
- * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getDescription() {
return description;
@@ -109,7 +111,8 @@ public class HeaderInfo extends SwaggerElement {
* Bean property getter: <property>type</property>.
* <p>
* Required. The type of the object.
- * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <js>"array"</js>.
+ * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <
+ * js>"array"</js>.
*
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -121,14 +124,17 @@ public class HeaderInfo extends SwaggerElement {
* Bean property setter: <property>type</property>.
* <p>
* Required. The type of the object.
- * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <js>"array"</js>.
+ * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
+ * <js>"array"</js>.
*
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
public HeaderInfo setType(String type) {
if (isStrict() && ! contains(type, VALID_TYPES))
- throw new RuntimeException("Invalid value passed in to setType(String). Value='"+type+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
+ throw new RuntimeException(
+ "Invalid value passed in to setType(String). Value='"+type+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
this.type = type;
return this;
}
@@ -146,7 +152,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
* <p>
- * The extending format for the previously mentioned <code>type</code>. See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * The extending format for the previously mentioned <code>type</code>. See <a class="doclink"
+ * href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
*
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -157,7 +164,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
* <p>
- * The extending format for the previously mentioned <code>type</code>. See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * The extending format for the previously mentioned <code>type</code>. See <a class="doclink"
+ * href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
*
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
@@ -254,7 +262,9 @@ public class HeaderInfo extends SwaggerElement {
*/
public HeaderInfo setCollectionFormat(String collectionFormat) {
if (isStrict() && ! contains(collectionFormat, VALID_COLLECTION_FORMATS))
- throw new RuntimeException("Invalid value passed in to setCollectionFormat(String). Value='"+collectionFormat+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_COLLECTION_FORMATS));
+ throw new RuntimeException(
+ "Invalid value passed in to setCollectionFormat(String). Value='"+collectionFormat+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_COLLECTION_FORMATS));
this.collectionFormat = collectionFormat;
return this;
}
@@ -274,7 +284,8 @@ public class HeaderInfo extends SwaggerElement {
* <p>
* Declares the value of the header that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
* Unlike JSON Schema this value MUST conform to the defined <code>type</code> for the header.
*
* @return The value of the <property>_default</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -288,7 +299,8 @@ public class HeaderInfo extends SwaggerElement {
* <p>
* Declares the value of the header that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
* Unlike JSON Schema this value MUST conform to the defined <code>type</code> for the header.
*
* @param _default The new value for the <property>_default</property> property on this bean.
@@ -312,7 +324,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>maximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
* @return The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -323,7 +336,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>maximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
@@ -346,9 +360,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
- * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMaximum() {
return exclusiveMaximum;
@@ -357,7 +373,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMaximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
@@ -380,7 +397,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>minimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
* @return The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -391,7 +409,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>minimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
@@ -414,9 +433,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
- * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMinimum() {
return exclusiveMinimum;
@@ -425,7 +446,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMinimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
@@ -448,7 +470,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
*
* @return The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -459,7 +482,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
*
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
@@ -482,7 +506,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>minLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
*
* @return The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -493,7 +518,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>minLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
*
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
@@ -515,7 +541,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>pattern</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
*
* @return The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -526,7 +553,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
*
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
@@ -549,7 +577,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
*
* @return The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -560,7 +589,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
*
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
@@ -583,7 +613,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>minItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
*
* @return The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -594,7 +625,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>minItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
*
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
@@ -617,7 +649,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
*
* @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -628,7 +661,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>uniqueItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
*
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
@@ -651,7 +685,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @return The value of the <property>enum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -662,7 +697,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
@@ -675,7 +711,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @param _enum The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -709,7 +746,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>multipleOf</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
*
* @return The value of the <property>multipleOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -720,7 +758,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>multipleOf</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
*
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
index 20676d8..98476f5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
@@ -15,7 +15,8 @@ package org.apache.juneau.dto.swagger;
import org.apache.juneau.annotation.*;
/**
- * The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.
+ * The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented
+ * in the Swagger-UI for convenience.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -38,7 +39,8 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -95,7 +97,8 @@ public class Info extends SwaggerElement {
* <p>
* A short description of the application. GFM syntax can be used for rich text representation.
*
- * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getDescription() {
return description;
@@ -129,7 +132,8 @@ public class Info extends SwaggerElement {
* <p>
* The Terms of Service for the API.
*
- * @return The value of the <property>termsOfService</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>termsOfService</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getTermsOfService() {
return termsOfService;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
index ca63e71..538c3c7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
@@ -32,7 +32,8 @@ import org.apache.juneau.json.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -74,7 +75,8 @@ public class Items extends SwaggerElement {
* Bean property getter: <property>type</property>.
* <p>
* Required. The internal type of the array.
- * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <js>"array"</js>.
+ * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
+ * <js>"array"</js>.
*
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -86,14 +88,17 @@ public class Items extends SwaggerElement {
* Bean property setter: <property>type</property>.
* <p>
* Required. The internal type of the array.
- * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <js>"array"</js>.
+ * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
+ * <js>"array"</js>.
*
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
public Items setType(String type) {
if (isStrict() && ! contains(type, VALID_TYPES))
- throw new RuntimeException("Invalid value passed in to setType(String). Value='"+type+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
+ throw new RuntimeException(
+ "Invalid value passed in to setType(String). Value='"+type+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
this.type = type;
return this;
}
@@ -111,7 +116,8 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
* <p>
- * The extending format for the previously mentioned <code>type</code>. See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * The extending format for the previously mentioned <code>type</code>. See <a class="doclink"
+ * href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
*
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -122,7 +128,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
* <p>
- * The extending format for the previously mentioned <code>type</code>. See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * The extending format for the previously mentioned <code>type</code>. See <a class="doclink"
+ * href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
*
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
@@ -193,7 +200,8 @@ public class Items extends SwaggerElement {
* <p>
* Default value is <code>csv</code>.
*
- * @return The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public String getCollectionFormat() {
return collectionFormat;
@@ -219,7 +227,9 @@ public class Items extends SwaggerElement {
*/
public Items setCollectionFormat(String collectionFormat) {
if (isStrict() && ! contains(collectionFormat, VALID_COLLECTION_FORMATS))
- throw new RuntimeException("Invalid value passed in to setCollectionFormat(String). Value='"+collectionFormat+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_COLLECTION_FORMATS));
+ throw new RuntimeException(
+ "Invalid value passed in to setCollectionFormat(String). Value='"+collectionFormat+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_COLLECTION_FORMATS));
this.collectionFormat = collectionFormat;
return this;
}
@@ -239,7 +249,8 @@ public class Items extends SwaggerElement {
* <p>
* Declares the value of the item that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
* Unlike JSON Schema this value MUST conform to the defined <code>type</code> for the data type.
*
* @return The value of the <property>default</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -253,7 +264,8 @@ public class Items extends SwaggerElement {
* <p>
* Declares the value of the item that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
* Unlike JSON Schema this value MUST conform to the defined <code>type</code> for the data type.
*
* @param _default The new value for the <property>default</property> property on this bean.
@@ -277,7 +289,8 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>maximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
* @return The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -288,7 +301,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>maximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
@@ -311,9 +325,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
- * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMaximum() {
return exclusiveMaximum;
@@ -322,7 +338,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMaximum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
*
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
@@ -345,7 +362,8 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>minimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
* @return The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -356,7 +374,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>minimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
@@ -379,9 +398,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
- * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMinimum() {
return exclusiveMinimum;
@@ -390,7 +411,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMinimum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
*
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
@@ -413,7 +435,8 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>maxLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
*
* @return The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -424,7 +447,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>maxLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
*
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
@@ -447,7 +471,8 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>minLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
*
* @return The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -458,7 +483,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>minLength</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
*
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
@@ -481,7 +507,8 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>pattern</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
*
* @return The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -492,7 +519,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
*
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
@@ -515,7 +543,8 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>maxItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
*
* @return The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -526,7 +555,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>maxItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
*
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
@@ -549,7 +579,8 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>minItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
*
* @return The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -560,7 +591,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>minItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
*
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
@@ -583,9 +615,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
*
- * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Boolean getUniqueItems() {
return uniqueItems;
@@ -594,7 +628,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>uniqueItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
*
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
@@ -617,7 +652,8 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @return The value of the <property>enum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -628,7 +664,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
@@ -641,7 +678,8 @@ public class Items extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @param _enum The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -676,7 +714,8 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>multipleOf</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
*
* @return The value of the <property>multipleOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -687,7 +726,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>multipleOf</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
*
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
index 13cef34..9fcc469 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
@@ -33,7 +33,8 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
index c374772..f9d65b6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
@@ -80,7 +80,8 @@ import org.apache.juneau.http.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
* </ul>
@@ -222,9 +223,11 @@ public class Operation extends SwaggerElement {
* Bean property getter: <property>description</property>.
* <p>
* A verbose explanation of the operation behavior.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
- * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getDescription() {
return description;
@@ -234,7 +237,8 @@ public class Operation extends SwaggerElement {
* Bean property setter: <property>description</property>.
* <p>
* A verbose explanation of the operation behavior.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
@@ -259,7 +263,8 @@ public class Operation extends SwaggerElement {
* <p>
* Additional external documentation for this operation.
*
- * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public ExternalDocumentation getExternalDocs() {
return externalDocs;
@@ -292,9 +297,11 @@ public class Operation extends SwaggerElement {
* Bean property getter: <property>operationId</property>.
* <p>
* Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
- * Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
+ * Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
+ * follow common programming naming conventions.
*
- * @return The value of the <property>operationId</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>operationId</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getOperationId() {
return operationId;
@@ -304,7 +311,8 @@ public class Operation extends SwaggerElement {
* Bean property setter: <property>operationId</property>.
* <p>
* Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
- * Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
+ * Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
+ * follow common programming naming conventions.
*
* @param operationId The new value for the <property>operationId</property> property on this bean.
* @return This object (for method chaining).
@@ -330,7 +338,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink"
+ * href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
*
* @return The value of the <property>consumes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -344,7 +353,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink"
+ * href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
*
* @param consumes The new value for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
@@ -360,7 +370,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink"
+ * href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
*
* @param consumes The new values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
@@ -375,7 +386,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink"
+ * href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
*
* @param consumes The new values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
@@ -415,7 +427,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink"
+ * href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
*
* @return The value of the <property>produces</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -429,7 +442,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink"
+ * href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
*
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
@@ -445,7 +459,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink"
+ * href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
*
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
@@ -465,7 +480,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can produces.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink"
+ * href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
*
* @param produces The new values to add to the <property>produces</property> property on this bean.
* @return This object (for method chaining).
@@ -503,10 +519,15 @@ public class Operation extends SwaggerElement {
* Bean property getter: <property>parameters</property>.
* <p>
* A list of parameters that are applicable for this operation.
- * If a parameter is already defined at the <a class="doclink" href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it, but can never remove it.
+ * If a parameter is already defined at the <a class="doclink"
+ * href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it,
+ * but can never remove it.
* The list MUST NOT include duplicated parameters.
* A unique parameter is defined by a combination of a <code>name</code> and <code>location</code>.
- * The list can use the <a class="doclink" href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
+ * The list can use the <a class="doclink"
+ * href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are
+ * defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's
+ * parameters</a>.
* There can be one <js>"body"</js> parameter at most.
*
* @return The value of the <property>parameters</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -519,10 +540,15 @@ public class Operation extends SwaggerElement {
* Bean property setter: <property>parameters</property>.
* <p>
* A list of parameters that are applicable for this operation.
- * If a parameter is already defined at the <a class="doclink" href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it, but can never remove it.
+ * If a parameter is already defined at the <a class="doclink"
+ * href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it,
+ * but can never remove it.
* The list MUST NOT include duplicated parameters.
* A unique parameter is defined by a combination of a <code>name</code> and <code>location</code>.
- * The list can use the <a class="doclink" href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
+ * The list can use the <a class="doclink"
+ * href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are
+ * defined at the <a class="doclink"
+ * href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
* There can be one <js>"body"</js> parameter at most.
*
* @param parameters The new value for the <property>parameters</property> property on this bean.
@@ -537,10 +563,15 @@ public class Operation extends SwaggerElement {
* Bean property adder: <property>parameters</property>.
* <p>
* A list of parameters that are applicable for this operation.
- * If a parameter is already defined at the <a class="doclink" href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it, but can never remove it.
+ * If a parameter is already defined at the <a class="doclink"
+ * href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it,
+ * but can never remove it.
* The list MUST NOT include duplicated parameters.
* A unique parameter is defined by a combination of a <code>name</code> and <code>location</code>.
- * The list can use the <a class="doclink" href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
+ * The list can use the <a class="doclink"
+ * href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are
+ * defined at the <a class="doclink"
+ * href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
* There can be one <js>"body"</js> parameter at most.
*
* @param parameters The new value to add to the <property>parameters</property> property on this bean.
@@ -745,7 +776,8 @@ public class Operation extends SwaggerElement {
* Bean property getter: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for this operation.
- * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ * between the security requirements).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
*
@@ -759,7 +791,8 @@ public class Operation extends SwaggerElement {
* Bean property setter: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for this operation.
- * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ * between the security requirements).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
*
@@ -775,7 +808,8 @@ public class Operation extends SwaggerElement {
* Bean property adder: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for this operation.
- * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ * between the security requirements).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
*
@@ -793,7 +827,8 @@ public class Operation extends SwaggerElement {
* Synonym for {@link #addSecurity(Map)}.
*
* @param scheme The security scheme that applies to this operation
- * @param alternatives The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * @param alternatives The list of values describes alternative security schemes that can be used (that is, there is
+ * a logical OR between the security requirements).
* @return This object (for method chaining).
*/
public Operation security(String scheme, String...alternatives) {
[20/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
index 2b4b115..4dc2ea5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#the-caption-element"><caption></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/tabular-data.html#the-caption-element"><caption></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
index 4756af8..2121e6e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-cite-element"><cite></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-cite-element"><cite></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
index fef7fdd..23a1dd0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-code-element"><code></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-code-element"><code></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
index c9ecd56..87d9476 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#the-col-element"><col></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/tabular-data.html#the-col-element"><col></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Col extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-col-span">span</a> attribute.
* Number of columns spanned by the element.
+ *
* @param span The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
index 414ca45..636efc2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#the-colgroup-element"><colgroup></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/tabular-data.html#the-colgroup-element"><colgroup></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
index d6a3606..8ee1a6b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-data-element"><data></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-data-element"><data></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -30,8 +32,10 @@ import org.apache.juneau.annotation.*;
public class Data extends HtmlElementMixed {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#attr-data-value">value</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#attr-data-value">value</a>
+ * attribute.
* Machine-readable value.
+ *
* @param value The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
index dc76c0f..6b7e79a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-datalist-element"><datalist></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-datalist-element"><datalist></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
index a7d404f..a06b86c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-dd-element"><dd></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-dd-element"><dd></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
index 5a7a139..8f55fd2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#the-del-element"><del></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/edits.html#the-del-element"><del></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Del extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#attr-mod-cite">cite</a> attribute.
* Link to the source of the quotation or more information about the edit.
+ *
* @param cite The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -43,6 +46,7 @@ public class Del extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#attr-mod-datetime">datetime</a> attribute.
* Date and (optionally) time of the change.
+ *
* @param datetime The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
index 85ac4e5..0ccf42f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-dfn-element"><dfn></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-dfn-element"><dfn></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
index 7e42b81..2b2b112 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-div-element"><div></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-div-element"><div></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
index b82b283..47c9417 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-dl-element"><dl></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-dl-element"><dl></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
index fe230bc..2cda82d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-dt-element"><dt></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-dt-element"><dt></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
index 0b5f6e0..46dda70 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-em-element"><em></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-em-element"><em></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
index 1e1e6fa..7f86e84 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-embed-element"><embed></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-embed-element"><embed></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -34,8 +36,10 @@ import org.apache.juneau.annotation.*;
public class Embed extends HtmlElementVoid {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
+ * attribute.
* Vertical dimension.
+ *
* @param height The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -66,6 +70,7 @@ public class Embed extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-embed-type">type</a> attribute.
* Type of embedded resource.
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -77,6 +82,7 @@ public class Embed extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
* Horizontal dimension.
+ *
* @param width The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
index 8d333c4..88844ac 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-fieldset-element"><fieldset></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-fieldset-element"><fieldset></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Fieldset extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fieldset-disabled">disabled</a> attribute.
* Whether the form control is disabled.
+ *
* @param disabled The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -44,6 +47,7 @@ public class Fieldset extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
* Associates the control with a form element.
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -55,6 +59,7 @@ public class Fieldset extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
* Name of form control to use for form submission and in the form.elements API.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
index 08b7034..91c3e98 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-figcaption-element"><figcaption></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-figcaption-element"><figcaption></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
index 667a546..8e58fa6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-figure-element"><figure></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-figure-element"><figure></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
index ed4154a..0487735 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
@@ -20,7 +20,8 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
index e8b517a..5b8935f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-form-element"><form></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-form-element"><form></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -34,8 +36,10 @@ import org.apache.juneau.annotation.*;
public class Form extends HtmlElementMixed {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-form-accept-charset">accept-charset</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-form-accept-charset">accept-charset</a>
+ * attribute.
* Character encodings to use for form submission.
+ *
* @param acceptcharset The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -62,8 +66,10 @@ public class Form extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-form-autocomplete">autocomplete</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-form-autocomplete">autocomplete</a>
+ * attribute.
* Default setting for autofill feature for controls in the form.
+ *
* @param autocomplete The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -75,6 +81,7 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-enctype">enctype</a> attribute.
* Form data set encoding type to use for form submission.
+ *
* @param enctype The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -86,6 +93,7 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-method">method</a> attribute.
* HTTP method to use for form submission.
+ *
* @param method The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -97,6 +105,7 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-form-name">name</a> attribute.
* Name of form to use in the document.forms API.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -108,6 +117,7 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-novalidate">novalidate</a> attribute.
* Bypass form control validation for form submission.
+ *
* @param novalidate The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -120,6 +130,7 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-target">target</a> attribute.
* Browsing context for form submission.
+ *
* @param target The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
index 0f62413..7ce0dbd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h1></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h1></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
index 2b80916..99bd76a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h2></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h2></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
index df2312a..0760915 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h3></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h3></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
index 5491a61..2776e15 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h4></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h4></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
index 5527701..e51c785 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h5></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h5></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
index 3609cd2..fc54e95 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h6></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h6></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
index 5e7c997..8f90aa8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#the-head-element"><head></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/document-metadata.html#the-head-element"><head></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
index fce37e3..9bde6d2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-header-element"><header></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-header-element"><header></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
index f76ba68..46fadac 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-hr-element"><hr></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-hr-element"><hr></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
index d7f471c..84fc1de 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/semantics.html#the-html-element"><html></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/semantics.html#the-html-element"><html></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Html extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/semantics.html#attr-html-manifest">manifest</a> attribute.
* Application cache manifest.
+ *
* @param manifest The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
index 3f8ab2e..978dd95 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
@@ -20,7 +20,8 @@ import org.apache.juneau.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
[12/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 2cef648..18efcf9 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
@@ -65,11 +65,12 @@ public abstract class ConfigFile implements Map<String,Section> {
* @throws SerializeException If the object value could not be converted to a JSON string for some reason.
* @throws UnsupportedOperationException If config file is read only.
*/
- public abstract String put(String sectionName, String sectionKey, Object value, Serializer serializer, boolean encoded, boolean newline) throws SerializeException;
+ public abstract String put(String sectionName, String sectionKey, Object value, Serializer serializer,
+ boolean encoded, boolean newline) throws SerializeException;
/**
- * Identical to {@link #put(String, String, Object, Serializer, boolean, boolean)} except used when the value is a simple string
- * to avoid having to catch a {@link SerializeException}.
+ * Identical to {@link #put(String, String, Object, Serializer, boolean, boolean)} except used when the value is a
+ * simple string to avoid having to catch a {@link SerializeException}.
*
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
@@ -82,7 +83,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
- * Removes an antry from this config file.
+ * Removes an entry from this config file.
*
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
@@ -101,7 +102,7 @@ public abstract class ConfigFile implements Map<String,Section> {
public abstract Set<String> getSectionKeys(String sectionName);
/**
- * Reloads ths config file object from the persisted file contents if the modified timestamp on the file has changed.
+ * Reloads this config file object from the persisted file contents if the modified timestamp on the file has changed.
*
* @return This object (for method chaining).
* @throws IOException If file could not be read, or file is not associated with this object.
@@ -110,7 +111,7 @@ public abstract class ConfigFile implements Map<String,Section> {
public abstract ConfigFile loadIfModified() throws IOException;
/**
- * Loads ths config file object from the persisted file contents.
+ * Loads this config file object from the persisted file contents.
*
* @return This object (for method chaining).
* @throws IOException If file could not be read, or file is not associated with this object.
@@ -119,7 +120,7 @@ public abstract class ConfigFile implements Map<String,Section> {
public abstract ConfigFile load() throws IOException;
/**
- * Loads ths config file object from the specified reader.
+ * Loads this config file object from the specified reader.
*
* @param r The reader to read from.
* @return This object (for method chaining).
@@ -150,7 +151,8 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Adds header comments to the specified section.
* <p>
- * Header comments are defined as lines that start with <jk>"#"</jk> immediately preceding a section header <jk>"[section]"</jk>.
+ * Header comments are defined as lines that start with <jk>"#"</jk> immediately preceding a section header
+ * <jk>"[section]"</jk>.
* These are handled as part of the section itself instead of being interpreted as comments in the previous section.
* <p>
* Header comments can be of the following formats...
@@ -189,7 +191,8 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Converts the specified object to a string.
* <p>
- * The serialized output is identical to LAX JSON (JSON with unquoted attributes) except for the following exceptions:
+ * The serialized output is identical to LAX JSON (JSON with unquoted attributes) except for the following
+ * exceptions:
* <ul>
* <li>Top level strings are not quoted.
* </ul>
@@ -278,18 +281,22 @@ public abstract class ConfigFile implements Map<String,Section> {
* List l = cf.getObject(<js>"MySection/myListOfBeans"</js>, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
*
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
- * List l = cf.getObject(<js>"MySection/my2dListOfStrings"</js>, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
+ * List l = cf.getObject(<js>"MySection/my2dListOfStrings"</js>, LinkedList.<jk>class</jk>,
+ * LinkedList.<jk>class</jk>, String.<jk>class</jk>);
*
* <jc>// Parse into a map of string keys/values.</jc>
- * Map m = cf.getObject(<js>"MySection/myMap"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
+ * Map m = cf.getObject(<js>"MySection/myMap"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>,
+ * String.<jk>class</jk>);
*
* <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
- * Map m = cf.getObject(<js>"MySection/myMapOfListsOfBeans"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);
+ * Map m = cf.getObject(<js>"MySection/myMapOfListsOfBeans"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>,
+ * List.<jk>class</jk>, MyBean.<jk>class</jk>);
* </p>
* <p>
* <code>Collection</code> classes are assumed to be followed by zero or one objects indicating the element type.
* <p>
- * <code>Map</code> classes are assumed to be followed by zero or two meta objects indicating the key and value types.
+ * <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>
@@ -300,10 +307,12 @@ public abstract class ConfigFile implements Map<String,Section> {
*
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
*
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
@@ -317,12 +326,14 @@ public abstract class ConfigFile implements Map<String,Section> {
*
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param parser The parser to use for parsing the object.
- * If <jk>null</jk>, then uses the predefined parser on the config file.
+ * If <jk>null</jk>, then uses the predefined parser on the config file.
* @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
*
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
@@ -348,7 +359,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* MyBean b = cf.getObject(<js>"MySection/myBean"</js>, MyBean.<jk>class</jk>);
*
* <jc>// Parse into a bean array.</jc>
- * MyBean[] ba = cf.getObject(<js>"MySection/myBeanArray"</js>, MyBean[].<jk>class</jk>);
+ * MyBean[] b = cf.getObject(<js>"MySection/myBeanArray"</js>, MyBean[].<jk>class</jk>);
*
* <jc>// Parse into a linked-list of objects.</jc>
* List l = cf.getObject(<js>"MySection/myList"</js>, LinkedList.<jk>class</jk>);
@@ -361,7 +372,8 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param type The object type to create.
* @return The parsed object.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.
+ * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified
+ * type.
* @see BeanSession#getClassMeta(Type,Type...) for argument syntax for maps and collections.
*/
public final <T> T getObject(String key, Class<T> type) throws ParseException {
@@ -374,10 +386,11 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param <T> The class type of the object being created.
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param parser The parser to use for parsing the object.
- * If <jk>null</jk>, then uses the predefined parser on the config file.
+ * If <jk>null</jk>, then uses the predefined parser on the config file.
* @param type The object type to create.
* @return The parsed object.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.
+ * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified
+ * type.
* @see BeanSession#getClassMeta(Type,Type...) for argument syntax for maps and collections.
*/
public final <T> T getObject(String key, Parser parser, Class<T> type) throws ParseException {
@@ -403,11 +416,12 @@ public abstract class ConfigFile implements Map<String,Section> {
}
/**
- * Same as {@link #getObjectWithDefault(String, Object, Class)} but allows you to specify the parser to use to parse the value.
+ * Same as {@link #getObjectWithDefault(String, Object, Class)} but allows you to specify the parser to use to parse
+ * the value.
*
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param parser The parser to use for parsing the object.
- * If <jk>null</jk>, then uses the predefined parser on the config file.
+ * If <jk>null</jk>, then uses the predefined parser on the config file.
* @param def The default value if section or key does not exist.
* @param type The class to convert the value to.
*
@@ -429,11 +443,12 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param def The default value if section or key does not exist.
* @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
- *
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
*/
@@ -442,17 +457,20 @@ public abstract class ConfigFile implements Map<String,Section> {
}
/**
- * Same as {@link #getObjectWithDefault(String, Object, Type, Type...)} but allows you to specify the parser to use to parse the value.
+ * Same as {@link #getObjectWithDefault(String, Object, Type, Type...)} but allows you to specify the parser to use
+ * to parse the value.
*
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param parser The parser to use for parsing the object.
- * If <jk>null</jk>, then uses the predefined parser on the config file.
+ * If <jk>null</jk>, then uses the predefined parser on the config file.
* @param def The default value if section or key does not exist.
* @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
*
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
@@ -472,7 +490,6 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @param c The class to convert the value to.
- *
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or the default value if the section or value doesn't exist.
*/
@@ -488,7 +505,6 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param parser The parser to use for parsing the object.
* If <jk>null</jk>, then uses the predefined parser on the config file.
* @param c The class to convert the value to.
- *
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or the default value if the section or value doesn't exist.
*/
@@ -506,10 +522,12 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
*
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
@@ -519,22 +537,25 @@ public abstract class ConfigFile implements Map<String,Section> {
}
/**
- * Same as {@link #getObject(String, String, Type, Type...)} but allows you to specify the parser to use to parse the value.
+ * Same as {@link #getObject(String, String, Type, Type...)} but allows you to specify the parser to use to parse
+ * the value.
*
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @param parser The parser to use for parsing the object.
- * If <jk>null</jk>, then uses the predefined parser on the config file.
+ * If <jk>null</jk>, then uses the predefined parser on the config file.
* @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
- *
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
*/
- public final <T> T getObject(String sectionName, String sectionKey, Parser parser, Type type, Type...args) throws ParseException {
+ public final <T> T getObject(String sectionName, String sectionKey, Parser parser, Type type, Type...args)
+ throws ParseException {
assertFieldNotNull(sectionName, "sectionName");
assertFieldNotNull(sectionKey, "sectionKey");
return parse(get(sectionName, sectionKey), parser, type, args);
@@ -636,14 +657,16 @@ public abstract class ConfigFile implements Map<String,Section> {
}
/**
- * Adds or replaces an entry with the specified key with a POJO serialized to a string using the registered serializer.
+ * Adds or replaces an entry with the specified key with a POJO serialized to a string using the registered
+ * serializer.
* <p>
* Equivalent to calling <code>put(key, value, isEncoded(key))</code>.
*
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param value The new value POJO.
* @return The previous value, or <jk>null</jk> if the section or key did not previously exist.
- * @throws SerializeException If serializer could not serialize the value or if a serializer is not registered with this config file.
+ * @throws SerializeException If serializer could not serialize the value or if a serializer is not registered with
+ * this config file.
* @throws UnsupportedOperationException If config file is read only.
*/
public final String put(String key, Object value) throws SerializeException {
@@ -656,9 +679,10 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param value The new value POJO.
* @param serializer The serializer to use for serializing the object.
- * If <jk>null</jk>, then uses the predefined serializer on the config file.
+ * If <jk>null</jk>, then uses the predefined serializer on the config file.
* @return The previous value, or <jk>null</jk> if the section or key did not previously exist.
- * @throws SerializeException If serializer could not serialize the value or if a serializer is not registered with this config file.
+ * @throws SerializeException If serializer could not serialize the value or if a serializer is not registered with
+ * this config file.
* @throws UnsupportedOperationException If config file is read only.
*/
public final String put(String key, Object value, Serializer serializer) throws SerializeException {
@@ -674,14 +698,17 @@ public abstract class ConfigFile implements Map<String,Section> {
* 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 each entry.
+ * <li>Arrays and collections of other types are serialized as comma-delimited lists of serialized strings of
+ * each entry.
* </ul>
*
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param value The new value.
- * @param encoded If <jk>true</jk>, value is encoded by the registered encoder when the config file is persisted to disk.
+ * @param encoded If <jk>true</jk>, value is encoded by the registered encoder when the config file is persisted to
+ * disk.
* @return The previous value, or <jk>null</jk> if the section or key did not previously exist.
- * @throws SerializeException If serializer could not serialize the value or if a serializer is not registered with this config file.
+ * @throws SerializeException If serializer could not serialize the value or if a serializer is not registered with
+ * this config file.
* @throws UnsupportedOperationException If config file is read only.
*/
public final String put(String key, Object value, boolean encoded) throws SerializeException {
@@ -689,19 +716,23 @@ public abstract class ConfigFile implements Map<String,Section> {
}
/**
- * Same as {@link #put(String, Object, boolean)} but allows you to specify the serializer to use to serialize the value.
+ * Same as {@link #put(String, Object, boolean)} but allows you to specify the serializer to use to serialize the
+ * value.
*
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param value The new value.
* @param serializer The serializer to use for serializing the object.
- * If <jk>null</jk>, then uses the predefined serializer on the config file.
- * @param encoded If <jk>true</jk>, value is encoded by the registered encoder when the config file is persisted to disk.
+ * If <jk>null</jk>, then uses the predefined serializer on the config file.
+ * @param encoded If <jk>true</jk>, value is encoded by the registered encoder when the config file is persisted
+ * to disk.
* @param newline If <jk>true</jk>, a newline is added to the beginning of the input.
* @return The previous value, or <jk>null</jk> if the section or key did not previously exist.
- * @throws SerializeException If serializer could not serialize the value or if a serializer is not registered with this config file.
+ * @throws SerializeException If serializer could not serialize the value or if a serializer is not registered
+ * with this config file.
* @throws UnsupportedOperationException If config file is read only.
*/
- public final String put(String key, Object value, Serializer serializer, boolean encoded, boolean newline) throws SerializeException {
+ public final String put(String key, Object value, Serializer serializer, boolean encoded, boolean newline)
+ throws SerializeException {
assertFieldNotNull(key, "key");
return put(getSectionName(key), getSectionKey(key), serialize(value, serializer, newline), encoded);
}
@@ -733,16 +764,18 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param sectionName The section name to write from.
* @param bean The bean to set the properties on.
* @param ignoreUnknownProperties If <jk>true</jk>, don't throw an {@link IllegalArgumentException} if this section
- * contains a key that doesn't correspond to a setter method.
+ * contains a key that doesn't correspond to a setter method.
* @param permittedPropertyTypes If specified, only look for setters whose property types
- * are those listed. If not specified, use all setters.
+ * are those listed. If not specified, use all setters.
* @return An object map of the changes made to the bean.
* @throws ParseException If parser was not set on this config file or invalid properties were found in the section.
* @throws IllegalArgumentException
* @throws IllegalAccessException
* @throws InvocationTargetException
*/
- public final ObjectMap writeProperties(String sectionName, Object bean, boolean ignoreUnknownProperties, Class<?>...permittedPropertyTypes) throws ParseException, IllegalArgumentException, IllegalAccessException, InvocationTargetException {
+ public final ObjectMap writeProperties(String sectionName, Object bean, boolean ignoreUnknownProperties,
+ Class<?>...permittedPropertyTypes) throws ParseException, IllegalArgumentException, IllegalAccessException,
+ InvocationTargetException {
assertFieldNotNull(bean, "bean");
ObjectMap om = new ObjectMap();
readLock();
@@ -818,12 +851,13 @@ public abstract class ConfigFile implements Map<String,Section> {
*
* @param sectionName The section name to write from.
* @param c The bean class to create.
- * @param ignoreUnknownProperties If <jk>false</jk>, throws a {@link ParseException} if
- * the section contains an entry that isn't a bean property name.
+ * @param ignoreUnknownProperties If <jk>false</jk>, throws a {@link ParseException} if the section contains an
+ * entry that isn't a bean property name.
* @return A new bean instance.
* @throws ParseException
*/
- public final <T> T getSectionAsBean(String sectionName, Class<T> c, boolean ignoreUnknownProperties) throws ParseException {
+ public final <T> T getSectionAsBean(String sectionName, Class<T> c, boolean ignoreUnknownProperties)
+ throws ParseException {
assertFieldNotNull(c, "c");
readLock();
try {
@@ -949,7 +983,8 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param name The section name.
* @param create Create the section if it's not there.
* @return The section, or <jk>null</jk> if section does not exist.
- * @throws UnsupportedOperationException If config file is read only and section doesn't exist and <code>create</code> is <jk>true</jk>.
+ * @throws UnsupportedOperationException If config file is read only and section doesn't exist and
+ * <code>create</code> is <jk>true</jk>.
*/
protected abstract Section getSection(String name, boolean create);
@@ -1014,7 +1049,7 @@ public abstract class ConfigFile implements Map<String,Section> {
}
/**
- * Same as {@link #serializeTo(Writer)}, except allows you to explicitely specify a format.
+ * Same as {@link #serializeTo(Writer)}, except allows you to explicitly specify a format.
*
* @param out The writer to send the output to.
* @param format The {@link ConfigFileFormat} of the output.
@@ -1035,9 +1070,9 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Merges the contents of the specified config file into this config file.
* <p>
- * Pretty much identical to just replacing this config file, but
- * causes the {@link ConfigFileListener#onChange(ConfigFile, Set)} method to be invoked
- * on differences between the file.
+ * Pretty much identical to just replacing this config file, but causes the
+ * {@link ConfigFileListener#onChange(ConfigFile, Set)} method to be invoked on differences between the file.
+ *
* @param cf The config file whose values should be copied into this config file.
* @return This object (for method chaining).
* @throws UnsupportedOperationException If config file is read only.
@@ -1053,8 +1088,8 @@ public abstract class ConfigFile implements Map<String,Section> {
public abstract String toString();
/**
- * Returns a wrapped instance of this config file where calls to getters
- * have their values first resolved by the specified {@link VarResolver}.
+ * Returns a wrapped instance of this config file where calls to getters have their values first resolved by the
+ * specified {@link VarResolver}.
*
* @param vr The {@link VarResolver} for resolving variables in values.
* @return This config file wrapped in an instance of {@link ConfigFileWrapped}.
@@ -1062,8 +1097,8 @@ public abstract class ConfigFile implements Map<String,Section> {
public abstract ConfigFile getResolving(VarResolver vr);
/**
- * Returns a wrapped instance of this config file where calls to getters
- * have their values first resolved by the specified {@link VarResolverSession}.
+ * Returns a wrapped instance of this config file where calls to getters have their values first resolved by the
+ * specified {@link VarResolverSession}.
*
* @param vs The {@link VarResolverSession} for resolving variables in values.
* @return This config file wrapped in an instance of {@link ConfigFileWrapped}.
@@ -1071,8 +1106,8 @@ public abstract class ConfigFile implements Map<String,Section> {
public abstract ConfigFile getResolving(VarResolverSession vs);
/**
- * Returns a wrapped instance of this config file where calls to getters have their values
- * first resolved by a default {@link VarResolver}.
+ * Returns a wrapped instance of this config file where calls to getters have their values first resolved by a
+ * default {@link VarResolver}.
*
* The default {@link VarResolver} is registered with the following {@link Var StringVars}:
* <ul class='spaced-list'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 0f50328..499dc37 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,23 +224,30 @@ public class ConfigFileBuilder {
* <p>
* Arguments can be any of the following...
* <ul class='spaced-list'>
- * <li>No arguments<br>
- * Prints usage message.<br>
- * <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>
+ * <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.<br>
+ * 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>
+ * 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.<br>
+ * will be converted to underscores.
+ * <br>
* <li><code>setVals -configFile <configFile> -vals [var1=val1 [var2=val2...]] [-verbose]</code>
- * Sets values in config files.<br>
+ * Sets values in config files.
* </ul>
* <p>
- * For example, the following command will create the file <code>'MyConfig.bat'</code> from the contents of the file <code>'MyConfig.cfg'</code>.
+ * For example, the following command will create the file <code>'MyConfig.bat'</code> from the contents of the
+ * file <code>'MyConfig.cfg'</code>.
* <p class='bcode'>
- * java org.apache.juneau.ini.ConfigFileBuilder createBatchEnvFile -configfile C:\foo\MyConfig.cfg -batchfile C:\foo\MyConfig.bat
+ * java org.apache.juneau.ini.ConfigFileBuilder createBatchEnvFile -configfile C:\foo\MyConfig.cfg
+ * -batchfile C:\foo\MyConfig.bat
* </p>
*
* @param args Command-line arguments
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileFormat.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileFormat.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileFormat.java
index 8ccaa06..3000a66 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileFormat.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileFormat.java
@@ -18,6 +18,7 @@ import java.io.*;
* Valid formats that can be passed to the {@link ConfigFile#serializeTo(Writer, ConfigFileFormat)} method.
*/
public enum ConfigFileFormat {
+
/** Normal INI file format*/
INI,
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java
index 838d663..4235099 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java
@@ -75,7 +75,8 @@ public final class ConfigFileImpl extends ConfigFile {
* If <jk>null</jk>, defaults to {@link Charset#defaultCharset()}.
* @throws IOException
*/
- public ConfigFileImpl(File file, boolean readOnly, Encoder encoder, WriterSerializer serializer, ReaderParser parser, Charset charset) throws IOException {
+ public ConfigFileImpl(File file, boolean readOnly, Encoder encoder, WriterSerializer serializer, ReaderParser parser,
+ Charset charset) throws IOException {
this.file = file;
this.encoder = encoder == null ? XorEncoder.INSTANCE : encoder;
this.serializer = serializer == null ? JsonSerializer.DEFAULT : serializer;
@@ -93,7 +94,8 @@ public final class ConfigFileImpl extends ConfigFile {
/**
* Constructor.
- * Shortcut for calling <code><jk>new</jk> ConfigFileImpl(file, <jk>false</jk>, <jk>null</jk>, <jk>null</jk>, <jk>null</jk>, <jk>null</jk>);</code>
+ * Shortcut for calling <code><jk>new</jk> ConfigFileImpl(file, <jk>false</jk>, <jk>null</jk>, <jk>null</jk>,
+ * <jk>null</jk>, <jk>null</jk>);</code>
*
* @param file The config file. Does not need to exist.
* @throws IOException
@@ -104,7 +106,8 @@ public final class ConfigFileImpl extends ConfigFile {
/**
* Constructor.
- * Shortcut for calling <code><jk>new</jk> ConfigFileImpl(<jk>null</jk>, <jk>false</jk>, <jk>null</jk>, <jk>null</jk>, <jk>null</jk>, <jk>null</jk>);</code>
+ * Shortcut for calling <code><jk>new</jk> ConfigFileImpl(<jk>null</jk>, <jk>false</jk>, <jk>null</jk>,
+ * <jk>null</jk>, <jk>null</jk>, <jk>null</jk>);</code>
*
* @throws IOException
*/
@@ -483,7 +486,8 @@ public final class ConfigFileImpl extends ConfigFile {
@SuppressWarnings("hiding")
@Override /* ConfigFile */
- public String put(String sectionName, String sectionKey, Object value, Serializer serializer, boolean encoded, boolean newline) throws SerializeException {
+ public String put(String sectionName, String sectionKey, Object value, Serializer serializer, boolean encoded,
+ boolean newline) throws SerializeException {
assertFieldNotNull(sectionKey, "sectionKey");
Section s = getSection(sectionName, true);
return s.put(sectionKey, serialize(value, serializer, newline), encoded);
@@ -759,7 +763,8 @@ public final class ConfigFileImpl extends ConfigFile {
public ConfigFile getResolving() {
return getResolving(
new VarResolverBuilder()
- .vars(SystemPropertiesVar.class, EnvVariablesVar.class, SwitchVar.class, IfVar.class, ConfigFileVar.class,IfVar.class,SwitchVar.class)
+ .vars(SystemPropertiesVar.class, EnvVariablesVar.class, SwitchVar.class, IfVar.class, ConfigFileVar.class,
+ IfVar.class, SwitchVar.class)
.contextObject(ConfigFileVar.SESSION_config, this)
.build()
);
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
index 6e5df2b..a2a221b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
@@ -252,7 +252,8 @@ public final class ConfigFileWrapped extends ConfigFile {
}
@Override /* ConfigFile */
- public String put(String sectionName, String sectionKey, Object value, Serializer serializer, boolean encoded, boolean newline) throws SerializeException {
+ public String put(String sectionName, String sectionKey, Object value, Serializer serializer, boolean encoded,
+ boolean newline) throws SerializeException {
return cf.put(sectionName, sectionKey, value, serializer, encoded, newline);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/ini/Section.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/Section.java b/juneau-core/src/main/java/org/apache/juneau/ini/Section.java
index 04a516c..39108a3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/Section.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/Section.java
@@ -229,6 +229,7 @@ public class Section implements Map<String,String> {
/**
* Sets the specified value in this section.
+ *
* @param key The section key.
* @param value The new value.
* @param encoded Whether this value should be encoded during save.
@@ -329,6 +330,7 @@ public class Section implements Map<String,String> {
/**
* Adds header comments to this section.
+ *
* @see ConfigFile#addHeaderComments(String, String...) for a description.
* @param comments The comment lines to add to this section.
* @return This object (for method chaining).
@@ -363,6 +365,7 @@ public class Section implements Map<String,String> {
/**
* Serialize this section.
+ *
* @param out What to serialize to.
* @param format The format (e.g. INI, BATCH, SHELL).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/ini/XorEncoder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/XorEncoder.java b/juneau-core/src/main/java/org/apache/juneau/ini/XorEncoder.java
index ae2c0db..0504004 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/XorEncoder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/XorEncoder.java
@@ -25,7 +25,8 @@ public final class XorEncoder implements Encoder {
/** Reusable XOR-Encoder instance. */
public static final XorEncoder INSTANCE = new XorEncoder();
- private static final String key = System.getProperty("org.apache.juneau.ini.XorEncoder.key", "nuy7og796Vh6G9O6bG230SHK0cc8QYkH"); // The super-duper-secret key
+ private static final String key = System.getProperty("org.apache.juneau.ini.XorEncoder.key",
+ "nuy7og796Vh6G9O6bG230SHK0cc8QYkH"); // The super-duper-secret key
@Override /* Encoder */
public String encode(String fieldName, String in) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 fd1d7fd..290c43b 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
@@ -96,7 +96,8 @@
<p>
The {@link org.apache.juneau.ini.ConfigFileBuilder} class is used to instantiate instances of
- {@link org.apache.juneau.ini.ConfigFile} which can then be used to retrieve config file values through either <js>"key"</js> or <js>"Section/key"</js> identifiers.
+ {@link org.apache.juneau.ini.ConfigFile} which can then be used to retrieve config file values through either
+ <js>"key"</js> or <js>"Section/key"</js> identifiers.
</p>
<p class='bcode'>
@@ -220,18 +221,21 @@
<h2 class='topic' onclick='toggle(this)'>2 - Variables</h2>
<div class='topic'>
<p>
- Config files can contain variables that get resolved dynamically using the {@link org.apache.juneau.svl.VarResolver} API.<br>
+ Config files can contain variables that get resolved dynamically using the
+ {@link org.apache.juneau.svl.VarResolver} API.
</p>
<p>
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 set of variables.
- <li>{@link org.apache.juneau.ini.ConfigFile#getResolving(VarResolver)} - Returns a config file that resolves a custom set of variables.
+ <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
+ a custom set of variables.
</ul>
<p>
- The default {@link org.apache.juneau.ini.ConfigFile#getResolving()} method returns a config file that resolves the following
- variables:
+ The default {@link org.apache.juneau.ini.ConfigFile#getResolving()} method returns a config file that resolves
+ the following variables:
</p>
<ul class='spaced-list'>
<li><code>$S{key}</code>, <code>$S{key,default}</code> - System properties.
@@ -251,9 +255,10 @@
</p>
<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>
+ {@link org.apache.juneau.svl.VarResolver VarResolvers}.
+ <br>
For example, the microservice <code>Resource</code> class provides access to config files that
- can contain any of the following variables:
+ can contain any of the following variables:
</p>
<ul>
<li><code>$C</code> - Config variables.
@@ -276,7 +281,8 @@
<div class='topic'>
<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>
+ 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.
</p>
<p>
@@ -298,10 +304,11 @@
<ck>password*</ck> = <cv>{AwwJVhwUQFZEMg==}</cv>
</p>
<p>
- The default encoder is {@link org.apache.juneau.ini.XorEncoder} which is a simple XOR+Base64 encoder.<br>
+ 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}
- interface and creating your own <code>ConfigFileBuilder</code> using the {@link org.apache.juneau.ini.ConfigFileBuilder#encoder(Encoder)}
- method.
+ interface and creating your own <code>ConfigFileBuilder</code> using the
+ {@link org.apache.juneau.ini.ConfigFileBuilder#encoder(Encoder)} method.
</p>
</div>
@@ -345,8 +352,10 @@
<h2 class='topic' onclick='toggle(this)'>5 - Command Line API</h2>
<div class='topic'>
<p>
- 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>
+ 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:
</p>
<p class='bcode'>
@@ -356,21 +365,26 @@
Arguments can be any of the following...
</p>
<ul class='spaced-list'>
- <li>No arguments<br>
+ <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>
+ <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>
+ 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>
Sets values in config files.
</ul>
<p>
- For example, the following command will create the file <code>'MyConfig.bat'</code> from the contents of the file <code>'MyConfig.cfg'</code>.
+ For example, the following command will create the file <code>'MyConfig.bat'</code> from the contents of the
+ file <code>'MyConfig.cfg'</code>.
</p>
<p class='bcode'>
java org.apache.juneau.ini.ConfigFileBuilder createBatchEnvFile -configfile C:\foo\MyConfig.cfg -batchfile C:\foo\MyConfig.bat
@@ -387,9 +401,11 @@
</p>
<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>
+ 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
- at <code>http://localhost:10000/sample/config</code>.<br>
+ at <code>http://localhost:10000/sample/config</code>.
+ <br>
The sample microservice uses the following config file <code>juneau-examples.cfg</code>:
</p>
<p class='bcode'>
@@ -550,8 +566,8 @@
However, it should be noticed that the config file is a VERY powerful feature with many capabilities including:
</p>
<p>
- When you point your browser to this resource, you'll notice that the contents of the config file
- are being serialized to HTML as a POJO:
+ When you point your browser to this resource, you'll notice that the contents of the config file are being
+ serialized to HTML as a POJO:
</p>
<img class='bordered' src="doc-files/config1.png">
<p>
@@ -559,8 +575,8 @@
</p>
<img class='bordered' src="doc-files/config2.png">
<p>
- The code for implementing this page could not be any simpler, since it simply returns the config
- file returned by the <code>RestServlet.getConfig()</code> method.
+ The code for implementing this page could not be any simpler, since it simply returns the config file returned
+ by the <code>RestServlet.getConfig()</code> method.
</p>
<p class='bcode'>
<jd>/**
@@ -583,7 +599,8 @@
contents of the config file in INI format.
</p>
<p>
- Since config files are serializable, that mean they can also be retrieved through the <code>RestClient</code> API.
+ Since config files are serializable, that mean they can also be retrieved through the <code>RestClient</code>
+ API.
</p>
<p class='bcode'>
<jc>// Create a new REST client with JSON support</jc>
@@ -600,16 +617,19 @@
<div class='topic'>
<p>
In the previous example, an edit page was shown that allows you to edit config files through
- a REST interface.<br>
+ a REST interface.
+ <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>
+ 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
trigger listeners when the values are different.
</p>
<p>
- The edit page is implemented with this method which is a simple PUT with the contents of
- the new INI file as the body of the HTTP request:
+ The edit page is implemented with this method which is a simple PUT with the contents of the new INI file as
+ the body of the HTTP request:
</p>
<p class='bcode'>
<jd>/**
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/ArrayUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/ArrayUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/ArrayUtils.java
index 4f1a7d8..4609631 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/ArrayUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/ArrayUtils.java
@@ -158,7 +158,8 @@ public final class ArrayUtils {
/**
* Returns an iterator against an array.
- * This works with any array type (e.g. <code>String[]</code>, <code>Object[]</code>, <code><jk>int</jk>[]</code>, etc...).
+ * This works with any array type (e.g. <code>String[]</code>, <code>Object[]</code>,
+ * <code><jk>int</jk>[]</code>, etc...).
*
* @param array The array to create an iterator over.
* @return An iterator over the specified array.
@@ -206,6 +207,7 @@ public final class ArrayUtils {
/**
* Returns <jk>true</jk> if the specified object is an array.
+ *
* @param array The array to test.
* @return <jk>true</jk> if the specified object is an array.
*/
@@ -218,7 +220,7 @@ public final class ArrayUtils {
*
* @param array The array to convert.
* @param componentType The type of objects in the array.
- * It must match the actual component type in the array.
+ * It must match the actual component type in the array.
* @return A new {@link ArrayList}
*/
@SuppressWarnings("unchecked")
@@ -265,8 +267,8 @@ public final class ArrayUtils {
}
/**
- * Returns <jk>true</jk> if the specified array contains the specified element
- * using the {@link Object#equals(Object)} method.
+ * Returns <jk>true</jk> if the specified array contains the specified element using the
+ * {@link Object#equals(Object)} method.
*
* @param element The element to check for.
* @param array The array to check.
@@ -278,13 +280,12 @@ public final class ArrayUtils {
}
/**
- * Returns the index position of the element in the specified array
- * using the {@link Object#equals(Object)} method.
+ * Returns the index position of the element in the specified array using the {@link Object#equals(Object)} method.
*
* @param element The element to check for.
* @param array The array to check.
* @return The index position of the element in the specified array, or
- * <code>-1</code> if the array doesn't contain the element, or the array or element is <jk>null</jk>.
+ * <code>-1</code> if the array doesn't contain the element, or the array or element is <jk>null</jk>.
*/
public static <T> int indexOf(T element, T[] array) {
if (element == null)
@@ -298,26 +299,25 @@ public final class ArrayUtils {
}
/**
- * Returns <jk>true</jk> if the specified array contains the specified element
- * using the {@link String#equals(Object)} method.
+ * Returns <jk>true</jk> if the specified array contains the specified element using the
+ * {@link String#equals(Object)} method.
*
* @param element The element to check for.
* @param array The array to check.
* @return <jk>true</jk> if the specified array contains the specified element,
- * <jk>false</jk> if the array or element is <jk>null</jk>.
+ * <jk>false</jk> if the array or element is <jk>null</jk>.
*/
public static boolean contains(String element, String[] array) {
return indexOf(element, array) != -1;
}
/**
- * Returns the index position of the element in the specified array
- * using the {@link String#equals(Object)} method.
+ * Returns the index position of the element in the specified array using the {@link String#equals(Object)} method.
*
* @param element The element to check for.
* @param array The array to check.
* @return The index position of the element in the specified array, or
- * <code>-1</code> if the array doesn't contain the element, or the array or element is <jk>null</jk>.
+ * <code>-1</code> if the array doesn't contain the element, or the array or element is <jk>null</jk>.
*/
public static int indexOf(String element, String[] array) {
if (element == null)
@@ -331,7 +331,8 @@ public final class ArrayUtils {
}
/**
- * Converts a primitive wrapper array (e.g. <code>Integer[]</code>) to a primitive array (e.g. <code><jk>int</jk>[]</code>).
+ * Converts a primitive wrapper array (e.g. <code>Integer[]</code>) to a primitive array (e.g.
+ * <code><jk>int</jk>[]</code>).
*
* @param o The array to convert. Must be a primitive wrapper array.
* @return A new array.
@@ -353,6 +354,7 @@ public final class ArrayUtils {
/**
* Converts an Iterable to a list.
+ *
* @param i The iterable to convert.
* @return A new list of objects copied from the iterable.
*/
@@ -369,7 +371,7 @@ public final class ArrayUtils {
*
* @param val The collection or array object.
* @return The first object, or <jk>null</jk> if the collection or array is empty or <jk>null</jk> or the value
- * isn't a collection or array.
+ * isn't a collection or array.
*/
public static Object getFirst(Object val) {
if (val != null) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/ByteArrayCache.java b/juneau-core/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
index 3bf8e44..93b9b67 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
@@ -34,7 +34,7 @@ public class ByteArrayCache {
*
* @param contents The byte array to add to this cache.
* @return Either the same byte array or a previously cached byte array depending on whether the byte array
- * already exists in the cache.
+ * already exists in the cache.
*/
public byte[] cache(byte[] contents) {
if (contents == null)
@@ -49,7 +49,7 @@ public class ByteArrayCache {
*
* @param contents The input stream whose contents are to be added to this cache.
* @return Either the same byte array or a previously cached byte array depending on whether the byte array
- * already exists in the cache.
+ * already exists in the cache.
* @throws IOException
*/
public byte[] cache(InputStream contents) throws IOException {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/ClassUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/ClassUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/ClassUtils.java
index 6a3e812..00b7994 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/ClassUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/ClassUtils.java
@@ -175,7 +175,8 @@ public final class ClassUtils {
/**
* Returns the signature of the specified method.
* For no-arg methods, the signature will be a simple string such as <js>"toString"</js>.
- * For methods with one or more args, the arguments will be fully-qualified class names (e.g. <js>"append(java.util.StringBuilder,boolean)"</js>)
+ * For methods with one or more args, the arguments will be fully-qualified class names (e.g.
+ * <js>"append(java.util.StringBuilder,boolean)"</js>)
*
* @param m The methods to get the signature on.
* @return The methods signature.
@@ -195,7 +196,9 @@ public final class ClassUtils {
return sb.toString();
}
- private final static Map<Class<?>, Class<?>> pmap1 = new HashMap<Class<?>, Class<?>>(), pmap2 = new HashMap<Class<?>, Class<?>>();
+ private final static Map<Class<?>, Class<?>>
+ pmap1 = new HashMap<Class<?>, Class<?>>(),
+ pmap2 = new HashMap<Class<?>, Class<?>>();
static {
pmap1.put(boolean.class, Boolean.class);
pmap1.put(byte.class, Byte.class);
@@ -216,8 +219,8 @@ public final class ClassUtils {
}
/**
- * If the specified class is a primitive (e.g. <code><jk>int</jk>.<jk>class</jk></code>)
- * returns it's wrapper class (e.g. <code>Integer.<jk>class</jk></code>).
+ * If the specified class is a primitive (e.g. <code><jk>int</jk>.<jk>class</jk></code>) returns it's wrapper class
+ * (e.g. <code>Integer.<jk>class</jk></code>).
*
* @param c The class.
* @return The wrapper class, or <jk>null</jk> if class is not a primitive.
@@ -227,8 +230,8 @@ public final class ClassUtils {
}
/**
- * If the specified class is a primitive wrapper (e.g. <code><jk>Integer</jk>.<jk>class</jk></code>)
- * returns it's primitive class (e.g. <code>int.<jk>class</jk></code>).
+ * If the specified class is a primitive wrapper (e.g. <code><jk>Integer</jk>.<jk>class</jk></code>) returns it's
+ * primitive class (e.g. <code>int.<jk>class</jk></code>).
*
* @param c The class.
* @return The primitive class, or <jk>null</jk> if class is not a primitive wrapper.
@@ -238,8 +241,8 @@ public final class ClassUtils {
}
/**
- * If the specified class is a primitive (e.g. <code><jk>int</jk>.<jk>class</jk></code>)
- * returns it's wrapper class (e.g. <code>Integer.<jk>class</jk></code>).
+ * If the specified class is a primitive (e.g. <code><jk>int</jk>.<jk>class</jk></code>) returns it's wrapper class
+ * (e.g. <code>Integer.<jk>class</jk></code>).
*
* @param c The class.
* @return The wrapper class if it's primitive, or the same class if class is not a primitive.
@@ -349,7 +352,7 @@ public final class ClassUtils {
* <p>
* Normally, annotations defined on methods of parent classes and interfaces are not inherited by the child methods.
* This utility method gets around that limitation by searching the class hierarchy for the "same" method
- * (i.e. the same name and arguments).
+ * (i.e. the same name and arguments).
*
* @param a The annotation to search for.
* @param m The method to search.
@@ -363,16 +366,16 @@ public final class ClassUtils {
* Returns the specified annotation on the specified method.
* <p>
* Similar to {@link Method#getAnnotation(Class)}, but searches up the parent hierarchy for the annotation defined
- * on parent classes and interfaces.
+ * on parent classes and interfaces.
* <p>
* Normally, annotations defined on methods of parent classes and interfaces are not inherited by the child methods.
* This utility method gets around that limitation by searching the class hierarchy for the "same" method
- * (i.e. the same name and arguments).
+ * (i.e. the same name and arguments).
*
* @param a The annotation to search for.
* @param c The child class to start searching from.
- * Note that it can be a descendant class of the actual declaring class of the method passed in.
- * This allows you to find annotations on methods overridden by the method passed in.
+ * Note that it can be a descendant class of the actual declaring class of the method passed in.
+ * This allows you to find annotations on methods overridden by the method passed in.
* @param method The method to search.
* @return The annotation, or <jk>null</jk> if it wasn't found.
*/
@@ -518,10 +521,12 @@ public final class ClassUtils {
* @param name The method name.
* @param returnType The return type of the method.
* Can be a super type of the actual return type.
- * For example, if the actual return type is <code>CharSequence</code>, then <code>Object</code> will match but <code>String</code> will not.
+ * For example, if the actual return type is <code>CharSequence</code>, then <code>Object</code> will match but
+ * <code>String</code> will not.
* @param parameterTypes The parameter types of the method.
* Can be subtypes of the actual parameter types.
- * For example, if the parameter type is <code>CharSequence</code>, then <code>String</code> will match but <code>Object</code> will not.
+ * For example, if the parameter type is <code>CharSequence</code>, then <code>String</code> will match but
+ * <code>Object</code> will not.
* @return The matched method, or <jk>null</jk> if no match was found.
*/
public static Method findPublicMethod(Class<?> c, String name, Class<?> returnType, Class<?>...parameterTypes) {
@@ -712,6 +717,7 @@ public final class ClassUtils {
/**
* Returns a {@link MethodInfo} bean that describes the specified method.
+ *
* @param m The method to describe.
* @return The bean with information about the method.
*/
@@ -721,6 +727,7 @@ public final class ClassUtils {
/**
* Returns {@link MethodInfo} beans that describe the specified methods.
+ *
* @param m The methods to describe.
* @return The beans with information about the methods.
*/
@@ -756,7 +763,7 @@ public final class ClassUtils {
*
* @param c The class to cast to.
* @param c2 The class to instantiate.
- * Can also be an instance of the class.
+ * Can also be an instance of the class.
* @param args The arguments to pass to the constructor.
* @return The new class instance, or <jk>null</jk> if the class was <jk>null</jk> or is abstract or an interface.
* @throws RuntimeException if constructor could not be found or called.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/DateUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/DateUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/DateUtils.java
index cd7e637..73b8583 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/DateUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/DateUtils.java
@@ -67,7 +67,6 @@ public final class DateUtils {
*
* @param dateValue the date value to parse
* @param dateFormats the date formats to use
- *
* @return the parsed date or null if input could not be parsed
*/
public static Date parseDate(final String dateValue, final String[] dateFormats) {
@@ -80,9 +79,8 @@ public final class DateUtils {
* @param dateValue the date value to parse
* @param dateFormats the date formats to use
* @param startDate During parsing, two digit years will be placed in the range <code>startDate</code> to
- * <code>startDate + 100 years</code>. This value may be <code>null</code>. When
- * <code>null</code> is given as a parameter, year <code>2000</code> will be used.
- *
+ * <code>startDate + 100 years</code>. This value may be <code>null</code>. When
+ * <code>null</code> is given as a parameter, year <code>2000</code> will be used.
* @return the parsed date or null if input could not be parsed
*/
public static Date parseDate(final String dateValue, final String[] dateFormats, final Date startDate) {
@@ -123,7 +121,6 @@ public final class DateUtils {
*
* @param date The date to format.
* @return An RFC 1123 formatted date string.
- *
* @see #PATTERN_RFC1123
*/
public static String formatDate(final Date date) {
@@ -153,12 +150,13 @@ public final class DateUtils {
}
/**
- * A factory for {@link SimpleDateFormat}s. The instances are stored in a threadlocal way because SimpleDateFormat
- * is not threadsafe as noted in {@link SimpleDateFormat its javadoc}.
+ * A factory for {@link SimpleDateFormat}s. The instances are stored in a thread-local way because SimpleDateFormat
+ * is not thread-safe as noted in {@link SimpleDateFormat its javadoc}.
*
*/
final static class DateFormatHolder {
- private static final ThreadLocal<SoftReference<Map<String,SimpleDateFormat>>> THREADLOCAL_FORMATS = new ThreadLocal<SoftReference<Map<String,SimpleDateFormat>>>() {
+ private static final ThreadLocal<SoftReference<Map<String,SimpleDateFormat>>> THREADLOCAL_FORMATS =
+ new ThreadLocal<SoftReference<Map<String,SimpleDateFormat>>>() {
@Override
protected SoftReference<Map<String,SimpleDateFormat>> initialValue() {
return new SoftReference<Map<String,SimpleDateFormat>>(new HashMap<String,SimpleDateFormat>());
@@ -166,12 +164,12 @@ public final class DateUtils {
};
/**
- * creates a {@link SimpleDateFormat} for the requested format string.
+ * Creates a {@link SimpleDateFormat} for the requested format string.
*
* @param pattern a non-<code>null</code> format String according to {@link SimpleDateFormat}. The format is not
- * checked against <code>null</code> since all paths go through {@link DateUtils}.
- * @return the requested format. This simple dateformat should not be used to
- * {@link SimpleDateFormat#applyPattern(String) apply} to a different pattern.
+ * checked against <code>null</code> since all paths go through {@link DateUtils}.
+ * @return the requested format. This simple date-format should not be used to
+ * {@link SimpleDateFormat#applyPattern(String) apply} to a different pattern.
*/
public static SimpleDateFormat formatFor(final String pattern) {
final SoftReference<Map<String,SimpleDateFormat>> ref = THREADLOCAL_FORMATS.get();
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java b/juneau-core/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java
index 65a204b..cdf4291 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java
@@ -17,11 +17,11 @@ import java.util.*;
import org.apache.juneau.*;
/**
- * Represents a wrapped {@link BeanMap} where property values can be overridden, removed, or reordered
- * without affecting the underlying bean.
+ * Represents a wrapped {@link BeanMap} where property values can be overridden, removed, or reordered without
+ * affecting the underlying bean.
* <p>
- * Provides the {@link #filterKeys(List)} method for specifying the keys to keep in the bean map
- * and in what order they should appear.
+ * Provides the {@link #filterKeys(List)} method for specifying the keys to keep in the bean map and in what order
+ * they should appear.
*
* @param <T> The class type of the wrapped bean.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/DelegateList.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/DelegateList.java b/juneau-core/src/main/java/org/apache/juneau/internal/DelegateList.java
index 596ec85..e04da5f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/DelegateList.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/DelegateList.java
@@ -17,8 +17,8 @@ import java.util.*;
import org.apache.juneau.*;
/**
- * Represents a wrapped {@link Collection} where entries in the list can be removed or reordered without
- * affecting the underlying list.
+ * Represents a wrapped {@link Collection} where entries in the list can be removed or reordered without affecting the
+ * underlying list.
*
* @param <T> The class type of the wrapped bean.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/DelegateMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/DelegateMap.java b/juneau-core/src/main/java/org/apache/juneau/internal/DelegateMap.java
index ed3b53f..3c0e59f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/DelegateMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/DelegateMap.java
@@ -17,8 +17,7 @@ import java.util.*;
import org.apache.juneau.*;
/**
- * Represents a wrapped {@link Map} where entries in the map can be removed without
- * affecting the underlying map.
+ * Represents a wrapped {@link Map} where entries in the map can be removed without affecting the underlying map.
*
* @param <T> The class type of the wrapped bean.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/FileUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/FileUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/FileUtils.java
index 62e6238..6580275 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/FileUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/FileUtils.java
@@ -121,8 +121,8 @@ public class FileUtils {
/**
* Create a temporary file with the specified name.
* <p>
- * The name is broken into file name and suffix, and the parts
- * are passed to {@link File#createTempFile(String, String)}.
+ * The name is broken into file name and suffix, and the parts are passed to
+ * {@link File#createTempFile(String, String)}.
* <p>
* {@link File#deleteOnExit()} is called on the resulting file before being returned by this method.
*
@@ -170,7 +170,8 @@ public class FileUtils {
/**
* Returns the candidate file names for the specified file name in the specified locale.
* <p>
- * For example, if looking for the <js>"MyResource.txt"</js> file in the Japanese locale, the iterator will return names in the following order:
+ * For example, if looking for the <js>"MyResource.txt"</js> file in the Japanese locale, the iterator will return
+ * names in the following order:
* <ol>
* <li><js>"MyResource_ja_JP.txt"</js>
* <li><js>"MyResource_ja.txt"</js>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/IOUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/IOUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/IOUtils.java
index 516cd2e..4e680ac 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/IOUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/IOUtils.java
@@ -208,7 +208,8 @@ public final class IOUtils {
* <p>
* The {@code Reader} is automatically closed.
* <p>
- * If the {@code Reader} is not an instance of a {@code BufferedReader}, then it gets wrapped in a {@code BufferedReader}.
+ * If the {@code Reader} is not an instance of a {@code BufferedReader}, then it gets wrapped in a
+ * {@code BufferedReader}.
*
* @param in The input reader.
* @param length Specify a positive number if the length of the input is known.
@@ -250,8 +251,8 @@ public final class IOUtils {
* Wraps the specified reader in a buffered reader.
*
* @param r The reader being wrapped.
- * @return The reader wrapped in a {@link BufferedReader}, or the original {@link Reader} if it's already
- * a buffered reader.
+ * @return The reader wrapped in a {@link BufferedReader}, or the original {@link Reader} if it's already a buffered
+ * reader.
*/
public static Reader getBufferedReader(Reader r) {
if (r instanceof BufferedReader || r instanceof StringReader)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/JuneauLogger.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/JuneauLogger.java b/juneau-core/src/main/java/org/apache/juneau/internal/JuneauLogger.java
index 23f92a6..c4f3c73 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/JuneauLogger.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/JuneauLogger.java
@@ -76,12 +76,12 @@ public class JuneauLogger extends java.util.logging.Logger {
*
* @param name The name of the logger to use.
* @param resourceBundleName The name of the resource bundle.
- * Can be any of the following formats:
- * <ol>
- * <li>An absolute path. E.g. <js>"com/foo/nls/Messages"</js>.
- * <li>A path relative to the package of the class. E.g. <js>"nls/Messages"</js>.
- * </ol>
- * Both <js>'.'</js> and <js>'/'</js> can be used as path delimiters.
+ * Can be any of the following formats:
+ * <ol>
+ * <li>An absolute path. E.g. <js>"com/foo/nls/Messages"</js>.
+ * <li>A path relative to the package of the class. E.g. <js>"nls/Messages"</js>.
+ * </ol>
+ * Both <js>'.'</js> and <js>'/'</js> can be used as path delimiters.
* @return A new <l>Logger</l>.
*/
public static synchronized JuneauLogger getLogger(String name, String resourceBundleName) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/MultiSet.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/MultiSet.java b/juneau-core/src/main/java/org/apache/juneau/internal/MultiSet.java
index 0dab8d4..4dbe296 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/MultiSet.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/MultiSet.java
@@ -17,8 +17,7 @@ import static org.apache.juneau.internal.ThrowableUtils.*;
import java.util.*;
/**
- * Encapsulates multiple collections so they can be iterated over as if they
- * were all part of the same collection.
+ * Encapsulates multiple collections so they can be iterated over as if they were all part of the same collection.
*
* @param <E> The object type of this set.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/Pair.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/Pair.java b/juneau-core/src/main/java/org/apache/juneau/internal/Pair.java
index 93cda29..3593277 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/Pair.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/Pair.java
@@ -14,6 +14,7 @@ package org.apache.juneau.internal;
/**
* Represents a simple object pair.
+ *
* @param <F> The first object type.
* @param <S> The second object type.
*/
@@ -34,6 +35,7 @@ public class Pair<F,S> {
/**
* Returns the first object in the pair.
+ *
* @return The first object in the pair.
*/
public F first() {
@@ -42,6 +44,7 @@ public class Pair<F,S> {
/**
* Returns the second object in the pair.
+ *
* @return The second object in the pair.
*/
public S second() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/ReflectionUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/ReflectionUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/ReflectionUtils.java
index acb2043..451ae2c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/ReflectionUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/ReflectionUtils.java
@@ -54,8 +54,8 @@ public final class ReflectionUtils {
/**
* Returns the specified annotation only if it's been declared on the specified class.
* <p>
- * More efficient than calling {@link Class#getAnnotation(Class)} since it doesn't
- * recursively look for the class up the parent chain.
+ * More efficient than calling {@link Class#getAnnotation(Class)} since it doesn't recursively look for the class
+ * up the parent chain.
*
* @param <T> The annotation class type.
* @param a The annotation class.
@@ -145,7 +145,8 @@ public final class ReflectionUtils {
}
/**
- * Finds and appends the specified annotation on the specified class and superclasses/interfaces to the specified list.
+ * Finds and appends the specified annotation on the specified class and superclasses/interfaces to the specified
+ * list.
*
* @param a The annotation.
* @param c The class.
@@ -167,8 +168,8 @@ public final class ReflectionUtils {
}
/**
- * Similar to {@link Class#getResourceAsStream(String)} except looks up the
- * parent hierarchy for the existence of the specified resource.
+ * Similar to {@link Class#getResourceAsStream(String)} except looks up the parent hierarchy for the existence of
+ * the specified resource.
*
* @param c The class to return the resource on.
* @param name The resource name.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/SimpleMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/SimpleMap.java b/juneau-core/src/main/java/org/apache/juneau/internal/SimpleMap.java
index 34fc0bd..8a36771 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/SimpleMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/SimpleMap.java
@@ -20,8 +20,8 @@ import java.util.*;
import org.apache.juneau.*;
/**
- * An instance of a <code>Map</code> where the keys and values
- * are simple <code>String[]</code> and <code>Object[]</code> arrays.
+ * An instance of a <code>Map</code> where the keys and values are simple <code>String[]</code> and
+ * <code>Object[]</code> arrays.
* <p>
* Typically more efficient than <code>HashMaps</code> for small maps (e.g. <10 entries).
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/StringBuilderWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/StringBuilderWriter.java b/juneau-core/src/main/java/org/apache/juneau/internal/StringBuilderWriter.java
index d609a9a..6fc902c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/StringBuilderWriter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/StringBuilderWriter.java
@@ -34,7 +34,8 @@ public final class StringBuilderWriter extends Writer {
/**
* Create a new string writer using the specified initial string-builder size.
*
- * @param initialSize The number of <tt>char</tt> values that will fit into this buffer before it is automatically expanded
+ * @param initialSize The number of <tt>char</tt> values that will fit into this buffer before it is automatically
+ * expanded
* @throws IllegalArgumentException If <tt>initialSize</tt> is negative
*/
public StringBuilderWriter(int initialSize) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 f7f1462..e777a2c 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
@@ -626,10 +626,12 @@ public final class StringUtils {
}
/**
- * Returns <jk>true</jk> if specified string is <jk>null</jk> or it's {@link #toString()} method returns an empty string.
+ * Returns <jk>true</jk> if specified string is <jk>null</jk> or it's {@link #toString()} method returns an empty
+ * string.
*
* @param s The string to check.
- * @return <jk>true</jk> if specified string is <jk>null</jk> or it's {@link #toString()} method returns an empty string.
+ * @return <jk>true</jk> if specified string is <jk>null</jk> or it's {@link #toString()} method returns an empty
+ * string.
*/
public static boolean isEmpty(Object s) {
return s == null || s.toString().isEmpty();
@@ -913,14 +915,15 @@ public final class StringUtils {
/**
* Generated a random UUID with the specified number of characters.
* Characters are composed of lower-case ASCII letters and numbers only.
- * This method conforms to the restrictions for hostnames as specified in <a class="doclink" href="https://tools.ietf.org/html/rfc952">RFC 952</a>
- * Since each character has 36 possible values, the square approximation formula for
- * the number of generated IDs that would produce a 50% chance of collision is:
+ * This method conforms to the restrictions for hostnames as specified in <a class="doclink"
+ * href="https://tools.ietf.org/html/rfc952">RFC 952</a>
+ * Since each character has 36 possible values, the square approximation formula for the number of generated IDs
+ * that would produce a 50% chance of collision is:
* <code>sqrt(36^N)</code>.
- * Dividing this number by 10 gives you an approximation of the number of generated IDs
- * needed to produce a <1% chance of collision.
- * For example, given 5 characters, the number of generated IDs need to produce a <1% chance of
- * collision would be:
+ * Dividing this number by 10 gives you an approximation of the number of generated IDs needed to produce a
+ * <1% chance of collision.
+ * For example, given 5 characters, the number of generated IDs need to produce a <1% chance of collision would
+ * be:
* <code>sqrt(36^5)/10=777</code>
*
* @param numchars The number of characters in the generated UUID.
@@ -978,8 +981,7 @@ public final class StringUtils {
}
/**
- * Simple utility for replacing variables of the form <js>"{key}"</js> with values
- * in the specified map.
+ * Simple utility for replacing variables of the form <js>"{key}"</js> with values in the specified map.
* <p>
* Nested variables are supported in both the input string and map values.
* <p>
@@ -1070,7 +1072,6 @@ public final class StringUtils {
/**
* Same as {@link #pathStartsWith(String, String)} but returns <jk>true</jk> if at least one prefix matches.
- * <p>
*
* @param path The path to check.
* @param pathPrefixes The prefixes.
@@ -1111,6 +1112,7 @@ public final class StringUtils {
* String in = <js>"0,1,2"</js>;
* String[] parts = in.split(<js>","</js>);
* String p1 = (parts.<jk>length</jk> > 1 ? parts[1] : <js>""</js>);
+ * </p>
*
* @param fieldNum The field number. Zero-indexed.
* @param s The input string.
@@ -1351,7 +1353,8 @@ public final class StringUtils {
* Returns the first non-whitespace character in the string.
*
* @param s The string to check.
- * @return The first non-whitespace character, or <code>0</code> if the string is <jk>null</jk>, empty, or composed of only whitespace.
+ * @return The first non-whitespace character, or <code>0</code> if the string is <jk>null</jk>, empty, or composed
+ * of only whitespace.
*/
public static char firstNonWhitespaceChar(String s) {
if (s != null)
@@ -1559,7 +1562,7 @@ public final class StringUtils {
}
/**
- * Same as {@link String#indexOf(int)} except allows you to check for mulitiple characters.
+ * Same as {@link String#indexOf(int)} except allows you to check for multiple characters.
*
* @param s The string to check.
* @param c The characters to check for.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/TeeOutputStream.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/TeeOutputStream.java b/juneau-core/src/main/java/org/apache/juneau/internal/TeeOutputStream.java
index 4ffa3ec..507abbb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/TeeOutputStream.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/TeeOutputStream.java
@@ -44,8 +44,8 @@ public class TeeOutputStream extends OutputStream {
* Adds an output stream to this tee output stream.
*
* @param os The output stream to add to this tee output stream.
- * @param close If <jk>false</jk>, then calling {@link #close()} on this stream
- * will not filter to the specified output stream.
+ * @param close If <jk>false</jk>, then calling {@link #close()} on this stream will not filter to the specified
+ * output stream.
* @return This object (for method chaining).
*/
public TeeOutputStream add(OutputStream os, boolean close) {
@@ -68,8 +68,8 @@ public class TeeOutputStream extends OutputStream {
}
/**
- * Returns the output stream identified through the <code>id</code> parameter
- * passed in through the {@link #add(String, OutputStream, boolean)} method.
+ * Returns the output stream identified through the <code>id</code> parameter passed in through the
+ * {@link #add(String, OutputStream, boolean)} method.
*
* @param id The ID associated with the output stream.
* @return The output stream, or <jk>null</jk> if no identifier was specified when the output stream was added.
@@ -81,8 +81,8 @@ public class TeeOutputStream extends OutputStream {
}
/**
- * Same as {@link #add(OutputStream, boolean)} but associates the stream with an identifier
- * so the stream can be retrieved through {@link #getOutputStream(String)}.
+ * Same as {@link #add(OutputStream, boolean)} but associates the stream with an identifier so the stream can be
+ * retrieved through {@link #getOutputStream(String)}.
*
* @param id The ID to associate the output stream with.
* @param os The output stream to add.
[21/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
index 49d524d..32adb2d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
@@ -26,10 +26,9 @@ import org.apache.juneau.parser.*;
* <p>
* Provides a way to define the contents of {@link Parser#getMediaTypes()} through an annotation.
* <p>
- * The {@link Parser#getMediaTypes()} default implementation gathers the media types by looking
- * for this annotation.
- * It should be noted that this annotation is optional and that the {@link Parser#getMediaTypes()} method can
- * be overridden by subclasses to return the media types programmatically.
+ * The {@link Parser#getMediaTypes()} default implementation gathers the media types by looking for this annotation.
+ * It should be noted that this annotation is optional and that the {@link Parser#getMediaTypes()} method can be
+ * overridden by subclasses to return the media types programmatically.
*
* <h5 class='section'>Example:</h5>
* <p>
@@ -61,7 +60,8 @@ public @interface Consumes {
* A comma-delimited list of media types that the parser can handle.
* <p>
* Can contain meta-characters per the <code>media-type</code> specification of
- * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>
+ * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>
+ *
* @return The media types that the parser can handle.
*/
String value() default "";
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
index 0ad6c17..dfd2ff8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
@@ -27,8 +27,10 @@ import org.apache.juneau.ini.*;
* {@link ConfigFileImpl} class, so parsers will call this method with the section name
* using the {@link Section#setName(String)} method.
* <p>
- * A commonly-used case is when you're parsing a JSON map containing beans where one of the bean properties
- * is the key used in the map. For example:
+ * A commonly-used case is when you're parsing a JSON map containing beans where one of the bean properties is the key
+ * used in the map.
+ * <br>
+ * For example:
* <p class='bcode'>
* {
* id1: {name: <js>'John Smith'</js>, sex:<js>'M'</js>},
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
index c26de34..cc903e7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
@@ -23,9 +23,8 @@ import org.apache.juneau.ini.*;
* Identifies a setter as a method for adding a parent reference to a child object.
* <p>
* Used by the parsers to add references to parent objects in child objects.
- * For example, the {@link Section} class cannot exist outside the scope of a parent
- * {@link ConfigFileImpl} class, so parsers will add a reference to the config file
- * using the {@link Section#setParent(ConfigFileImpl)} method.
+ * For example, the {@link Section} class cannot exist outside the scope of a parent {@link ConfigFileImpl} class, so
+ * parsers will add a reference to the config file using the {@link Section#setParent(ConfigFileImpl)} method.
* <p>
* A commonly-used case is when you're parsing beans, and a child bean has a reference to a parent bean.
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java
index 33ba1b9..6e41c31 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java
@@ -40,7 +40,7 @@ public @interface Pojo {
*
* <h5 class='section'>Example:</h5>
* <p>
- * In this case, a swap is being applied to a bean that will force it to be serialized as a <code>String</code>
+ * In this case, a swap is being applied to a bean that will force it to be serialized as a <code>String</code>:
* <p class='bcode'>
* <jc>// Our bean class</jc>
* <ja>@Pojo</ja>(swap=BSwap.<jk>class</jk>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
index 4e76c64..2d13768 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
@@ -26,10 +26,10 @@ import org.apache.juneau.serializer.*;
* <p>
* Provides a way to define the contents of {@link Serializer#getMediaTypes()} through an annotation.
* <p>
- * The {@link Serializer#getMediaTypes()} default implementation gathers the media types by looking
- * for this annotation.
+ * The {@link Serializer#getMediaTypes()} default implementation gathers the media types by looking for this annotation.
+ * <br>
* It should be noted that this annotation is optional and that the {@link Serializer#getMediaTypes()} method can
- * be overridden by subclasses to return the media types programmatically.
+ * be overridden by subclasses to return the media types programmatically.
*
* <h5 class='section'>Example:</h5>
* <p>
@@ -40,9 +40,10 @@ import org.apache.juneau.serializer.*;
* </p>
* <p>
* The media types can also be <code>media-range</code> values per
- * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>.
- * When meta-characters are used, you should specify the {@link #contentType()} value to
- * indicate the real media type value that can be set on the <code>Content-Type</code> response header.
+ * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>.
+ * <br>
+ * When meta-characters are used, you should specify the {@link #contentType()} value to indicate the real media type
+ * value that can be set on the <code>Content-Type</code> response header.
*
* <p class='bcode'>
* <jc>// Produces any text</jc>
@@ -64,7 +65,8 @@ public @interface Produces {
* A comma-delimited list of the media types that the serializer can handle.
* <p>
* Can contain meta-characters per the <code>media-type</code> specification of
- * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>
+ * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>
+ *
* @return The media types that the parser can handle.
*/
String value() default "";
@@ -72,9 +74,9 @@ public @interface Produces {
/**
* The content type that this serializer produces.
* <p>
- * Can be used to override the <code>Content-Type</code> response type if the media types
- * are <code>media-ranges</code> with meta-characters, or the <code>Content-Type</code>
- * differs from the media type for some reason.
+ * Can be used to override the <code>Content-Type</code> response type if the media types are
+ * <code>media-ranges</code> with meta-characters, or the <code>Content-Type</code> differs from the media type for some reason.
+ *
* @return The content type that this serializer produces, or blank if no overriding value exists.
*/
String contentType() default "";
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java b/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java
index e5685db..24dbec9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java
@@ -24,19 +24,19 @@ import org.apache.juneau.serializer.*;
/**
* Used to identify a class or bean property as a URI.
* <p>
- * By default, instances of {@link URL} and {@link URI} are considered URIs during serialization, and are
- * handled differently depending on the serializer (e.g. <code>HtmlSerializer</code> creates a hyperlink,
- * <code>RdfXmlSerializer</code> creates an <code>rdf:resource</code> object, etc...).
+ * By default, instances of {@link URL} and {@link URI} are considered URIs during serialization, and are handled
+ * differently depending on the serializer (e.g. <code>HtmlSerializer</code> creates a hyperlink,
+ * <code>RdfXmlSerializer</code> creates an <code>rdf:resource</code> object, etc...).
* <p>
* This annotation allows you to identify other classes that return URIs via <code>toString()</code> as URI objects.
* <p>
* URIs are automatically resolved to absolute or root-relative form based on the serializer
- * {@link SerializerContext#SERIALIZER_uriResolution} and {@link SerializerContext#SERIALIZER_uriRelativity}
- * configuration settings, and the URI context defined by the {@link UriContext} that's part of the serializer
- * session.
+ * {@link SerializerContext#SERIALIZER_uriResolution} and {@link SerializerContext#SERIALIZER_uriRelativity}
+ * configuration settings, and the URI context defined by the {@link UriContext} that's part of the serializer
+ * session.
* <p>
* Refer to the {@link UriResolver} class for information about the types of URIs that can be resolved during
- * serialization.
+ * serialization.
* <p>
* This annotation can be applied to classes, interfaces, or bean property methods for fields.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/csv/CsvParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParser.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParser.java
index fd37dc5..c42c84c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParser.java
@@ -28,6 +28,7 @@ public class CsvParser extends ReaderParser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public CsvParser(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
index 6124708..52dbf1f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
@@ -32,6 +32,7 @@ public class CsvParserBuilder extends ParserBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public CsvParserBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
index 020e6af..6b2e190 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
@@ -25,9 +25,11 @@ 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.
+ * <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.
+ * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> -
+ * Configurable properties common to all parsers.
* </ul>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializer.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializer.java
index 3578b9f..b010719 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializer.java
@@ -32,6 +32,7 @@ public final class CsvSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public CsvSerializer(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
index d35d7cd..eecee4d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
@@ -32,6 +32,7 @@ public class CsvSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public CsvSerializerBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
index 278165b..1a77446 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
@@ -25,9 +25,11 @@ 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> - Properties associated with handling beans on serializers and parsers.
+ * <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.
+ * <li class='jc'><a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
* </ul>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
index 16a6c14..cde39cc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
@@ -30,20 +30,21 @@ public final class CsvSerializerSession extends SerializerSession {
* Create a new session using properties specified in the context.
*
* @param ctx The context creating this session object.
- * The context contains all the configuration settings for this object.
+ * The context contains all the configuration settings for this object.
* @param output The output object.
* @param op The override properties.
- * These override any context properties defined in the context.
+ * These override any context properties defined in the context.
* @param javaMethod The java method that called this serializer, usually the method in a REST servlet.
* @param locale The session locale.
- * If <jk>null</jk>, then the locale defined on the context is used.
+ * If <jk>null</jk>, then the locale defined on the context is used.
* @param timeZone The session timezone.
- * If <jk>null</jk>, then the timezone defined on the context is used.
+ * If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
* @param uriContext The URI context.
- * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
+ * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
*/
- protected CsvSerializerSession(CsvSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ protected CsvSerializerSession(CsvSerializerContext ctx, ObjectMap op, Object output, Method javaMethod,
+ Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
super(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
}
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/Link.java b/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
index 478a621..cd1ed55 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
@@ -28,7 +28,8 @@ import org.apache.juneau.utils.*;
* <p class='bcode'>
* <xt><a</xt> <xa>href</xa>=<xs>'href'</xs><xt>></xt>name<xt></a></xt>
* <p>
- * When encountered by the {@link HtmlSerializer} class, this object gets converted to a hyperlink.<br>
+ * When encountered by the {@link HtmlSerializer} class, this object gets converted to a hyperlink.
+ * <br>
* All other serializers simply convert it to a simple bean.
*/
@HtmlLink(nameProperty = "name", hrefProperty = "href")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
index 512f64b..d03199b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
@@ -25,17 +25,21 @@ import org.apache.juneau.*;
* <jk>import static</jk> org.apache.juneau.dto.atom.AtomBuilder.*;
*
* Feed feed =
- * <jsm>feed</jsm>(<js>"tag:juneau.sample.com,2013:1"</js>, <js>"Juneau ATOM specification"</js>, <js>"2013-05-08T12:29:29Z"</js>)
- * .subtitle(<jsm>text</jsm>(<js>"html"</js>).children(<js>"A <em>lot</em> of effort went into making this effortless"</js>))
+ * <jsm>feed</jsm>(<js>"tag:juneau.sample.com,2013:1"</js>, <js>"Juneau ATOM specification"</js>,
+ * <js>"2013-05-08T12:29:29Z"</js>)
+ * .subtitle(<jsm>text</jsm>(<js>"html"</js>)
+ * .children(<js>"A <em>lot</em> of effort went into making this effortless"</js>))
* .links(
- * <jsm>link</jsm>(<js>"alternate"</js>, <js>"text/html"</js>, <js>"http://www.sample.com/"</js>).hreflang(<js>"en"</js>),
+ * <jsm>link</jsm>(<js>"alternate"</js>, <js>"text/html"</js>, <js>"http://www.sample.com/"</js>)
+ * .hreflang(<js>"en"</js>),
* <jsm>link</jsm>(<js>"self"</js>, <js>"application/atom+xml"</js>, <js>"http://www.sample.com/feed.atom"</js>)
* );
* </p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
@@ -74,7 +78,8 @@ public class AtomBuilder {
}
/**
- * Creates an {@link Entry} element with the specified {@link Entry#id(Id)}, {@link Entry#title(Text)}, and {@link Entry#updated(Calendar)} attributes.
+ * Creates an {@link Entry} element with the specified {@link Entry#id(Id)}, {@link Entry#title(Text)}, and
+ * {@link Entry#updated(Calendar)} attributes.
*
* @param id The {@link Entry#id(Id)} attribute.
* @param title The {@link Entry#title(Text)} attribute.
@@ -86,7 +91,8 @@ public class AtomBuilder {
}
/**
- * Creates an {@link Entry} element with the specified {@link Entry#id(Id)}, {@link Entry#title(Text)}, and {@link Entry#updated(Calendar)} attributes.
+ * Creates an {@link Entry} element with the specified {@link Entry#id(Id)}, {@link Entry#title(Text)}, and
+ * {@link Entry#updated(Calendar)} attributes.
*
* @param id The {@link Entry#id(Id)} attribute.
* @param title The {@link Entry#title(Text)} attribute.
@@ -98,7 +104,8 @@ public class AtomBuilder {
}
/**
- * Creates a {@link Feed} element with the specified {@link Feed#id(Id)}, {@link Entry#title(Text)}, and {@link Feed#updated(Calendar)} attributes.
+ * Creates a {@link Feed} element with the specified {@link Feed#id(Id)}, {@link Entry#title(Text)}, and
+ * {@link Feed#updated(Calendar)} attributes.
*
* @param id The {@link Feed#id(Id)} attribute.
* @param title The {@link Feed#title(Text)} attribute.
@@ -110,7 +117,8 @@ public class AtomBuilder {
}
/**
- * Creates a {@link Feed} element with the specified {@link Feed#id(Id)}, {@link Entry#title(Text)}, and {@link Feed#updated(Calendar)} attributes.
+ * Creates a {@link Feed} element with the specified {@link Feed#id(Id)}, {@link Entry#title(Text)}, and
+ * {@link Feed#updated(Calendar)} attributes.
*
* @param id The {@link Feed#id(Id)} attribute.
* @param title The {@link Feed#title(Text)} attribute.
@@ -157,7 +165,8 @@ public class AtomBuilder {
}
/**
- * Creates a {@link Link} element with the specified {@link Link#rel(String)}, {@link Link#type(String)}, and {@link Link#href(String)} attributes.
+ * Creates a {@link Link} element with the specified {@link Link#rel(String)}, {@link Link#type(String)}, and
+ * {@link Link#href(String)} attributes.
*
* @param rel The {@link Link#rel(String)} attribute.
* @param type The {@link Link#type(String)} attribute.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
index 4fd9b3c..e0d0888 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
@@ -39,7 +39,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
@@ -56,6 +57,7 @@ public class Category extends Common {
/**
* Normal constructor.
+ *
* @param term The category term.
*/
public Category(String term) {
@@ -71,6 +73,7 @@ public class Category extends Common {
//--------------------------------------------------------------------------------
/**
+ *
* @return The category term.
*/
@Xml(format=ATTR)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
index 08b510b..26f9965 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
@@ -35,7 +35,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
index ed748c9..3d82327 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
@@ -27,7 +27,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
@@ -49,6 +50,7 @@ public class CommonEntry extends Common {
/**
* Normal constructor.
+ *
* @param id The ID of this object.
* @param title The title of this object.
* @param updated The updated timestamp of this object.
@@ -59,6 +61,7 @@ public class CommonEntry extends Common {
/**
* Normal constructor.
+ *
* @param id The ID of this object.
* @param title The title of this object.
* @param updated The updated timestamp of this object.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
index c8cd0f2..c9c96da 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
@@ -65,7 +65,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Entry.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Entry.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Entry.java
index 251a3d6..f28f083 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Entry.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Entry.java
@@ -45,7 +45,8 @@ import org.apache.juneau.transforms.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
index 0adc465..a261320 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
@@ -48,7 +48,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
index 0d16ff6..8a48a28 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
@@ -37,7 +37,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
index 37f0f03..964094c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
@@ -35,7 +35,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Id.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Id.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Id.java
index ca64b85..1732a5f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Id.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Id.java
@@ -30,7 +30,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
index 6d80912..e6ea325 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
@@ -37,7 +37,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
@@ -110,7 +111,7 @@ public class Link extends Common {
/**
* Sets the rel of this link.
*
- * @param rel The rell of this link.
+ * @param rel The rel of this link.
* @return This object (for method chaining).
*/
@BeanProperty("rel")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
index 8f648cc..b392e1c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
@@ -35,7 +35,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
@@ -53,6 +54,7 @@ public class Logo extends Common {
* Normal constructor.
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
+ * <br>
* Strings must be valid URIs.
* <p>
* URIs defined by {@link UriResolver} can be used for values.
@@ -85,6 +87,7 @@ public class Logo extends Common {
* Sets the URI of the logo.
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
+ * <br>
* Strings must be valid URIs.
* <p>
* URIs defined by {@link UriResolver} can be used for values.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
index aa5c336..7d0b8c4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
@@ -36,7 +36,8 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Source.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Source.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Source.java
index 901be93..416c6fa 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Source.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Source.java
@@ -42,7 +42,8 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
index d38c823..f5ef404 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
@@ -43,7 +43,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/Utils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Utils.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Utils.java
index 6bedd91..c8d75a3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Utils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Utils.java
@@ -21,7 +21,8 @@ import javax.xml.bind.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/atom/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/package.html b/juneau-core/src/main/java/org/apache/juneau/dto/atom/package.html
index ac7c3bd..1208216 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/package.html
@@ -74,11 +74,13 @@
<h2 class='topic' onclick='toggle(this)'>1 - Overview</h2>
<div class='topic'>
<p>
- Juneau supports generation and consumption of ATOM feeds through the use of DTOs (Data Transfer Objects).<br>
+ Juneau supports generation and consumption of ATOM feeds through the use of DTOs (Data Transfer Objects).
+ <br>
It uses existing support for serializing and parsing POJOs to and from XML to define these ATOM objects.
</p>
<p>
- The examples shown here are pulled from the <code>AtomFeedResource</code> class in the <code>org.apache.juneau.sample.war</code> project.
+ The examples shown here are pulled from the <code>AtomFeedResource</code> class in the
+ <code>org.apache.juneau.sample.war</code> project.
</p>
@@ -87,8 +89,10 @@
<h3 class='topic' onclick='toggle(this)'>1.1 - Serializing ATOM feeds</h3>
<div class='topic'>
<p>
- The Juneau ATOM feed DTOs are simply beans with fluent-style setters.<br>
- The following code shows a feed being created programmatically using the {@link org.apache.juneau.dto.atom.AtomBuilder} class.
+ The Juneau ATOM feed DTOs are simply beans with fluent-style setters.
+ <br>
+ The following code shows a feed being created programmatically using the
+ {@link org.apache.juneau.dto.atom.AtomBuilder} class.
</p>
<p class='bcode'>
@@ -420,7 +424,8 @@
<h4 class='topic' onclick='toggle(this)'>1.1.2 - ATOM/RDF/XML</h4>
<div class='topic'>
<p>
- The {@link org.apache.juneau.jena.RdfSerializer} class and subclasses can also be used to produce ATOM in various RDF formats.
+ The {@link org.apache.juneau.jena.RdfSerializer} class and subclasses can also be used to produce ATOM
+ in various RDF formats.
</p>
<h6 class='figure'>ATOM/RDF/XML example</h6>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java
index f880815..5862668 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java
@@ -136,7 +136,8 @@ public class Column {
/**
* Bean property getter: <property>length</property>.
*
- * @return The value of the <property>length</property> property on this bean, or <jk>null</jk> if length is not applicable for the specified type.
+ * @return The value of the <property>length</property> property on this bean, or <jk>null</jk> if length is not
+ * applicable for the specified type.
*/
@Xml(format=XmlFormat.ATTR)
public Integer getLength() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
index f90a4f1..739001b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
@@ -26,7 +26,8 @@ import org.apache.juneau.xml.annotation.*;
* <xt><?xml</xt> <xa>version</xa>=<xs>'1.0'</xs> <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?></xt>
* <xt><c:dataset <xa>xmlns:c</xa>=<xs>'http://developer.cognos.com/schemas/xmldata/1/'</xs>></xt>
* <xt><c:metadata></xt>
- * <xt><c:item</xt> <xa>name</xa>=<xs>'name'</xs> <xa>type</xa>=<xs>'xs:String'</xs> <xa>length</xa>=<xs>'255'</xs><xt>/></xt>
+ * <xt><c:item</xt> <xa>name</xa>=<xs>'name'</xs> <xa>type</xa>=<xs>'xs:String'</xs>
+ * <xa>length</xa>=<xs>'255'</xs><xt>/></xt>
* <xt><c:item</xt> <xa>name</xa>=<xs>'age'</xs> <xa>type</xa>=<xs>'xs:int'</xs><xt>/></xt>
* <xt><c:item</xt> <xa>name</xa>=<xs>'numAddresses'</xs> <xa>type</xa>=<xs>'xs:int'</xs><xt>/></xt>
* <xt></c:metadata></xt>
@@ -45,11 +46,12 @@ import org.apache.juneau.xml.annotation.*;
* <xt></c:dataset></xt>
* </p>
* <p>
- * Only 2-dimentional POJOs (arrays or collections of maps or beans) can be serialized to Cognos.
+ * Only 2-dimensional POJOs (arrays or collections of maps or beans) can be serialized to Cognos.
*
* <h5 class='section'>Example:</h5>
* <p>
- * The construct shown above is a serialized <code>AddressBook</code> object which is a subclass of <code>LinkedList<Person></code>.
+ * The construct shown above is a serialized <code>AddressBook</code> object which is a subclass of
+ * <code>LinkedList<Person></code>.
* The code for generating the XML is as follows...
* </p>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
index 07a4a00..d9a4286 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
@@ -20,11 +20,13 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-a-element"><a></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-a-element"><a></a> element.
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -66,6 +68,7 @@ public class A extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-hreflang">hreflang</a> attribute.
* Language of the linked resource.
+ *
* @param hreflang The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -77,6 +80,7 @@ public class A extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-rel">rel</a> attribute.
* Relationship between the document containing the hyperlink and the destination resource.
+ *
* @param rel The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -88,6 +92,7 @@ public class A extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-target">target</a> attribute.
* Default browsing context for hyperlink navigation and form submission.
+ *
* @param target The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -99,6 +104,7 @@ public class A extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-type">type</a> attribute.
* Hint for the type of the referenced resource.
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
index 2bad2c9..7c08fb3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-abbr-element"><abbr></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-abbr-element"><abbr></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
index 6a5440d..79900bd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-address-element"><address></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-address-element"><address></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
index ad6f335..fc8591d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-area-element"><area></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-area-element"><area></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -36,6 +38,7 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-alt">alt</a> attribute.
* Replacement text for use when images are not available.
+ *
* @param alt The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -45,8 +48,10 @@ public class Area extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-coords">coords</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-coords">coords</a>
+ * attribute.
* Coordinates for the shape to be created in an image map.
+ *
* @param coords The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -58,6 +63,7 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-download">download</a> attribute.
* Whether to download the resource instead of navigating to it, and its file name if so.
+ *
* @param download The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -88,6 +94,7 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-hreflang">hreflang</a> attribute.
* Language of the linked resource.
+ *
* @param hreflang The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -99,6 +106,7 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-rel">rel</a> attribute.
* Relationship between the document containing the hyperlink and the destination resource.
+ *
* @param rel The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -110,6 +118,7 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-shape">shape</a> attribute.
* The kind of shape to be created in an image map.
+ *
* @param shape The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -121,6 +130,7 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-target">target</a> attribute.
* Browsing context for hyperlink navigation.
+ *
* @param target The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -132,6 +142,7 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-type">type</a> attribute.
* Hint for the type of the referenced resource.
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
index 2e83e6f..1a5687d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-article-element"><article></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-article-element"><article></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
index fc1ed02..5981926 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-aside-element"><aside></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-aside-element"><aside></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
index b5fef05..17887c2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-audio-element"><audio></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-audio-element"><audio></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -34,8 +36,10 @@ import org.apache.juneau.annotation.*;
public class Audio extends HtmlElementContainer {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-autoplay">autoplay</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-autoplay">autoplay</a>
+ * attribute.
* Hint that the media resource can be started automatically when the page is loaded.
+ *
* @param autoplay The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -46,8 +50,10 @@ public class Audio extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-controls">controls</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-controls">controls</a>
+ * attribute.
* Show user agent controls.
+ *
* @param controls The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -58,8 +64,10 @@ public class Audio extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-crossorigin">crossorigin</a> attribute.
- * How the element handles crossorigin requests.
+ * <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-crossorigin">crossorigin</a> attribute.
+ * How the element handles cross-origin requests.
+ *
* @param crossorigin The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -71,6 +79,7 @@ public class Audio extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-loop">loop</a> attribute.
* Whether to loop the media resource.
+ *
* @param loop The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -81,8 +90,10 @@ public class Audio extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-mediagroup">mediagroup</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-mediagroup">mediagroup</a>
+ * attribute.
* Groups media elements together with an implicit MediaController.
+ *
* @param mediagroup The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -92,8 +103,10 @@ public class Audio extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-muted">muted</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-muted">muted</a>
+ * attribute.
* Whether to mute the media resource by default.
+ *
* @param muted The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -104,8 +117,10 @@ public class Audio extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-preload">preload</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-preload">preload</a>
+ * attribute.
* Hints how much buffering the media resource will likely need.
+ *
* @param preload The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
index 86f9a6c..34cc254 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-b-element"><b></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-b-element"><b></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
index 1618c86..c4fecdb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#the-base-element"><base></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/document-metadata.html#the-base-element"><base></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -52,8 +54,10 @@ public class Base extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-base-target">target</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-base-target">target</a>
+ * attribute.
* Default browsing context for hyperlink navigation and form submission.
+ *
* @param target The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
index 7202b19..085532e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdi-element"><bdi></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdi-element"><bdi></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
index d249e12..fcea11a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdo-element"><bdo></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdo-element"><bdo></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
index c328208..6f7b8be 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-blockquote-element"><blockquote></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-blockquote-element"><blockquote></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -30,8 +32,10 @@ import org.apache.juneau.annotation.*;
public class Blockquote extends HtmlElementMixed {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-blockquote-cite">cite</a> attribute.
- * Link to the source of the quotation..
+ * <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-blockquote-cite">cite</a>
+ * attribute.
+ * Link to the source of the quotation.
+ *
* @param cite The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
index 225e800..1f111d5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-body-element"><body></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-body-element"><body></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -30,8 +32,9 @@ import org.apache.juneau.annotation.*;
public class Body extends HtmlElementMixed {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onafterprint">onafterprint</a> attribute.
- * //onbeforeprint https://www.w3.org/TR/html5/webappapis.html#handler-window-onbeforeprint.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onafterprint">onafterprint</a>
+ * attribute.
+ *
* @param onafterprint The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -41,8 +44,9 @@ public class Body extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onbeforeunload">onbeforeunload</a> attribute.
- * //onhashchange https://www.w3.org/TR/html5/webappapis.html#handler-window-onhashchange.
+ * <a class="doclink"
+ * href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onbeforeunload">onbeforeunload</a> attribute.
+ *
* @param onbeforeunload The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -52,8 +56,9 @@ public class Body extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onmessage">onmessage</a> attribute.
- * //onoffline https://www.w3.org/TR/html5/webappapis.html#handler-window-onoffline.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onmessage">onmessage</a>
+ * attribute.
+ *
* @param onmessage The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -63,8 +68,9 @@ public class Body extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-ononline">ononline</a> attribute.
- * //onpagehide https://www.w3.org/TR/html5/webappapis.html#handler-window-onpagehide.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-ononline">ononline</a>
+ * attribute.
+ *
* @param ononline The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -74,8 +80,9 @@ public class Body extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onpageshow">onpageshow</a> attribute.
- * //onpopstate https://www.w3.org/TR/html5/webappapis.html#handler-window-onpopstate.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onpageshow">onpageshow</a>
+ * attribute.
+ *
* @param onpageshow The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -85,8 +92,9 @@ public class Body extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onstorage">onstorage</a> attribute.
- * //onunload https://www.w3.org/TR/html5/webappapis.html#handler-window-onunload.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onstorage">onstorage</a>
+ * attribute.
+ *
* @param onstorage The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
index 5463868..e9d0da2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-br-element"><br></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-br-element"><br></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
index 11fa930..2f7b0eb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-button-element"><button></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-button-element"><button></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -36,6 +38,7 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus">autofocus</a> attribute.
* Automatically focus the form control when the page is loaded.
+ *
* @param autofocus The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -48,6 +51,7 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled">disabled</a> attribute.
* Whether the form control is disabled.
+ *
* @param disabled The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -60,6 +64,7 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
* Associates the control with a form element.
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -88,6 +93,7 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formenctype">formenctype</a> attribute.
* Form data set encoding type to use for form submission.
+ *
* @param formenctype The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -99,6 +105,7 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formmethod">formmethod</a> attribute.
* HTTP method to use for form submission.
+ *
* @param formmethod The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -108,8 +115,10 @@ public class Button extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formnovalidate">formnovalidate</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formnovalidate">formnovalidate</a>
+ * attribute.
* Bypass form control validation for form submission.
+ *
* @param formnovalidate The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -121,6 +130,7 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formtarget">formtarget</a> attribute.
* Browsing context for form submission.
+ *
* @param formtarget The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -132,6 +142,7 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-menu">menu</a> attribute.
* Specifies the element's designated pop-up menu.
+ *
* @param menu The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -143,6 +154,7 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
* Name of form control to use for form submission and in the form.elements API.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -154,6 +166,7 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-button-type">type</a> attribute.
* Type of button.
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -165,6 +178,7 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-button-value">value</a> attribute.
* Value to be used for form submission.
+ *
* @param value The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
index 5e81772..b3eeb0e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#the-canvas-element"><canvas></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/scripting-1.html#the-canvas-element"><canvas></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Canvas extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-canvas-height">height</a> attribute.
* Vertical dimension.
+ *
* @param height The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -44,6 +47,7 @@ public class Canvas extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-canvas-width">width</a> attribute.
* Horizontal dimension.
+ *
* @param width The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
[11/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/TeeWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/TeeWriter.java b/juneau-core/src/main/java/org/apache/juneau/internal/TeeWriter.java
index b52a2b9..dd1dee5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/TeeWriter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/TeeWriter.java
@@ -44,8 +44,8 @@ public class TeeWriter extends Writer {
* Adds a writer to this tee writer.
*
* @param w The writer to add to this tee writer.
- * @param close If <jk>false</jk>, then calling {@link #close()} on this tee writer
- * will not filter to the specified writer.
+ * @param close If <jk>false</jk>, then calling {@link #close()} on this tee writer will not filter to the
+ * specified writer.
* @return This object (for method chaining).
*/
public TeeWriter add(Writer w, boolean close) {
@@ -68,8 +68,8 @@ public class TeeWriter extends Writer {
}
/**
- * Same as {@link #add(Writer, boolean)} but associates the writer with an identifier
- * so the writer can be retrieved through {@link #getWriter(String)}.
+ * Same as {@link #add(Writer, boolean)} but associates the writer with an identifier so the writer can be retrieved
+ * through {@link #getWriter(String)}.
*
* @param id The ID to associate the writer with.
* @param w The writer to add.
@@ -95,8 +95,8 @@ public class TeeWriter extends Writer {
}
/**
- * Returns the writer identified through the <code>id</code> parameter
- * passed in through the {@link #add(String, Writer, boolean)} method.
+ * Returns the writer identified through the <code>id</code> parameter passed in through the
+ * {@link #add(String, Writer, boolean)} method.
*
* @param id The ID associated with the writer.
* @return The writer, or <jk>null</jk> if no identifier was specified when the writer was added.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/Utils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/Utils.java b/juneau-core/src/main/java/org/apache/juneau/internal/Utils.java
index 741b6d2..2aeb77a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/Utils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/Utils.java
@@ -22,13 +22,9 @@ public class Utils {
*
* @param i1 Integer #1
* @param i2 Integer #2
- * @return the value <code>0</code> if Integer #1 is
- * equal to Integer #2; a value less than
- * <code>0</code> if Integer #1 numerically less
- * than Integer #2; and a value greater
- * than <code>0</code> if Integer #1 is numerically
- * greater than Integer #2 (signed
- * comparison).
+ * @return The value <code>0</code> if Integer #1 is equal to Integer #2; a value less than <code>0</code> if
+ * Integer #1 numerically less than Integer #2; and a value greater than <code>0</code> if Integer #1 is numerically
+ * greater than Integer #2 (signed comparison).
*/
public static final int compare(int i1, int i2) {
return (i1<i2 ? -1 : (i1==i2 ? 0 : 1));
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/Version.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/Version.java b/juneau-core/src/main/java/org/apache/juneau/internal/Version.java
index 942043e..4630c37 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/Version.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/Version.java
@@ -27,13 +27,13 @@ public class Version {
* Constructor
*
* @param versionString A string of the form <js>"#.#..."</js> where there can be any number of parts.
- * <br>Valid values:
- * <ul>
- * <li><js>"1.2"</js>
- * <li><js>"1.2.3"</js>
- * <li><js>"0.1"</js>
- * <li><js>".1"</js>
- * </ul>
+ * <br>Valid values:
+ * <ul>
+ * <li><js>"1.2"</js>
+ * <li><js>"1.2.3"</js>
+ * <li><js>"0.1"</js>
+ * <li><js>".1"</js>
+ * </ul>
* Any parts that are not numeric are interpreted as {@link Integer#MAX_VALUE}
*/
public Version(String versionString) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/internal/WrappedMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/WrappedMap.java b/juneau-core/src/main/java/org/apache/juneau/internal/WrappedMap.java
index d1f0adf..534786d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/WrappedMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/WrappedMap.java
@@ -16,6 +16,7 @@ import java.util.*;
/**
* Wraps an existing map inside an extensible interface so that convenience methods can be added to the subclass.
+ *
* @param <K> The key type.
* @param <V> The value type.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/jso/JsoParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/jso/JsoParser.java b/juneau-core/src/main/java/org/apache/juneau/jso/JsoParser.java
index fad986f..ca975d0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/jso/JsoParser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/jso/JsoParser.java
@@ -34,6 +34,7 @@ public final class JsoParser extends InputStreamParser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public JsoParser(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/jso/JsoParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/jso/JsoParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/jso/JsoParserBuilder.java
index 2052f42..f0a8c58 100644
--- a/juneau-core/src/main/java/org/apache/juneau/jso/JsoParserBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/jso/JsoParserBuilder.java
@@ -32,6 +32,7 @@ public class JsoParserBuilder extends ParserBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public JsoParserBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/jso/JsoSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/jso/JsoSerializer.java b/juneau-core/src/main/java/org/apache/juneau/jso/JsoSerializer.java
index d95cdbe..6989905 100644
--- a/juneau-core/src/main/java/org/apache/juneau/jso/JsoSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/jso/JsoSerializer.java
@@ -36,6 +36,7 @@ public class JsoSerializer extends OutputStreamSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public JsoSerializer(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/jso/JsoSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/jso/JsoSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/jso/JsoSerializerBuilder.java
index 5bb072d..d768a67 100644
--- a/juneau-core/src/main/java/org/apache/juneau/jso/JsoSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/jso/JsoSerializerBuilder.java
@@ -32,6 +32,7 @@ public class JsoSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public JsoSerializerBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/json/JsonClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonClassMeta.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonClassMeta.java
index b274365..0598923 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonClassMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonClassMeta.java
@@ -19,7 +19,8 @@ import org.apache.juneau.internal.*;
import org.apache.juneau.json.annotation.*;
/**
- * Metadata on classes specific to the JSON serializers and parsers pulled from the {@link Json @Json} annotation on the class.
+ * Metadata on classes specific to the JSON serializers and parsers pulled from the {@link Json @Json} annotation on
+ * the class.
*/
public class JsonClassMeta extends ClassMetaExtended {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 17825a5..c86e207 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
@@ -36,38 +36,42 @@ import org.apache.juneau.transform.*;
* <h5 class='section'>Description:</h5>
* <p>
* This parser uses a state machine, which makes it very fast and efficient. It parses JSON in about 70% of the
- * time that it takes the built-in Java DOM parsers to parse equivalent XML.
+ * time that it takes the built-in Java DOM parsers to parse equivalent XML.
* <p>
* 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.
- * </ul>
+ * <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.
+ * </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>
- * <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 {@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>.
- * </ul>
+ * <ul class='spaced-list'>
+ * <li> JSON objects (<js>"{...}"</js>) are converted to {@link ObjectMap ObjectMaps}. <br>
+ * <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
+ * {@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>.
+ * </ul>
* <p>
- * Input can be any of the following:<br>
+ * 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> attribute is present.
+ * <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}, or {@link Double}).
+ * <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}.
@@ -75,8 +79,10 @@ import org.apache.juneau.transform.*;
* <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 {@link ObjectMap#ObjectMap(CharSequence) ObjectMap(CharSequence)}
- * or {@link ObjectList#ObjectList(CharSequence) ObjectList(CharSequence)} constructors instead of using this class. The end result should be the same.
+ * TIP: If you know you're parsing a JSON object or array, it can be easier to parse it using the
+ * {@link ObjectMap#ObjectMap(CharSequence) ObjectMap(CharSequence)} or {@link ObjectList#ObjectList(CharSequence)
+ * ObjectList(CharSequence)} constructors instead of using this class.
+ * The end result should be the same.
*
* <h5 class='section'>Configurable properties:</h5>
* <p>
@@ -103,6 +109,7 @@ public class JsonParser extends ReaderParser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public Strict(PropertyStore propertyStore) {
@@ -120,6 +127,7 @@ public class JsonParser extends ReaderParser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public JsonParser(PropertyStore propertyStore) {
@@ -132,7 +140,8 @@ public class JsonParser extends ReaderParser {
return new JsonParserBuilder(propertyStore);
}
- private <T> T parseAnything(JsonParserSession session, ClassMeta<T> eType, ParserReader r, Object outer, BeanPropertyMeta pMeta) throws Exception {
+ private <T> T parseAnything(JsonParserSession session, ClassMeta<T> eType, ParserReader r, Object outer,
+ BeanPropertyMeta pMeta) throws Exception {
if (eType == null)
eType = (ClassMeta<T>)object();
@@ -220,11 +229,13 @@ public class JsonParser extends ReaderParser {
if (m.containsKey(session.getBeanTypePropertyName(eType)))
o = session.cast((ObjectMap)m, pMeta, eType);
else
- throw new ParseException(session, "Class ''{0}'' could not be instantiated. Reason: ''{1}''", sType.getInnerClass().getName(), sType.getNotABeanReason());
+ throw new ParseException(session, "Class ''{0}'' could not be instantiated. Reason: ''{1}''",
+ sType.getInnerClass().getName(), sType.getNotABeanReason());
} else if (sType.canCreateNewInstanceFromString(outer) && ! session.isStrict()) {
o = sType.newInstanceFromString(outer, parseString(session, r));
} else {
- throw new ParseException(session, "Unrecognized syntax for class type ''{0}'', starting character ''{1}''", sType, (char)c);
+ throw new ParseException(session, "Unrecognized syntax for class type ''{0}'', starting character ''{1}''",
+ sType, (char)c);
}
if (wrapperAttr != null)
@@ -299,7 +310,8 @@ public class JsonParser extends ReaderParser {
}
- private <K,V> Map<K,V> parseIntoMap2(JsonParserSession session, ParserReader r, Map<K,V> m, ClassMeta<K> keyType, ClassMeta<V> valueType, BeanPropertyMeta pMeta) throws Exception {
+ private <K,V> Map<K,V> parseIntoMap2(JsonParserSession session, ParserReader r, Map<K,V> m, ClassMeta<K> keyType,
+ ClassMeta<V> valueType, BeanPropertyMeta pMeta) throws Exception {
if (keyType == null)
keyType = (ClassMeta<K>)string();
@@ -401,7 +413,8 @@ public class JsonParser extends ReaderParser {
throw new ParseException(session, "Could not find the end of the field name.");
}
- private <E> Collection<E> parseIntoCollection2(JsonParserSession session, ParserReader r, Collection<E> l, ClassMeta<?> type, BeanPropertyMeta pMeta) throws Exception {
+ private <E> Collection<E> parseIntoCollection2(JsonParserSession session, ParserReader r, Collection<E> l,
+ ClassMeta<?> type, BeanPropertyMeta pMeta) throws Exception {
int S0=0; // Looking for outermost [
int S1=1; // Looking for starting [ or { or " or ' or LITERAL or ]
@@ -545,7 +558,11 @@ public class JsonParser extends ReaderParser {
r.mark();
int qc = r.read(); // The quote character being used (" or ')
if (qc != '"' && session.isStrict()) {
- String msg = (qc == '\'' ? "Invalid quote character \"{0}\" being used." : "Did not find quote character marking beginning of string. Character=\"{0}\"");
+ String msg = (
+ qc == '\''
+ ? "Invalid quote character \"{0}\" being used."
+ : "Did not find quote character marking beginning of string. Character=\"{0}\""
+ );
throw new ParseException(session, msg, (char)qc);
}
final boolean isQuoted = (qc == '\'' || qc == '"');
@@ -679,7 +696,8 @@ public class JsonParser extends ReaderParser {
} else {
currAttr = parseFieldName(session, r.unread());
if (! currAttr.equals(wrapperAttr))
- throw new ParseException(session, "Expected to find wrapper attribute ''{0}'' but found attribute ''{1}''", wrapperAttr, currAttr);
+ throw new ParseException(session,
+ "Expected to find wrapper attribute ''{0}'' but found attribute ''{1}''", wrapperAttr, currAttr);
state = S3;
}
} else if (state == S3) {
@@ -765,7 +783,8 @@ public class JsonParser extends ReaderParser {
//--------------------------------------------------------------------------------
@Override /* Parser */
- public JsonParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public JsonParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale,
+ TimeZone timeZone, MediaType mediaType) {
return new JsonParserSession(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
index 94b3340..d3eb7b8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
@@ -32,6 +32,7 @@ public class JsonParserBuilder extends ParserBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public JsonParserBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 04a034f..949b64e 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,9 +25,11 @@ 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.
+ * <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.
+ * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> -
+ * Configurable properties common to all parsers.
* </ul>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/json/JsonParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonParserSession.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonParserSession.java
index f495bca..34128be 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonParserSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonParserSession.java
@@ -52,7 +52,8 @@ public final class JsonParserSession extends ParserSession {
* If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
*/
- public JsonParserSession(JsonParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public JsonParserSession(JsonParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer,
+ Locale locale, TimeZone timeZone, MediaType mediaType) {
super(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
index a85fbfe..0c43381 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
@@ -44,6 +44,7 @@ public final class JsonSchemaSerializer extends JsonSerializer {
/**
* Constructor.
+ *
* @param propertyStore Initialize with the specified config property store.
*/
public JsonSchemaSerializer(PropertyStore propertyStore) {
@@ -52,6 +53,7 @@ public final class JsonSchemaSerializer extends JsonSerializer {
/**
* Constructor.
+ *
* @param propertyStore Initialize with the specified config property store.
* @param overrideProperties
*/
@@ -62,7 +64,8 @@ public final class JsonSchemaSerializer extends JsonSerializer {
@Override /* CoreObject */
protected ObjectMap getOverrideProperties() {
- return super.getOverrideProperties().append(SERIALIZER_detectRecursions, true).append(SERIALIZER_ignoreRecursions, true);
+ return super.getOverrideProperties().append(SERIALIZER_detectRecursions, true)
+ .append(SERIALIZER_ignoreRecursions, true);
}
@@ -71,7 +74,8 @@ public final class JsonSchemaSerializer extends JsonSerializer {
//--------------------------------------------------------------------------------
@Override /* Serializer */
- public JsonSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ public JsonSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale,
+ TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
return new JsonSerializerSession(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
}
@@ -92,7 +96,8 @@ public final class JsonSchemaSerializer extends JsonSerializer {
* @throws SerializeException If a problem occurred trying to convert the output.
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
- private ObjectMap getSchema(JsonSerializerSession session, ClassMeta<?> eType, String attrName, String[] pNames) throws Exception {
+ private ObjectMap getSchema(JsonSerializerSession session, ClassMeta<?> eType, String attrName, String[] pNames)
+ throws Exception {
ObjectMap out = new ObjectMap();
if (eType == null)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
index df08b02..e15384a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
@@ -32,6 +32,7 @@ public class JsonSchemaSerializerBuilder extends JsonSerializerBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public JsonSchemaSerializerBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 4f2de4c..031017d 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
@@ -37,7 +37,8 @@ import org.apache.juneau.transform.*;
* 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 JSON arrays.
+ * <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.
@@ -47,10 +48,12 @@ import org.apache.juneau.transform.*;
* </ul>
* <p>
* The types above are considered "JSON-primitive" object types. Any non-JSON-primitive object types are transformed
- * into JSON-primitive object types through {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated through the {@link CoreObjectBuilder#pojoSwaps(Class...)}
- * method. Several default transforms are provided for transforming Dates, Enums, Iterators, etc...
+ * into JSON-primitive object types through {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated
+ * through the {@link CoreObjectBuilder#pojoSwaps(Class...)} method.
+ * Several default transforms are provided for transforming Dates, Enums, Iterators, etc...
* <p>
- * This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient.
+ * This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will
+ * be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
*
* <h5 class='section'>Configurable properties:</h5>
@@ -112,6 +115,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public Readable(PropertyStore propertyStore) {
@@ -130,6 +134,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public Simple(PropertyStore propertyStore) {
@@ -147,6 +152,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public SimpleReadable(PropertyStore propertyStore) {
@@ -155,7 +161,8 @@ public class JsonSerializer extends WriterSerializer {
@Override /* CoreObject */
protected ObjectMap getOverrideProperties() {
- return super.getOverrideProperties().append(JSON_simpleMode, true).append(SERIALIZER_quoteChar, '\'').append(SERIALIZER_useWhitespace, true);
+ return super.getOverrideProperties().append(JSON_simpleMode, true).append(SERIALIZER_quoteChar, '\'')
+ .append(SERIALIZER_useWhitespace, true);
}
}
@@ -167,6 +174,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public SimpleReadableSafe(PropertyStore propertyStore) {
@@ -175,7 +183,8 @@ public class JsonSerializer extends WriterSerializer {
@Override /* CoreObject */
protected ObjectMap getOverrideProperties() {
- return super.getOverrideProperties().append(JSON_simpleMode, true).append(SERIALIZER_quoteChar, '\'').append(SERIALIZER_useWhitespace, true).append(SERIALIZER_detectRecursions, true);
+ return super.getOverrideProperties().append(JSON_simpleMode, true).append(SERIALIZER_quoteChar, '\'')
+ .append(SERIALIZER_useWhitespace, true).append(SERIALIZER_detectRecursions, true);
}
}
@@ -185,12 +194,12 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public JsonSerializer(PropertyStore propertyStore) {
super(propertyStore);
this.ctx = createContext(JsonSerializerContext.class);
-// this.schemaSerializer = new JsonSchemaSerializer(propertyStore, getOverrideProperties());
}
@Override /* CoreObject */
@@ -203,7 +212,8 @@ public class JsonSerializer extends WriterSerializer {
* appropriate type-specific serialization method.
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
- SerializerWriter serializeAnything(JsonSerializerSession session, JsonWriter out, Object o, ClassMeta<?> eType, String attrName, BeanPropertyMeta pMeta) throws Exception {
+ SerializerWriter serializeAnything(JsonSerializerSession session, JsonWriter out, Object o, ClassMeta<?> eType,
+ String attrName, BeanPropertyMeta pMeta) throws Exception {
if (o == null) {
out.append("null");
@@ -280,7 +290,8 @@ public class JsonSerializer extends WriterSerializer {
}
@SuppressWarnings({ "rawtypes", "unchecked" })
- private SerializerWriter serializeMap(JsonSerializerSession session, JsonWriter out, Map m, ClassMeta<?> type) throws Exception {
+ private SerializerWriter serializeMap(JsonSerializerSession session, JsonWriter out, Map m, ClassMeta<?> type)
+ throws Exception {
ClassMeta<?> keyType = type.getKeyType(), valueType = type.getValueType();
@@ -310,7 +321,8 @@ public class JsonSerializer extends WriterSerializer {
return out;
}
- private SerializerWriter serializeBeanMap(JsonSerializerSession session, JsonWriter out, BeanMap<?> m, String typeName) throws Exception {
+ private SerializerWriter serializeBeanMap(JsonSerializerSession session, JsonWriter out, BeanMap<?> m,
+ String typeName) throws Exception {
int i = session.getIndent();
out.append('{');
@@ -341,7 +353,8 @@ public class JsonSerializer extends WriterSerializer {
}
@SuppressWarnings({"rawtypes", "unchecked"})
- private SerializerWriter serializeCollection(JsonSerializerSession session, JsonWriter out, Collection c, ClassMeta<?> type) throws Exception {
+ private SerializerWriter serializeCollection(JsonSerializerSession session, JsonWriter out, Collection c,
+ ClassMeta<?> type) throws Exception {
ClassMeta<?> elementType = type.getElementType();
@@ -367,6 +380,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Returns the schema serializer based on the settings of this serializer.
+ *
* @return The schema serializer.
*/
public JsonSchemaSerializer getSchemaSerializer() {
@@ -381,7 +395,8 @@ public class JsonSerializer extends WriterSerializer {
//--------------------------------------------------------------------------------
@Override /* Serializer */
- public JsonSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ public JsonSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale,
+ TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
return new JsonSerializerSession(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 1454d67..a7539fe1 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
@@ -34,6 +34,7 @@ public class JsonSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public JsonSerializerBuilder(PropertyStore propertyStore) {
@@ -97,8 +98,8 @@ public class JsonSerializerBuilder extends SerializerBuilder {
* <p>
* If <jk>true</jk>, solidus (e.g. slash) characters should be escaped.
* 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>.
+ * 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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 837113c..354fab0 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,9 +25,12 @@ 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> - Properties associated with handling beans on serializers and parsers.
+ * <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.
+ * <li class='jc'><a class="doclink"
+ * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
* </ul>
* </ul>
*/
@@ -60,8 +63,8 @@ public final class JsonSerializerContext extends SerializerContext {
* <p>
* If <jk>true</jk>, solidus (e.g. slash) characters should be escaped.
* 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>.
+ * However, if you're embedding JSON in an HTML script tag, this setting prevents confusion when trying to
+ * serialize <xt><\/script></xt>.
*/
public static final String JSON_escapeSolidus = "JsonSerializer.escapeSolidus";
@@ -75,9 +78,11 @@ public final class JsonSerializerContext extends SerializerContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred through reflection.
+ * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
+ * through reflection.
* 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.
+ * For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined from
+ * the value type.
* <p>
* When present, this value overrides the {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -100,7 +105,8 @@ public final class JsonSerializerContext extends SerializerContext {
super(ps);
simpleMode = ps.getProperty(JSON_simpleMode, boolean.class, false);
escapeSolidus = ps.getProperty(JSON_escapeSolidus, boolean.class, false);
- addBeanTypeProperties = ps.getProperty(JSON_addBeanTypeProperties, boolean.class, ps.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));
+ addBeanTypeProperties = ps.getProperty(JSON_addBeanTypeProperties, boolean.class,
+ ps.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));
}
@Override /* Context */
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
index b5e7a46..3f21ab2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
@@ -37,20 +37,21 @@ public final class JsonSerializerSession extends SerializerSession {
* Create a new session using properties specified in the context.
*
* @param ctx The context creating this session object.
- * The context contains all the configuration settings for this object.
+ * The context contains all the configuration settings for this object.
* @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.
* @param op The override properties.
- * These override any context properties defined in the context.
+ * These override any context properties defined in the context.
* @param javaMethod The java method that called this serializer, usually the method in a REST servlet.
* @param locale The session locale.
- * If <jk>null</jk>, then the locale defined on the context is used.
+ * If <jk>null</jk>, then the locale defined on the context is used.
* @param timeZone The session timezone.
- * If <jk>null</jk>, then the timezone defined on the context is used.
+ * If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
* @param uriContext The URI context.
- * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
+ * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
*/
- protected JsonSerializerSession(JsonSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ protected JsonSerializerSession(JsonSerializerContext ctx, ObjectMap op, Object output, Method javaMethod,
+ Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
super(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
if (op == null || op.isEmpty()) {
simpleMode = ctx.simpleMode;
@@ -96,6 +97,7 @@ public final class JsonSerializerSession extends SerializerSession {
Object output = getOutput();
if (output instanceof JsonWriter)
return (JsonWriter)output;
- return new JsonWriter(super.getWriter(), isUseWhitespace(), getMaxIndent(), isEscapeSolidus(), getQuoteChar(), isSimpleMode(), isTrimStrings(), getUriResolver());
+ return new JsonWriter(super.getWriter(), isUseWhitespace(), getMaxIndent(), isEscapeSolidus(), getQuoteChar(),
+ isSimpleMode(), isTrimStrings(), getUriResolver());
}
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 cc371d5..620ccf1 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
@@ -55,6 +55,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Constructor.
+ *
* @param out The writer being wrapped.
* @param useWhitespace If <jk>true</jk>, tabs and spaces will be used in output.
* @param maxIndent The maximum indentation level.
@@ -64,7 +65,8 @@ public final class JsonWriter extends SerializerWriter {
* @param trimStrings If <jk>true</jk>, strings will be trimmed before being serialized.
* @param uriResolver The URI resolver for resolving URIs to absolute or root-relative form.
*/
- protected JsonWriter(Writer out, boolean useWhitespace, int maxIndent, boolean escapeSolidus, char quoteChar, boolean laxMode, boolean trimStrings, UriResolver uriResolver) {
+ protected JsonWriter(Writer out, boolean useWhitespace, int maxIndent, boolean escapeSolidus, char quoteChar,
+ boolean laxMode, boolean trimStrings, UriResolver uriResolver) {
super(out, useWhitespace, maxIndent, trimStrings, quoteChar, uriResolver);
this.laxMode = laxMode;
this.escapeSolidus = escapeSolidus;
@@ -73,6 +75,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Serializes the specified object as a JSON string value.
+ *
* @param s The object being serialized.
* @return This object (for method chaining).
* @throws IOException Should never happen.
@@ -119,6 +122,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Serializes the specified object as a JSON attribute name.
+ *
* @param s The object being serialized.
* @return This object (for method chaining).
* @throws IOException Should never happen.
[17/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
index c820690..5026b2c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-source-element"><source></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-source-element"><source></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -54,6 +56,7 @@ public class Source extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-source-type">type</a> attribute.
* Type of embedded resource.
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
index ad4fd38..80e9cc6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-span-element"><span></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-span-element"><span></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
index 81cddb0..2ebd20e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-strong-element"><strong></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-strong-element"><strong></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
index 70a9c90..bfe9f1e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#the-style-element"><style></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/document-metadata.html#the-style-element"><style></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Style extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-style-media">media</a> attribute.
* Applicable media.
+ *
* @param media The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -43,6 +46,7 @@ public class Style extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-style-type">type</a> attribute.
* Type of embedded resource.
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
index da71570..972527e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-sub-and-sup-elements"><sub></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-sub-and-sup-elements"><sub></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
index f260819..d81a57f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-sub-and-sup-elements"><sup></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-sub-and-sup-elements"><sup></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
index caa72bb..acacb61 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#the-table-element"><table></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/tabular-data.html#the-table-element"><table></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -31,7 +33,7 @@ public class Table extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-table-border">border</a> attribute.
- * //sortable - Enables a sorting interface for the table.
+ *
* @param border The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
index 94bb728..37e5f1b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#the-tbody-element"><tbody></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/tabular-data.html#the-tbody-element"><tbody></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
index b249270..2a9f9f0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#the-td-element"><td></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/tabular-data.html#the-td-element"><td></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Td extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-colspan">colspan</a> attribute.
* Number of columns that the cell is to span.
+ *
* @param colspan The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -44,6 +47,7 @@ public class Td extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-headers">headers</a> attribute.
* The header cells for this cell.
+ *
* @param headers The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -55,6 +59,7 @@ public class Td extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-rowspan">rowspan</a> attribute.
* Number of rows that the cell is to span.
+ *
* @param rowspan The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
index 2d02349..7855e89 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#the-template-element"><template></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/scripting-1.html#the-template-element"><template></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
index ebc5d1f..18223e2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-textarea-element"><textarea></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-textarea-element"><textarea></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -31,7 +33,8 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autocomplete">autocomplete</a> attribute.
- * Hint for form autofill feature.
+ * Hint for form auto-fill feature.
+ *
* @param autocomplete The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -43,6 +46,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus">autofocus</a> attribute.
* Automatically focus the form control when the page is loaded.
+ *
* @param autofocus The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -55,6 +59,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-cols">cols</a> attribute.
* Maximum number of characters per line.
+ *
* @param cols The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -67,6 +72,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-dirname">dirname</a> attribute.
* Name of form field to use for sending the element's directionality in form submission.
+ *
* @param dirname The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -78,6 +84,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled">disabled</a> attribute.
* Whether the form control is disabled.
+ *
* @param disabled The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -90,6 +97,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
* Associates the control with a form element.
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -99,8 +107,9 @@ public class Textarea extends HtmlElementRawText {
}
/**
- * <a class="doclink" href="-">inputmode</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#inputmode">inputmode</a> attribute.
* Hint for selecting an input modality.
+ *
* @param inputmode The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -112,6 +121,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-maxlength">maxlength</a> attribute.
* Maximum length of value.
+ *
* @param maxlength The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -124,6 +134,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-minlength">minlength</a> attribute.
* Minimum length of value.
+ *
* @param minlength The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -136,6 +147,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
* Name of form control to use for form submission and in the form.elements API.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -145,8 +157,10 @@ public class Textarea extends HtmlElementRawText {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-placeholder">placeholder</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-placeholder">placeholder</a>
+ * attribute.
* User-visible label to be placed within the form control.
+ *
* @param placeholder The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -158,6 +172,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-readonly">readonly</a> attribute.
* Whether to allow the value to be edited by the user.
+ *
* @param readonly The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -170,6 +185,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-required">required</a> attribute.
* Whether the control is required for form submission.
+ *
* @param required The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -182,6 +198,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-rows">rows</a> attribute.
* Number of lines to show.
+ *
* @param rows The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -194,6 +211,7 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-wrap">wrap</a> attribute.
* How the value of the form control is to be wrapped for form submission.
+ *
* @param wrap The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
index c59a34d..0cc8488 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#the-tfoot-element"><tfoot></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/tabular-data.html#the-tfoot-element"><tfoot></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
index a069786..4e3ee7c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#the-th-element"><th></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/tabular-data.html#the-th-element"><th></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-th-abbr">abbr</a> attribute.
* Alternative label to use for the header cell when referencing the cell in other contexts.
+ *
* @param abbr The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -43,6 +46,7 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-colspan">colspan</a> attribute.
* Number of columns that the cell is to span.
+ *
* @param colspan The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -55,6 +59,7 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-headers">headers</a> attribute.
* The headers for this cell.
+ *
* @param headers The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -66,6 +71,7 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-rowspan">rowspan</a> attribute.
* Number of rows that the cell is to span.
+ *
* @param rowspan The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -78,6 +84,7 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-th-scope">scope</a> attribute.
* Specifies which cells the header cell applies to.
+ *
* @param scope The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -89,6 +96,7 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="-">sorted</a> attribute.
* Column sort direction and ordinality.
+ *
* @param sorted The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
index 64343a6..5c945be 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#the-thead-element"><thead></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/tabular-data.html#the-thead-element"><thead></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
index 5738cd8..52cfa51 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-time-element"><time></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-time-element"><time></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -30,8 +32,10 @@ import org.apache.juneau.annotation.*;
public class Time extends HtmlElementMixed {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#attr-time-datetime">datetime</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#attr-time-datetime">datetime</a>
+ * attribute.
* Machine-readable value.
+ *
* @param datetime The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
index 63247cb..72e4093 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#the-title-element"><title></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/document-metadata.html#the-title-element"><title></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
index 5293983..a31636f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#the-tr-element"><tr></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/tabular-data.html#the-tr-element"><tr></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
index 09c7d57..fabb327 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-track-element"><track></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-track-element"><track></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -34,8 +36,10 @@ import org.apache.juneau.annotation.*;
public class Track extends HtmlElementVoid {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-track-default">default</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-track-default">default</a>
+ * attribute.
* Enable the track if no other text track is more suitable.
+ *
* @param _default The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -47,6 +51,7 @@ public class Track extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-track-kind">kind</a> attribute.
* The type of text track.
+ *
* @param kind The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -58,6 +63,7 @@ public class Track extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-track-label">label</a> attribute.
* User-visible label.
+ *
* @param label The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -85,8 +91,10 @@ public class Track extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-track-srclang">srclang</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-track-srclang">srclang</a>
+ * attribute.
* Language of the text track.
+ *
* @param srclang The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
index 7176612..b66c872 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-u-element"><u></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-u-element"><u></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
index f6969fb..9a86da5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-ul-element"><ul></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-ul-element"><ul></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
index 4a4fc9a..049c220 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-var-element"><var></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-var-element"><var></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
index 7e4c6a2..93b9802 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-video-element"><video></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-video-element"><video></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -34,8 +36,10 @@ import org.apache.juneau.annotation.*;
public class Video extends HtmlElementContainer {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-autoplay">autoplay</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-autoplay">autoplay</a>
+ * attribute.
* Hint that the media resource can be started automatically when the page is loaded.
+ *
* @param autoplay The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -46,8 +50,10 @@ public class Video extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-controls">controls</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-controls">controls</a>
+ * attribute.
* Show user agent controls.
+ *
* @param controls The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -58,8 +64,10 @@ public class Video extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-crossorigin">crossorigin</a> attribute.
- * How the element handles crossorigin requests.
+ * <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-crossorigin">crossorigin</a> attribute.
+ * How the element handles cross-origin requests.
+ *
* @param crossorigin The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -69,8 +77,10 @@ public class Video extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
+ * attribute.
* Vertical dimension.
+ *
* @param height The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -83,6 +93,7 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-loop">loop</a> attribute.
* Whether to loop the media resource.
+ *
* @param loop The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -93,8 +104,10 @@ public class Video extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-mediagroup">mediagroup</a> attribute.
+ * <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-mediagroup">mediagroup</a> attribute.
* Groups media elements together with an implicit MediaController.
+ *
* @param mediagroup The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -104,8 +117,10 @@ public class Video extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-muted">muted</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-muted">muted</a>
+ * attribute.
* Whether to mute the media resource by default.
+ *
* @param muted The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -116,8 +131,10 @@ public class Video extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-video-poster">poster</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-video-poster">poster</a>
+ * attribute.
* Poster frame to show prior to video playback.
+ *
* @param poster The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -127,8 +144,10 @@ public class Video extends HtmlElementContainer {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-preload">preload</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-preload">preload</a>
+ * attribute.
* Hints how much buffering the media resource will likely need.
+ *
* @param preload The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -158,6 +177,7 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
* Horizontal dimension.
+ *
* @param width The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
index bff2e63..8a6612d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-wbr-element"><wbr></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-wbr-element"><wbr></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/package.html b/juneau-core/src/main/java/org/apache/juneau/dto/html5/package.html
index aa362c4..2529d7f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/package.html
@@ -70,7 +70,9 @@
<h2 class='topic' onclick='toggle(this)'>1 - Overview</h2>
<div class='topic'>
<p>
- Juneau supports generation and consumption of HTML5 documents and fragments through the use of DTOs (Data Transfer Objects).<br>
+ Juneau supports generation and consumption of HTML5 documents and fragments through the use of DTOs (Data
+ Transfer Objects).
+ <br>
It uses existing support for serializing and parsing POJOs to and from HTML to define these HTML objects.
</p>
@@ -81,8 +83,8 @@
<div class='topic'>
<p>
The Juneau HTML5 DTOs are simply beans with fluent-style setters that allow you to quickly construct HTML
- fragments as Java objects. These object can then be serialized to HTML using one of the existing HTML serializers,
- or to other languages such as JSON using the JSON serializers.
+ fragments as Java objects. These object can then be serialized to HTML using one of the existing HTML
+ serializers, or to other languages such as JSON using the JSON serializers.
</p>
<p>
The {@link org.apache.juneau.dto.html5.HtmlBuilder} class is a utility class with predefined static methods
@@ -192,8 +194,10 @@
Object myform =
<jsm>form</jsm>().action(<js>"/submit"</js>).method(<js>"POST"</js>)
.children(
- <js>"Position (1-10000): "</js>, <jsm>input</jsm>(<js>"number"</js>).name(<js>"pos"</js>).value(1), <jsm>br</jsm>(),
- <js>"Limit (1-10000): "</js>, <jsm>input</jsm>(<js>"number"</js>).name(<js>"limit"</js>).value(100), <jsm>br</jsm>(),
+ <js>"Position (1-10000): "</js>,
+ <jsm>input</jsm>(<js>"number"</js>).name(<js>"pos"</js>).value(1), <jsm>br</jsm>(),
+ <js>"Limit (1-10000): "</js>,
+ <jsm>input</jsm>(<js>"number"</js>).name(<js>"limit"</js>).value(100), <jsm>br</jsm>(),
<jsm>button</jsm>(<js>"submit"</js>, <js>"Submit"</js>),
<jsm>button</jsm>(<js>"reset"</js>, <js>"Reset"</js>)
);
@@ -202,8 +206,10 @@
</td>
<td class='code'><xt>
<form <xa>action</xa>=<xs>'/submit'</xs> <xa>method</xa>=<xs>'POST'</xs>>
- <xv>Position (1-10000):</xv> <input <xa>name</xa>=<xs>'pos'</xs> <xa>type</xa>=<xs>'number'</xs> <xa>value</xa>=<xs>'1'</xs>/><br/>
- <xv>Limit (1-10000):</xv> <input <xa>name</xa>=<xs>'pos'</xs> <xa>type</xa>=<xs>'number'</xs> <xa>value</xa>=<xs>'100'</xs>/><br/>
+ <xv>Position (1-10000):</xv> <input <xa>name</xa>=<xs>'pos'</xs>
+ <xa>type</xa>=<xs>'number'</xs> <xa>value</xa>=<xs>'1'</xs>/><br/>
+ <xv>Limit (1-10000):</xv> <input <xa>name</xa>=<xs>'pos'</xs>
+ <xa>type</xa>=<xs>'number'</xs> <xa>value</xa>=<xs>'100'</xs>/><br/>
<button <xa>type</xa>=<xs>'submit'</xs>><xv>Submit</xv></button>
<button <xa>type</xa>=<xs>'reset'</xs>><xv>Reset</xv></button>
</form>
@@ -240,11 +246,14 @@
you may want to consider using HTML5 templates.
Broadly speaking, a template is simply a bean that gets swapped out with another more complex bean during
serialization.
- Juneau doesn't have a built-in concept of a "template", but rather has features that allow them to be defined using existing swap support.
+ Juneau doesn't have a built-in concept of a "template", but rather has features that allow them to be
+ defined using existing swap support.
</p>
<p>
- The following example shows how an HTML5 form template object can be created that gets serialized as a populated HTML5 {@link org.apache.juneau.dto.html5.Form} bean.
- It takes advantage of the special <code>swap(BeanSession)</code> method that serializers will use to convert the object to a serialized form before serialization.
+ The following example shows how an HTML5 form template object can be created that gets serialized as a
+ populated HTML5 {@link org.apache.juneau.dto.html5.Form} bean.
+ It takes advantage of the special <code>swap(BeanSession)</code> method that serializers will use to
+ convert the object to a serialized form before serialization.
The return type of this method can be any serializable type.
In this case, we are defining a template for a reusable HTML form with two simple fields.
This gets serialized as an HTML form.
@@ -288,7 +297,8 @@
</form>
</xt></p>
<p>
- Support for parsing back into the template class can be accomplished by adding an unswap method or constructor.
+ Support for parsing back into the template class can be accomplished by adding an unswap method or
+ constructor.
</p>
<p class='bcode'>
<jk>import static</jk> org.apache.juneau.dto.html5.HtmlBuilder.*;
@@ -307,8 +317,10 @@
<jc>// Our 'unswap' constructor</jc>
<jk>public</jk> FormTemplate(Form f) {
<jk>this</jk>.<jf>action</jf> = f.getAttr(<js>"action"</js>);
- <jk>this</jk>.<jf>value1</jf> = f.getChild(Input.<jk>class</jk>, 0).getAttr(<jk>int</jk>.<jk>class</jk>, <js>"value"</js>);
- <jk>this</jk>.<jf>value2</jf> = f.getChild(Input.<jk>class</jk>, 1).getAttr(<jk>boolean</jk>.<jk>class</jk>, <js>"value"</js>);
+ <jk>this</jk>.<jf>value1</jf> = f.getChild(Input.<jk>class</jk>, 0)
+ .getAttr(<jk>int</jk>.<jk>class</jk>, <js>"value"</js>);
+ <jk>this</jk>.<jf>value2</jf> = f.getChild(Input.<jk>class</jk>, 1)
+ .getAttr(<jk>boolean</jk>.<jk>class</jk>, <js>"value"</js>);
}
<jk>public</jk> FormTemplate(String action, <jk>int</jk> value1, <jk>boolean</jk> value2) {
@@ -326,7 +338,8 @@
}
</p>
<p>
- Refer to <a class='doclink' href='../../../../../overview-summary.html#Core.SwapMethods'>Swap methods</a> for information about defining swap methods on classes.
+ Refer to <a class='doclink' href='../../../../../overview-summary.html#Core.SwapMethods'>Swap methods</a>
+ for information about defining swap methods on classes.
</p>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
index c1abb91..26a8d4e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
@@ -27,9 +27,11 @@ package org.apache.juneau.dto.jsonschema;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>
+ * JSON-Schema</a>
* </ul>
* <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
index 39cc98f..3cd6569 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
@@ -20,9 +20,11 @@ import java.util.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * <li class='sublink'><a class='doclink'
+ * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
* </ul>
* <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
index 550a0b2..1f33d4c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
@@ -30,9 +30,11 @@ import org.apache.juneau.transform.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * <li class='sublink'><a class='doclink'
+ * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
* </ul>
* <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
* </ul>
@@ -228,7 +230,8 @@ public class Schema {
* <p>
* Convenience method for returning the <property>type</property> property when it is a {@link JsonType} value.
*
- * @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link JsonTypeArray}.
+ * @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a
+ * {@link JsonTypeArray}.
*/
@BeanIgnore
public JsonType getTypeAsJsonType() {
@@ -264,7 +267,9 @@ public class Schema {
else if (type instanceof JsonTypeArray)
this.typeJsonTypeArray = (JsonTypeArray)type;
else
- throw new BeanRuntimeException(SchemaProperty.class, "Invalid attribute type ''{0}'' passed in. Must be one of the following: SimpleType, SimpleTypeArray", type.getClass().getName());
+ throw new BeanRuntimeException(SchemaProperty.class,
+ "Invalid attribute type ''{0}'' passed in. Must be one of the following: SimpleType, SimpleTypeArray",
+ type.getClass().getName());
}
return this;
}
@@ -299,7 +304,11 @@ public class Schema {
@Override /* PojoSwap */
public Object unswap(BeanSession session, Object o, ClassMeta<?> hint) throws ParseException {
- ClassMeta<?> cm = (o instanceof Collection ? session.getClassMeta(JsonTypeArray.class) : session.getClassMeta(JsonType.class));
+ ClassMeta<?> cm = (
+ o instanceof Collection
+ ? session.getClassMeta(JsonTypeArray.class)
+ : session.getClassMeta(JsonType.class)
+ );
return session.convertToType(o, cm);
}
}
@@ -307,7 +316,8 @@ public class Schema {
/**
* Bean property getter: <property>definitions</property>.
*
- * @return The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Map<String,Schema> getDefinitions() {
return definitions;
@@ -364,9 +374,10 @@ public class Schema {
/**
* Returns the property with the specified name.
* If <property>resolve</property> is <jk>true</jk>, the property object will automatically be
- * resolved by calling {@link #resolve()}.
+ * resolved by calling {@link #resolve()}.
* Therefore, <property>getProperty(name, <jk>true</jk>)</property> is equivalent to calling
- * <property>getProperty(name).resolve()</property>, except it's safe from a potential <property>NullPointerException</property>.
+ * <property>getProperty(name).resolve()</property>, except it's safe from a potential
+ * <property>NullPointerException</property>.
*
* @param name The property name.
* @param resolve If <jk>true</jk>, calls {@link #resolve()} on object before returning.
@@ -414,7 +425,8 @@ public class Schema {
this.properties = new LinkedHashMap<String,Schema>();
for (Schema p : properties) {
if (p.getName() == null)
- throw new BeanRuntimeException(Schema.class, "Invalid property passed to Schema.addProperties(). Property name was null.");
+ throw new BeanRuntimeException(Schema.class,
+ "Invalid property passed to Schema.addProperties(). Property name was null.");
setMasterOn(p);
this.properties.put(p.getName(), p);
}
@@ -424,7 +436,8 @@ public class Schema {
/**
* Bean property getter: <property>patternProperties</property>.
*
- * @return The value of the <property>patternProperties</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>patternProperties</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Map<String,Schema> getPatternProperties() {
return patternProperties;
@@ -461,7 +474,8 @@ public class Schema {
this.patternProperties = new LinkedHashMap<String,Schema>();
for (Schema p : properties) {
if (p.getName() == null)
- throw new BeanRuntimeException(Schema.class, "Invalid property passed to Schema.addProperties(). Property name was null.");
+ throw new BeanRuntimeException(Schema.class,
+ "Invalid property passed to Schema.addProperties(). Property name was null.");
setMasterOn(p);
this.patternProperties.put(p.getName(), p);
}
@@ -471,7 +485,8 @@ public class Schema {
/**
* Bean property getter: <property>dependencies</property>.
*
- * @return The value of the <property>dependencies</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>dependencies</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Map<String,Schema> getDependencies() {
return dependencies;
@@ -559,7 +574,11 @@ public class Schema {
@Override /* PojoSwap */
public Object unswap(BeanSession session, Object o, ClassMeta<?> hint) throws ParseException {
- ClassMeta<?> cm = (o instanceof Collection ? session.getClassMeta(SchemaArray.class) : session.getClassMeta(Schema.class));
+ ClassMeta<?> cm = (
+ o instanceof Collection
+ ? session.getClassMeta(SchemaArray.class)
+ : session.getClassMeta(Schema.class)
+ );
return session.convertToType(o, cm);
}
}
@@ -583,7 +602,9 @@ public class Schema {
this.itemsSchemaArray = (SchemaArray)items;
setMasterOn(this.itemsSchemaArray);
} else
- throw new BeanRuntimeException(SchemaProperty.class, "Invalid attribute type ''{0}'' passed in. Must be one of the following: Schema, SchemaArray", items.getClass().getName());
+ throw new BeanRuntimeException(SchemaProperty.class,
+ "Invalid attribute type ''{0}'' passed in. Must be one of the following: Schema, SchemaArray",
+ items.getClass().getName());
}
return this;
}
@@ -645,7 +666,8 @@ public class Schema {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
*
- * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean isExclusiveMaximum() {
return exclusiveMaximum;
@@ -685,7 +707,8 @@ public class Schema {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
*
- * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean isExclusiveMinimum() {
return exclusiveMinimum;
@@ -765,7 +788,8 @@ public class Schema {
/**
* Bean property getter: <property>additionalItems</property>.
*
- * @return The value of the <property>additionalItems</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>additionalItems</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
* Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it.
*/
@BeanProperty(swap=BooleanOrSchemaArraySwap.class)
@@ -778,7 +802,8 @@ public class Schema {
/**
* Bean property getter: <property>additionalItems</property>.
* <p>
- * Convenience method for returning the <property>additionalItems</property> property when it is a {@link Boolean} value.
+ * Convenience method for returning the <property>additionalItems</property> property when it is a {@link Boolean}
+ * value.
*
* @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link SchemaArray}.
*/
@@ -790,7 +815,8 @@ public class Schema {
/**
* Bean property getter: <property>additionalItems</property>.
* <p>
- * Convenience method for returning the <property>additionalItems</property> property when it is a {@link SchemaArray} value.
+ * Convenience method for returning the <property>additionalItems</property> property when it is a
+ * {@link SchemaArray} value.
*
* @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link Boolean}.
*/
@@ -817,7 +843,9 @@ public class Schema {
this.additionalItemsSchemaArray = (SchemaArray)additionalItems;
setMasterOn(this.additionalItemsSchemaArray);
} else
- throw new BeanRuntimeException(SchemaProperty.class, "Invalid attribute type ''{0}'' passed in. Must be one of the following: Boolean, SchemaArray", additionalItems.getClass().getName());
+ throw new BeanRuntimeException(SchemaProperty.class,
+ "Invalid attribute type ''{0}'' passed in. Must be one of the following: Boolean, SchemaArray",
+ additionalItems.getClass().getName());
}
return this;
}
@@ -825,7 +853,8 @@ public class Schema {
/**
* Bean property appender: <property>additionalItems</property>.
*
- * @param additionalItems The list of items to append to the <property>additionalItems</property> property on this bean.
+ * @param additionalItems The list of items to append to the <property>additionalItems</property> property on this
+ * bean.
* @return This object (for method chaining).
*/
public Schema addAdditionalItems(Schema...additionalItems) {
@@ -853,7 +882,11 @@ public class Schema {
@Override /* PojoSwap */
public Object unswap(BeanSession session, Object o, ClassMeta<?> hint) throws ParseException {
- ClassMeta<?> cm = (o instanceof Collection ? session.getClassMeta(SchemaArray.class) : session.getClassMeta(Boolean.class));
+ ClassMeta<?> cm = (
+ o instanceof Collection
+ ? session.getClassMeta(SchemaArray.class)
+ : session.getClassMeta(Boolean.class)
+ );
return session.convertToType(o, cm);
}
}
@@ -901,7 +934,8 @@ public class Schema {
/**
* Bean property getter: <property>uniqueItems</property>.
*
- * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Boolean getUniqueItems() {
return uniqueItems;
@@ -921,7 +955,8 @@ public class Schema {
/**
* Bean property getter: <property>maxProperties</property>.
*
- * @return The value of the <property>maxProperties</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>maxProperties</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Integer getMaxProperties() {
return maxProperties;
@@ -941,7 +976,8 @@ public class Schema {
/**
* Bean property getter: <property>minProperties</property>.
*
- * @return The value of the <property>minProperties</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>minProperties</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Integer getMinProperties() {
return minProperties;
@@ -1023,7 +1059,8 @@ public class Schema {
/**
* Bean property getter: <property>additionalProperties</property>.
*
- * @return The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it
+ * is not set.
* Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it.
*/
@BeanProperty(swap=BooleanOrSchemaSwap.class)
@@ -1036,7 +1073,8 @@ public class Schema {
/**
* Bean property getter: <property>additionalProperties</property>.
* <p>
- * Convenience method for returning the <property>additionalProperties</property> property when it is a {@link Boolean} value.
+ * Convenience method for returning the <property>additionalProperties</property> property when it is a
+ * {@link Boolean} value.
*
* @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link Schema}.
*/
@@ -1048,7 +1086,8 @@ public class Schema {
/**
* Bean property getter: <property>additionalProperties</property>.
* <p>
- * Convenience method for returning the <property>additionalProperties</property> property when it is a {@link Schema} value.
+ * Convenience method for returning the <property>additionalProperties</property> property when it is a
+ * {@link Schema} value.
*
* @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link Boolean}.
*/
@@ -1076,7 +1115,9 @@ public class Schema {
this.additionalPropertiesSchema = (Schema)additionalProperties;
setMasterOn(this.additionalPropertiesSchema);
} else
- throw new BeanRuntimeException(SchemaProperty.class, "Invalid attribute type ''{0}'' passed in. Must be one of the following: Boolean, Schema", additionalProperties.getClass().getName());
+ throw new BeanRuntimeException(SchemaProperty.class,
+ "Invalid attribute type ''{0}'' passed in. Must be one of the following: Boolean, Schema",
+ additionalProperties.getClass().getName());
}
return this;
}
@@ -1098,7 +1139,11 @@ public class Schema {
@Override /* PojoSwap */
public Object unswap(BeanSession session, Object o, ClassMeta<?> hint) throws ParseException {
- ClassMeta<?> cm = (o instanceof Boolean ? session.getClassMeta(Boolean.class) : session.getClassMeta(Schema.class));
+ ClassMeta<?> cm = (
+ o instanceof Boolean
+ ? session.getClassMeta(Boolean.class)
+ : session.getClassMeta(Schema.class)
+ );
return session.convertToType(o, cm);
}
}
@@ -1362,9 +1407,9 @@ public class Schema {
}
/**
* If this schema is a reference to another schema (i.e. has its <property>$ref</property> property set),
- * this method will retrieve the referenced schema from the schema map registered with this schema.
+ * this method will retrieve the referenced schema from the schema map registered with this schema.
* If this schema is not a reference, or no schema map is registered with this schema, this method
- * is a no-op and simply returns this object.
+ * is a no-op and simply returns this object.
*
* @return The referenced schema, or <jk>null</jk>.
*/
@@ -1376,7 +1421,7 @@ public class Schema {
/**
* Associates a schema map with this schema for resolving other schemas identified
- * through <property>$ref</property> properties.
+ * through <property>$ref</property> properties.
*
* @param schemaMap The schema map to associate with this schema. Can be <jk>null</jk>.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
index a40d0a0..8153307 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
@@ -20,9 +20,11 @@ import java.util.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * <li class='sublink'><a class='doclink'
+ * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
* </ul>
* <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
* </ul>
@@ -46,8 +48,7 @@ public class SchemaArray extends LinkedList<Schema> {
}
/**
- * Convenience method for adding one or more {@link Schema} objects to
- * this array.
+ * Convenience method for adding one or more {@link Schema} objects to this array.
*
* @param schemas The {@link Schema} objects to add to this array.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
index 98a06f5..1c9c38d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
@@ -31,9 +31,11 @@ import org.apache.juneau.json.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * <li class='sublink'><a class='doclink'
+ * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
* </ul>
* <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
* </ul>
@@ -72,7 +74,7 @@ public abstract class SchemaMap extends ConcurrentHashMap<URI,Schema> {
}
/**
- * Convenience method for prepopulating this map with the specified schemas.
+ * Convenience method for pre-populating this map with the specified schemas.
* <p>
* The schemas passed in through this method MUST have their ID properties set.
*
@@ -95,7 +97,8 @@ public abstract class SchemaMap extends ConcurrentHashMap<URI,Schema> {
* It's up to the implementer to decide where these come from.
* <p>
* The default implementation calls {@link #getReader(URI)} and parses the schema document.
- * If {@link #getReader(URI)} returns <jk>null</jk>, this method returns <jk>null</jk> indicating this is an unreachable document.
+ * If {@link #getReader(URI)} returns <jk>null</jk>, this method returns <jk>null</jk> indicating this is an
+ * unreachable document.
*
* @param uri The URI to load the schema from.
* @return The parsed schema.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
index fa3963d..4a84cbd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
@@ -18,9 +18,11 @@ package org.apache.juneau.dto.jsonschema;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * <li class='sublink'><a class='doclink'
+ * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
* </ul>
* <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
index 52ae162..b1c6d53 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
@@ -27,9 +27,11 @@ package org.apache.juneau.dto.jsonschema;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * <li class='sublink'><a class='doclink'
+ * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
* </ul>
* <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
index ef1a8e1..cc02fe8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
@@ -27,9 +27,11 @@ import org.apache.juneau.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * <li class='sublink'><a class='doclink'
+ * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
* </ul>
* <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
* </ul>
[05/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/urlencoding/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/package.html b/juneau-core/src/main/java/org/apache/juneau/urlencoding/package.html
index 445bcc6..a2e8c15 100644
--- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/package.html
@@ -75,17 +75,6 @@
<li><p><a class='doclink' href='#ParserConfigurableProperties'>Configurable properties</a></p>
<li><p><a class='doclink' href='#ParserOtherNotes'>Other notes</a></p>
</ol>
- <li><p><a class='doclink' href='#RestApiSupport'>REST API support</a></p>
- <ol>
- <li><p><a class='doclink' href='#RestServerSupport'>REST server support</a></p>
- <ol>
- <li><p><a class='doclink' href='#RestServletDefault'>Using RestServletDefault</a></p>
- <li><p><a class='doclink' href='#RestServlet'>Using RestServlet with annotations</a></p>
- <li><p><a class='doclink' href='#DefaultProvider'>Using JAX-RS DefaultProvider</a></p>
- <li><p><a class='doclink' href='#BaseProvider'>Using JAX-RS BaseProvider with annotations</a></p>
- </ol>
- <li><p><a class='doclink' href='#RestClientSupport'>REST client support</a></p>
- </ol>
</ol>
<!-- ======================================================================================================== -->
@@ -93,9 +82,14 @@
<h2 class='topic' onclick='toggle(this)'>1 - URL encoding support overview</h2>
<div class='topic'>
<p>
- Juneau supports converting arbitrary POJOs to and from URL-encoded strings using ultra-efficient serializers and parsers.<br>
- The serializer converts POJOs directly to URL-encoded strings without the need for intermediate DOM objects using a highly-efficient state machine.<br>
- Likewise, the parser creates POJOs directly from URL-encoded strings without the need for intermediate DOM objects.
+ Juneau supports converting arbitrary POJOs to and from URL-encoded strings using ultra-efficient serializers
+ and parsers.
+ <br>
+ The serializer converts POJOs directly to URL-encoded strings without the need for intermediate DOM objects
+ using a highly-efficient state machine.
+ <br>
+ Likewise, the parser creates POJOs directly from URL-encoded strings without the need for intermediate DOM
+ objects.
</p>
<p>
Juneau uses UON (URL-Encoded Object Notation) for representing POJOs.
@@ -105,15 +99,20 @@
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>, <code>Float</code>).
- <li>Java Collections Framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything on this list.
+ <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 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 <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 serializable forms.
+ <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
+ 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.
+ 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>
@@ -126,16 +125,19 @@
<h3 class='topic' onclick='toggle(this)'>1.1 - URL-encoding support overview - example</h3>
<div class='topic'>
<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> containing
- zero or more <code>Address</code> beans.
+ 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>
+ containing zero or more <code>Address</code> beans.
</p>
<p>
When you point a browser at <code>/sample/addressBook/people/1</code>, the POJO is rendered as HTML:
</p>
<img class='bordered' src="doc-files/Example_HTML.png">
<p>
- By appending <code>?Accept=application/x-www-form-urlencoded&plainText=true</code> to the URL, you can view the data as a URL-encoded string:
+ By appending <code>?Accept=application/x-www-form-urlencoded&plainText=true</code> to the URL, you can
+ view the data as a URL-encoded string:
</p>
<p class='bcode'>
<un>0</un>=(
@@ -204,8 +206,10 @@
Juneau supports two kinds of serialization:
</p>
<ul class='spaced-list'>
- <li>Construction of full URL query parameter strings (e.g. <code>&key=value</code> pairs) from beans and maps.
- <li>Construction of URL query parameter value strings (e.g. just the <code>value</code> portion of <code>&key=value</code> pairs) from any POJO.
+ <li>Construction of full URL query parameter strings (e.g. <code>&key=value</code> pairs) from beans
+ and maps.
+ <li>Construction of URL query parameter value strings (e.g. just the <code>value</code> portion of
+ <code>&key=value</code> pairs) from any POJO.
</ul>
<p>
Top-level beans and maps can serialized as key/value pairs as shown below:
@@ -215,8 +219,9 @@
http://localhost/sample?<ua>foo</ua>=<us>bar</us>&<ua>baz</ua>=<us>bing</us>
</p>
<p>
- Lower-level beans and maps are also serialized as key/value pairs, but are surrounded with a <js>"(...)"</js> construct to denote an object mapping,
- and uses a comma as the parameter delimiter instead of <js>"&"</js>.<br>
+ Lower-level beans and maps are also serialized as key/value pairs, but are surrounded with a
+ <js>"(...)"</js> construct to denote an object mapping, and uses a comma as the parameter delimiter
+ instead of <js>"&"</js>.
</p>
<h6 class='figure'>Example: A bean serialized as a query parameter value.</h6>
<p class='bcode'>
@@ -280,8 +285,10 @@
<p>
Refer to the <a href='doc-files/rfc_uon.txt'>UON specification</a> for a complete set of syntax rules.
<p>
- <code>PojoSwaps</code> can be used to convert non-serializable POJOs into serializable forms, such as converting
- <code>Calendar</code> object to ISO8601 strings, or <code><uk>byte</uk>[]</code> arrays to Base-64 encoded strings.<br>
+ <code>PojoSwaps</code> can be used to convert non-serializable POJOs into serializable forms, such as
+ converting <code>Calendar</code> object to ISO8601 strings, or <code><uk>byte</uk>[]</code> arrays to
+ Base-64 encoded strings.
+ <br>
These transforms can be associated at various levels:
</p>
<ul class='spaced-list'>
@@ -294,7 +301,8 @@
http://localhost/sample?<ua>a1=<us>'Sun,+03+Mar+1901+09:05:06+GMT'</us>
</p>
<p>
- For more information about transforms, refer to <a class='doclink' href='../transform/package-summary.html#TOC'>org.apache.juneau.transform</a>.
+ For more information about transforms, refer to <a class='doclink'
+ href='../transform/package-summary.html#TOC'>org.apache.juneau.transform</a>.
</p>
</div>
@@ -305,22 +313,31 @@
<h2 class='topic' onclick='toggle(this)'>2 - UrlEncodingSerializer and UonSerializer classes</h2>
<div class='topic'>
<p>
- {@link org.apache.juneau.urlencoding.UrlEncodingSerializer} and {@link org.apache.juneau.uon.UonSerializer} classes are used to convert POJOs to URL-encoded strings.<br>
+ {@link org.apache.juneau.urlencoding.UrlEncodingSerializer} and {@link org.apache.juneau.uon.UonSerializer}
+ classes are used to convert POJOs to URL-encoded strings.
+ <br>
The <code>UonSerializer</code> class converts parameter values to UON notation.
- The <code>UrlEncodingSerializer</code> class converts a POJO to key/value URL-Encoded pairs using <code>UonSerializer</code> to serialize the values.
+ The <code>UrlEncodingSerializer</code> class converts a POJO to key/value URL-Encoded pairs using
+ <code>UonSerializer</code> to serialize the values.
If you're trying to construct complete URL-Encoded entities, use <code>UrlEncodingSerializer</code>.
If you're constructing your own key/value pairs, use <code>UonSerializer</code>.
</p>
<p>
- The serializers include several configurable settings.<br>
+ The serializers include several configurable settings.
+ <br>
Static reusable instances of serializers are provided with commonly-used settings:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT} - All default settings, strict mode.
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT_READABLE} - Use whitespace and indentation for readability.
- <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT} - All default settings, strict mode.
- <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_READABLE} - Use whitespace and indentation for readability.
- <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_ENCODING} - Same as DEFAULT, but use URL-Encoding on special characters.
+ <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT}
+ - All default settings, strict mode.
+ <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT_READABLE}
+ - Use whitespace and indentation for readability.
+ <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT}
+ - All default settings, strict mode.
+ <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_READABLE}
+ - Use whitespace and indentation for readability.
+ <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_ENCODING}
+ - Same as DEFAULT, but use URL-Encoding on special characters.
</ul>
<p>
The general guidelines on which serializer to use is:
@@ -328,15 +345,17 @@
<ul class='spaced-list'>
<li>Use encoding serializers when you're using the results to construct a URI yourself, and therefore
need invalid URI characters to be encoded.
- <li>Use unencoding serializers when you're creating parameter values and passing them off to some other
+ <li>Use un-encoding serializers when you're creating parameter values and passing them off to some other
utility class that will itself encode invalid URI characters.
<li>Use the readable serializer for debugging purposes.
</ul>
<h6 class='topic'>Notes about examples</h6>
<p>
- The examples shown in this document will use default strict settings.<br>
- For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples.<br>
+ The examples shown in this document will use default strict 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.
</p>
<p>
@@ -395,7 +414,8 @@
<ua>id</ua>=<un>1</un>&<ua>name</ua>=<us>'John+Smith'</us>
</p>
<p>
- By default, the <code>UrlEncodingSerializer</code> class will URL-Encode special characters, and the <code>UonSerializer</code> will NOT URL-encode special characters.
+ By default, the <code>UrlEncodingSerializer</code> class will URL-Encode special characters, and the
+ <code>UonSerializer</code> will NOT URL-encode special characters.
</p>
@@ -404,21 +424,27 @@
<h3 class='topic' onclick='toggle(this)'>2.1 - @Bean and @BeanProperty annotations</h3>
<div class='topic'>
<p>
- 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>
+ 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:
</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 transforms at both the class and property level (to convert non-serializable POJOs to serializable forms).
+ <li>Associating transforms 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 transform 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>
+ 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 transforms, we can convert them to standardized string forms.
</p>
<p class='bcode'>
@@ -435,13 +461,16 @@
<jk>public</jk> Person() {}
<jc>// Normal constructor</jc>
- <jk>public</jk> Person(<jk>int</jk> id, String name, String uri, String addressBookUri, String birthDate) <jk>throws</jk> Exception {
+ <jk>public</jk> Person(<jk>int</jk> id, String name, String uri, String addressBookUri, String birthDate)
+ <jk>throws</jk> Exception {
<jk>this</jk>.<jf>id</jf> = id;
<jk>this</jk>.<jf>name</jf> = name;
<jk>this</jk>.<jf>uri</jf> = <jk>new</jk> URI(uri);
<jk>this</jk>.<jf>addressBookUri</jf> = <jk>new</jk> URI(addressBookUri);
<jk>this</jk>.<jf>birthDate</jf> = <jk>new</jk> GregorianCalendar();
- <jk>this</jk>.<jf>birthDate</jf>.setTime(DateFormat.<jsm>getDateInstance</jsm>(DateFormat.<jsf>MEDIUM</jsf>).parse(birthDate));
+ <jk>this</jk>.<jf>birthDate</jf>
+ .setTime(DateFormat.<jsm>getDateInstance</jsm>(DateFormat.<jsf>MEDIUM</jsf>)
+ .parse(birthDate));
}
}
</p>
@@ -450,23 +479,27 @@
</p>
<p class='bcode'>
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
</p>
<p>
Now when we rerun the sample code, we'll get the following:
</p>
<p class='bcode'>
- (<ua>id</ua>=<un>1</un>,<ua>name</ua>=<us>'John+Smith'</us>,<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>,<ua>addressBookUri</ua>=<us>http://sample/addressBook</us>,<ua>birthDate</ua>=<us>1946-08-12T00:00:00Z</us>)
+ (<ua>id</ua>=<un>1</un>,<ua>name</ua>=<us>'John+Smith'</us>,<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>,
+ <ua>addressBookUri</ua>=<us>http://sample/addressBook</us>,<ua>birthDate</ua>=<us>1946-08-12T00:00:00Z</us>)
</p>
<p>
Using <code>UrlEncodingSerializer</code> instead would create the following:
</p>
<p class='bcode'>
- <ua>id</ua>=<un>1</un>&<ua>name</ua>=<us>'John+Smith'</us>&<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>&<ua>addressBookUri</ua>=<us>http://sample/addressBook</us>&<ua>birthDate</ua>=<us>1946-08-12T00:00:00Z</us>
+ <ua>id</ua>=<un>1</un>&<ua>name</ua>=<us>'John+Smith'</us>&<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>
+ &<ua>addressBookUri</ua>=<us>http://sample/addressBook</us>&<ua>birthDate</ua>=<us>1946-08-12T00:00:00Z</us>
</p>
<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>
+ 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.
It converts bean property names to lowercase-dashed format.
</p>
@@ -478,7 +511,8 @@
</p>
<h6 class='figure'>Results</h6>
<p class='bcode'>
- (<ua>id</ua>=<un>1</us>,<ua>name</ua>=<us>'John+Smith'</us>,<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>,<ua>address-book-uri</ua>=<us>http://sample/addressBook</us>,<ua>birth-date</ua>=<us>1946-08-12T00:00:00Z</us>)
+ (<ua>id</ua>=<un>1</us>,<ua>name</ua>=<us>'John+Smith'</us>,<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>,
+ <ua>address-book-uri</ua>=<us>http://sample/addressBook</us>,<ua>birth-date</ua>=<us>1946-08-12T00:00:00Z</us>)
</p>
</div>
@@ -521,7 +555,8 @@
UonSerializer s = UonSerializer.<jsf>DEFAULT_READABLE</jsf>;
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
Address a = <jk>new</jk> Address();
a.<jf>uri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/address/1"</js>);
a.<jf>personUri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/person/1"</js>);
@@ -581,8 +616,9 @@
</p>
</div>
<p>
- Note how the top level <code>Person</code> bean is serialized using the standard <js>'&'</js> delimiter, whereas the lower-level <code>Address</code>
- bean is serialized using the <js>','</js> character to prevent the <code>addresses</code> field from being incompletely parsed.
+ Note how the top level <code>Person</code> bean is serialized using the standard <js>'&'</js> delimiter,
+ whereas the lower-level <code>Address</code> bean is serialized using the <js>','</js> character to prevent
+ the <code>addresses</code> field from being incompletely parsed.
</p>
@@ -592,15 +628,17 @@
<div class='topic'>
<p>
The URL-encoding 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>
+ 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).
+ be thrown (if {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_maxDepth} is not reached first).
</p>
<p>
If you still want to use the URL-encoding serializer on such models, Juneau provides the
- {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_detectRecursions} setting.<br>
+ {@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 serialization when a duplicate is encountered.
+ skip serialization when a duplicate is encountered.
</p>
<p>
For example, let's make a POJO model out of the following classes:
@@ -623,7 +661,8 @@
</p>
<p class='bcode'>
<jc>// Clone an existing serializer and set property for detecting recursions.</jc>
- UrlEncodingSerializer s = UrlEncodingSerializer.<jsf>DEFAULT_READABLE</jsf>.builder().detectRecursions(<jk>true</jk>).build();
+ UrlEncodingSerializer s = UrlEncodingSerializer.<jsf>DEFAULT_READABLE</jsf>.builder()
+ .detectRecursions(<jk>true</jk>).build();
<jc>// Create a recursive loop.</jc>
A a = <jk>new</jk> A();
@@ -648,7 +687,8 @@
Without recursion detection enabled, this would cause a stack-overflow error.
</p>
<p>
- Recursion detection introduces a performance penalty of around 20%.<br>
+ Recursion detection introduces a performance penalty of around 20%.
+ <br>
For this reason the setting is disabled by default.
</p>
</div>
@@ -662,9 +702,12 @@
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.uon.UonSerializerContext} - UON serializer context properties.
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializerContext} - URL-Encoding serializer context properties.
+ <li>{@link org.apache.juneau.BeanContext}
+ - Bean context properties.
+ <li>{@link org.apache.juneau.uon.UonSerializerContext}
+ - UON serializer context properties.
+ <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializerContext}
+ - URL-Encoding serializer context properties.
</ul>
</div>
@@ -674,8 +717,11 @@
<h3 class='topic' onclick='toggle(this)'>2.5 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau serializers, the URL-encoding serializers are thread safe and maintain an internal cache of bean classes encountered.<br>
- For performance reasons, it's recommended that serializers be reused whenever possible instead of always creating new instances.
+ <li>Like all other Juneau serializers, the URL-encoding serializers are thread safe and maintain an internal
+ cache of bean classes encountered.
+ <br>
+ For performance reasons, it's recommended that serializers be reused whenever possible instead of
+ always creating new instances.
</ul>
</div>
</div>
@@ -686,30 +732,39 @@
<h2 class='topic' onclick='toggle(this)'>3 - UrlEncodingParser and UonParser classes</h2>
<div class='topic'>
<p>
- {@link org.apache.juneau.urlencoding.UrlEncodingParser} and {@link org.apache.juneau.uon.UonParser} classes are used to convert URL-encoded strings back into POJOs.<br>
+ {@link org.apache.juneau.urlencoding.UrlEncodingParser} and {@link org.apache.juneau.uon.UonParser} classes
+ are used to convert URL-encoded strings back into POJOs.
+ <br>
The <code>UonParser</code> class converts UON-encoded parameter values to POJOs.
- The <code>UrlEncodingParser</code> class converts entire URL-Encoded strings to POJOs using <code>UonSerializer</code> to serialize indivisual values.
+ The <code>UrlEncodingParser</code> class converts entire URL-Encoded strings to POJOs using
+ <code>UonSerializer</code> to serialize individual values.
If you're trying to parse an entire URL-Encoded string, use <code>UrlEncodingParser</code>.
- If you're trying to parse an individual value (such as that returned by <code>RestServlet.getQueryParameter(name)</code>), use <code>UonParser</code>.
+ If you're trying to parse an individual value (such as that returned by
+ <code>RestServlet.getQueryParameter(name)</code>), use <code>UonParser</code>.
</p>
<p>
The following static reusable instances of <code>UrlEncodingParser</code> are provided for convenience:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingParser#DEFAULT} - Default parser for entire URL-encoded strings, decode <code>%xx</code> sequences.
- <li>{@link org.apache.juneau.uon.UonParser#DEFAULT} - Default parser for URL-encoded parameter values, don't decode <code>%xx</code> sequences.
- <li>{@link org.apache.juneau.uon.UonParser#DEFAULT_DECODING} - Default parser for URL-encoded parameter values, decode <code>%xx</code> sequences.
+ <li>{@link org.apache.juneau.urlencoding.UrlEncodingParser#DEFAULT}
+ - Default parser for entire URL-encoded strings, decode <code>%xx</code> sequences.
+ <li>{@link org.apache.juneau.uon.UonParser#DEFAULT}
+ - Default parser for URL-encoded parameter values, don't decode <code>%xx</code> sequences.
+ <li>{@link org.apache.juneau.uon.UonParser#DEFAULT_DECODING}
+ - Default parser for URL-encoded parameter values, decode <code>%xx</code> sequences.
</ul>
<p>
- The general guildlines on which parser to use is:
+ The general guidelines on which parser to use is:
</p>
<ul class='spaced-list'>
- <li>Use the <code>DEFAULT</code> parser for parameter values that have already had <code>%xx</code> sequences decoded,
- such as when using <code>HttpServletRequest.getQueryParameter(name)</code>.
- <li>Use the <code>DEFAULT_ENCODED</code> parser if the input has not already had <code>%xx</code> sequences decoded.
+ <li>Use the <code>DEFAULT</code> parser for parameter values that have already had <code>%xx</code> sequences
+ decoded, such as when using <code>HttpServletRequest.getQueryParameter(name)</code>.
+ <li>Use the <code>DEFAULT_ENCODED</code> parser if the input has not already had <code>%xx</code> sequences
+ decoded.
</ul>
<p>
- Let's build upon the previous example and parse the generated URL-encoded string back into the original bean.<br>
+ Let's build upon the previous example and parse the generated URL-encoded string back into the original bean.
+ <br>
We start with the URL-encoded string that was generated.
</p>
<p class='bcode'>
@@ -717,7 +772,8 @@
UonSerializer s = UonSerializer.<jsf>DEFAULT_READABLE</jsf>;
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
Address a = <jk>new</jk> Address();
a.<jf>uri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/address/1"</js>);
a.<jf>personUri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/person/1"</js>);
@@ -797,22 +853,24 @@
<h3 class='topic' onclick='toggle(this)'>3.1 - Parsing into generic POJO models</h3>
<div class='topic'>
<p>
- The URL-encoding 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
- parse into a generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive
- objects.
+ The URL-encoding 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 parse into a
+ generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive objects.
</p>
<p>
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>, <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.
+ 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>,
+ <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>
<p>
- When the map or list type is not specified, or is the abstract <code>Map</code>, <code>Collection</code>, or <code>List</code> types,
- the parser will use <code>ObjectMap</code> and <code>ObjectList</code> by default.
+ When the map or list type is not specified, or is the abstract <code>Map</code>, <code>Collection</code>,
+ or <code>List</code> types, the parser will use <code>ObjectMap</code> and <code>ObjectList</code> by
+ default.
</p>
<p>
Starting back with our original URL-encoded string:
@@ -849,9 +907,10 @@
String json = JsonSerializer.<jsf>DEFAULT_LAX_READABLE</jsf>.serialize(m);
</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 <code>Boolean</code> objects
- when parsing into generic models.
+ 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
+ <code>Boolean</code> objects when parsing into generic models.
</p>
<p class='bcode'>
{
@@ -901,7 +960,8 @@
</p>
<p>
- As a general rule, parsing into beans is often more efficient than parsing into generic models.<br>
+ 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.
</p>
</div>
@@ -927,414 +987,16 @@
<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 URL-encoding parsers are thread safe and maintain an internal cache of bean classes encountered.<br>
- For performance reasons, it's recommended that parser be reused whenever possible instead of always creating new instances.
+ <li>Like all other Juneau parsers, the URL-encoding parsers are thread safe and maintain an internal cache
+ of bean classes encountered.
+ <br>
+ For performance reasons, it's recommended that parser be reused whenever possible instead of always
+ creating new instances.
</ul>
</div>
</div>
-
-<!-- ======================================================================================================== -->
-<a id="RestApiSupport"></a>
-<h2 class='topic' onclick='toggle(this)'>4 - REST API support</h2>
-<div class='topic'>
- <p>
- Juneau provides fully-integrated support for URL-encoding serialization/parsing in the REST server and client APIs.<br>
- The next two sections describe these in detail.
- </p>
-
- <!-- ======================================================================================================== -->
- <a id="RestServerSupport"></a>
- <h3 class='topic' onclick='toggle(this)'>4.1 - REST server support</h3>
- <div class='topic'>
- <p>
- There are four general ways of defining REST interfaces with support for JSON.
- Two using the built-in Juneau Server API, and two using the JAX-RS integration component.
- </p>
- <ul class='spaced-list'>
- <li>Create a servlet that subclasses from {@link org.apache.juneau.rest.RestServletDefault}.<br>
- This includes URL-encoding serialization/parsing support by default, in addition to several other media types.
- <li>Create a servlet that subclasses from {@link org.apache.juneau.rest.RestServlet} and specify the
- URL-encoding serializer and/or parser using the {@link org.apache.juneau.rest.annotation.RestResource#serializers()} and
- {@link org.apache.juneau.rest.annotation.RestResource#parsers()} on the entire servlet class, or
- the {@link org.apache.juneau.rest.annotation.RestMethod#serializers()} and {@link org.apache.juneau.rest.annotation.RestMethod#parsers()}
- annotations on individual methods within the class.
- <li>Register {@link org.apache.juneau.rest.jaxrs.DefaultProvider} with JAX-RS.<br>
- This includes URL-encoding serialization/parsing support by default, in addition to several other media types.
- <li>Create and register a subclass of {@link org.apache.juneau.rest.jaxrs.BaseProvider} and specify the serializers and parsers to use on JAX-RS resources.
- </ul>
- <p>
- In general, the Juneau REST server API is much more configurable and easier to use than JAX-RS, but beware that the author may be slightly biased in this statement.
- </p>
-
- <!-- ======================================================================================================== -->
- <a id="RestServletDefault"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.1 - Using RestServletDefault</h4>
- <div class='topic'>
- <p>
- The quickest way to implement a REST resource with URL-encoding support is to create a subclass of {@link org.apache.juneau.rest.RestServletDefault}.<br>
- This class provides support for JSON, XML, HTML, URL-Encoding, and others.
- </p>
- <p>
- The <code>AddressBookResource</code> example shown in the first chapter uses the <code>RestServletJenaDefault</code> class
- which is a subclass of <code>RestServletDefault</code> with additional support for RDF languages.<br>
- The start of the class definition is shown below:
- </p>
- <p class='bcode'>
- <jc>// Proof-of-concept resource that shows off the capabilities of working with POJO resources.
- // Consists of an in-memory address book repository.</jc>
- <ja>@RestResource</ja>(
- messages=<js>"nls/AddressBookResource"</js>,
- title=<js>"$L{title}"</js>,
- description=<js>"$L{description}"</js>,
- htmldoc=<ja>@HtmlDoc</ja>(
- links=<js>"{options:'?method=OPTIONS'}"</js>
- ),
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_useWhitespace</jsf>, value=<js>"true"</js>)
- },
- encoders=GzipEncoder.<jk>class</jk>
- )
- <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
- </p>
- <p>
- Notice how serializer and parser properties can be specified using the <code>@RestResource.properties()</code> annotation.<br>
- In this case, we're overriding the <jsf>SERIALIZER_useWhitespace</jsf> property to add whitespace to the output.
- The remaining properties are specific to the HTML serializer.
- </p>
- <p>
- The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the <code>messages</code> annotation.
- These variables are replaced at runtime based on the HTTP request locale.
- Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.
- See {@link org.apache.juneau.rest.RestContext#getVarResolver()} for more information.
- </p>
- <p>
- This document won't go into all the details of the Juneau <code>RestServlet</code> class.<br>
- Refer to the <a class='doclink' href='../rest/package-summary.html#TOC'>org.apache.juneau.rest</a> documentation for more information on the REST servlet class in general.
- </p>
- <p>
- The rest of the code in the resource class consists of REST methods that simply accept and return POJOs.<br>
- The framework takes care of all content negotiation, serialization/parsing, and error handling.<br>
- Below are 3 of those methods to give you a general idea of the concept:
- </p>
- <p class='bcode'>
- <jc>// GET person request handler</jc>
- <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/people/{id}/*"</js>, rc={200,404})
- <jk>public</jk> Person getPerson(RestRequest req, RestResponse res, <ja>@Path</ja> <jk>int</jk> id) throws Exception {
- res.setPageTitle(req.getPathInfo());
- <jk>return</jk> findPerson(id);
- }
-
- <jc>// POST person handler</jc>
- <ja>@RestMethod</ja>(name=<js>"POST"</js>, path=<js>"/people"</js>, guards=AdminGuard.<jk>class</jk>, rc={307,404})
- <jk>public void</jk> createPerson(RestResponse res, <ja>@Body</ja> CreatePerson cp) <jk>throws</jk> Exception {
- Person p = addressBook.createPerson(cp);
- res.sendRedirect(p.<jf>uri</jf>);
- }
-
- <jc>// DELETE person handler</jc>
- <ja>@RestMethod</ja>(name=<js>"DELETE"</js>, path=<js>"/people/{id}"</js>, guards=AdminGuard.<jk>class</jk>, rc={200,404})
- <jk>public</jk> String deletePerson(RestResponse res, <ja>@Path</ja> <jk>int</jk> id) <jk>throws</jk> Exception {
- Person p = findPerson(id);
- addressBook.remove(p);
- <jk>return</jk> <js>"DELETE successful"</js>;
- }
- </p>
- <p>
- The resource class can be registered with the web application like any other servlet, or can be
- defined as a child of another resource through the {@link org.apache.juneau.rest.annotation.RestResource#children()} annotation.
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="RestServlet"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.2 - Using RestServlet with annotations</h4>
- <div class='topic'>
- <p>
- For fine-tuned control of media types, the {@link org.apache.juneau.rest.RestServlet} class
- can be subclassed directly.<br>
- The serializers/parsers can be specified through annotations at the class and/or method levels.
- </p>
- <p>
- An equivalent <code>AddressBookResource</code> class could be defined to only support URL-encoding using
- the following definition:
- </p>
- <p class='bcode'>
- <ja>@RestResource</ja>(
- serializers={UrlEncodingSerializer.<jk>class</jk>},
- parsers={UrlEncodingParser.<jk>class</jk>},
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_useWhitespace</jsf>, value=<js>"true"</js>)
- }
- )
- <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServlet {
- </p>
- <p>
- Likewise, serializers and parsers can be specified/augmented/overridden at the method level like so:
- </p>
- <p class='bcode'>
- <jc>// GET person request handler</jc>
- <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/people/{id}/*"</js>, rc={200,404},
- serializers={UrlEncodingSerializer.<jk>class</jk>},
- parsers={UrlEncodingParser.<jk>class</jk>},
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_useWhitespace</jsf>, value=<js>"true"</js>)
- }
- )
- <jk>public</jk> Person getPerson(RestRequest req, RestResponse res, <ja>@Path</ja> <jk>int</jk> id) throws Exception {
- res.setPageTitle(req.getPathInfo());
- <jk>return</jk> findPerson(id);
- }
- </p>
- <p>
- The {@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit()} and
- {@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit()} control how various artifacts
- are inherited from the parent class.<br>
- Refer to <a class='doclink' href='../rest/package-summary.html#TOC'>org.apache.juneau.rest</a> for additional information on using these annotations.
- </p>
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="DefaultProvider"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.3 - Using JAX-RS DefaultProvider</h4>
- <div class='topic'>
- <p>
- URL-encoding media type support in JAX-RS can be achieved by using the {@link org.apache.juneau.rest.jaxrs.DefaultProvider} class.<br>
- It implements the JAX-RS <code>MessageBodyReader</code> and <code>MessageBodyWriter</code> interfaces for all Juneau supported media types.
- </p>
- <p>
- The <code>DefaultProvider</code> class definition is shown below:
- </p>
- <p class='bcode'>
- <ja>@Provider</ja>
- <ja>@Produces</ja>(
- <js>"application/json,text/json,"</js>+ <jc>// JsonSerializer</jc>
- <js>"application/json+simple,text/json+simple,"</js>+ <jc>// JsonSerializer.Simple</jc>
- <js>"application/json+schema,text/json+schema,"</js>+ <jc>// JsonSchemaSerializer</jc>
- <js>"text/xml,"</js>+ <jc>// XmlDocSerializer</jc>
- <js>"text/xml+simple,"</js>+ <jc>// XmlDocSerializer.Simple</jc>
- <js>"text/xml+schema,"</js>+ <jc>// XmlSchemaDocSerializer</jc>
- <js>"text/html,"</js>+ <jc>// HtmlDocSerializer</jc>
- <js>"text/uon,"</js>+ <jc>// UonSerializer</jc>
- <js>"application/x-www-form-urlencoded,"</js>+ <jc>// UrlEncodingSerializer</jc>
- <js>"text/xml+soap,"</js>+ <jc>// SoapXmlSerializer</jc>
- <js>"application/x-java-serialized-object"</js> <jc>// JavaSerializedObjectSerializer</jc>
- )
- <ja>@Consumes</ja>(
- <js>"application/json,text/json,"</js>+ <jc>// JsonParser</jc>
- <js>"text/xml,"</js>+ <jc>// XmlParser</jc>
- <js>"text/html,"</js>+ <jc>// HtmlParser</jc>
- <js>"text/uon,"</js>+ <jc>// UonParser</jc>
- <js>"application/x-www-form-urlencoded,"</js>+ <jc>// UrlEncodingParser</jc>
- <js>"application/x-java-serialized-object"</js> <jc>// JavaSerializedObjectParser</jc>
- )
- <ja>@JuneauProvider</ja>(
- serializers={
- JsonSerializer.<jk>class</jk>,
- JsonSerializer.Simple.<jk>class</jk>,
- JsonSchemaSerializer.<jk>class</jk>,
- XmlDocSerializer.<jk>class</jk>,
- XmlDocSerializer.Simple.<jk>class</jk>,
- XmlSchemaDocSerializer.<jk>class</jk>,
- HtmlDocSerializer.<jk>class</jk>,
- UonSerializer.<jk>class</jk>,
- UrlEncodingSerializer.<jk>class</jk>,
- SoapXmlSerializer.<jk>class</jk>,
- JavaSerializedObjectSerializer.<jk>class</jk>
- },
- parsers={
- JsonParser.<jk>class</jk>,
- XmlParser.<jk>class</jk>,
- HtmlParser.<jk>class</jk>,
- UonParser.<jk>class</jk>,
- UrlEncodingParser.<jk>class</jk>,
- JavaSerializedObjectParser.<jk>class</jk>,
- }
- )
- <jk>public final class</jk> DefaultProvider <jk>extends</jk> BaseProvider {}
- </p>
- <p>
- That's the entire class. It consists of only annotations to hook up media types to Juneau serializers and parsers.
- The <ja>@Provider</ja>, <ja>@Produces</ja>, and <ja>@Consumes</ja> annotations are standard JAX-RS annotations, and the <ja>@JuneauProvider</ja> annotation is from Juneau.
- </p>
- <p>
- To enable the provider, you need to make the JAX-RS environment aware of it.
- In Wink, this is accomplished by adding an entry to a config file.
- </p>
- <p class='bcode'>
- <xt><web-app</xt> <ua>version</ua>=<us>"2.3"</us><xt>></xt>
- <xt><servlet></xt>
- <xt><servlet-name></xt>WinkService<xt></servlet-name></xt>
- <xt><servlet-class></xt>org.apache.wink.server.internal.servlet.RestServlet<xt></servlet-class></xt>
- <xt><init-param></xt>
- <xt><param-name></xt>applicationConfigLocation<xt></param-name></xt>
- <xt><param-value></xt>/WEB-INF/wink.cfg<xt></param-value></xt>
- <xt></init-param></xt>
- <xt></servlet></xt>
- </p>
- <p>
- Simply include a reference to the provider in the configuration file.
- <p class='bcode'>
- org.apache.juneau.rest.jaxrs.DefaultProvider
- </p>
- <p>
- Properties can be specified on providers through the {@link org.apache.juneau.rest.jaxrs.JuneauProvider#properties()} annotation.<br>
- Properties can also be specified at the method level by using the {@link org.apache.juneau.rest.annotation.RestMethod#properties} annotation, like so:
- </p>
- <p class='bcode'>
- <ja>@GET</ja>
- <ja>@Produces</ja>(<js>"*/*"</js>)
- <ja>@RestMethod</ja>( <jc>/* Override some properties */</jc>
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_useWhitespace</jsf>, value=<js>"true"</js>)
- }
- )
- <jk>public</jk> Message getMessage() {
- <jk>return</jk> message;
- }
- </p>
- <h6 class='topic'>Limitations</h6>
- <p>
- In general, the Juneau REST API is considerably more flexible than the JAX-RS API, since you can specify and override
- serializers, parsers, properties, transforms, converters, guards, etc... at both the class and method levels.<br>
- Therefore, the JAX-RS API has the following limitations that the Juneau Server API does not:
- </p>
- <ul class='spaced-list'>
- <li>The ability to specify different media type providers at the class and method levels.<br>
- For example, you may want to use <code>JsonSerializer</code> with one set of properties on
- one class, and another instance with different properties on another class.<br>
- There is currently no way to define this at the class level.<br>
- You can override properties at the method level, but this can be cumbersome since it would have to be
- done for all methods in the resource.
- <li>The Juneau Server API allows you to manipulate properties programatically through the {@link org.apache.juneau.rest.RestResponse#setProperty(String,Object)}
- method, and through the {@link org.apache.juneau.rest.annotation.Properties} annotation.<br>
- There is no equivalent in JAX-RS.
- </ul>
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="BaseProvider"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.4 - Using JAX-RS BaseProvider with annotations</h4>
- <div class='topic'>
- <p>
- To provide support for only JSON media types, you can define your own provider class, like so:
- </p>
- <p class='bcode'>
- <ja>@Provider</ja>
- <ja>@Produces</ja>(
- <js>"application/x-www-form-urlencoded"</js> <jc>// UrlEncodingSerializer</jc>
- )
- <ja>@Consumes</ja>(
- <js>"application/x-www-form-urlencoded"</js> <jc>// UrlEncodingParser</jc>
- )
- <ja>@JuneauProvider</ja>(
- serializers={
- UrlEncodingSerializer.<jk>class</jk>
- },
- parsers={
- UrlEncodingParser.<jk>class</jk>,
- }
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_useWhitespace</jsf>, value=<js>"true"</js>)
- }
- )
- <jk>public final class</jk> MyUrlEncodingProvider <jk>extends</jk> BaseProvider {}
- </p>
- <p>
- Then register it with Wink the same way as <code>DefaultProvider</code>.
- </p>
- </div>
-
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="RestClientSupport"></a>
- <h3 class='topic' onclick='toggle(this)'>4.2 - REST client support</h3>
- <div class='topic'>
- <p>
- The {@link org.apache.juneau.rest.client.RestClient} class provides an easy-to-use REST client interface with
- pluggable media type handling using any of the Juneau serializers and parsers.<br>
- Defining a client to support the URL-encoding media type on HTTP requests and responses can be done in one line of code:
- </p>
- <p class='bcode'>
- <jc>// Create a client to handle URL-encoded requests and responses.</jc>
- RestClient client = <uk>new</uk> RestClient(UrlEncodingSerializer.<uk>class</uk>, UrlEncodingParser.<uk>class</uk>);
- </p>
- <p>
- The client handles all content negotiation based on the registered serializers and parsers.
- </p>
- <p>
- The following code is pulled from the main method of the <code>ClientTest</code> class in the sample web application, and
- is run against the <code>AddressBookResource</code> class running within the sample app.<br>
- It shows how the client can be used to interact with the REST API while completely hiding the negotiated content type and working with nothing more than beans.
- </p>
- <h6 class='figure'>Example:</h6>
- <p class='bcode'>
- String root = <js>"http://localhost:9080/sample/addressBook"</js>;
-
- <jc>// Get the current contents of the address book</jc>
- AddressBook ab = client.doGet(root).getResponse(AddressBook.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Number of entries = "</js> + ab.size());
-
- <jc>// Delete the existing entries</jc>
- <jk>for</jk> (Person p : ab) {
- String r = client.doDelete(p.<jf>uri</jf>).getResponse(String.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Deleted person "</js> + p.<jf>name</jf> + <js>", response = "</js> + r);
- }
-
- <jc>// Make sure they're gone</jc>
- ab = client.doGet(root).getResponse(AddressBook.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Number of entries = "</js> + ab.size());
-
- <jc>// Add 1st person again</jc>
- CreatePerson cp = <jk>new</jk> CreatePerson(
- <js>"Barack Obama"</js>,
- <jsm>toCalendar</jsm>(<js>"Aug 4, 1961"</js>),
- <jk>new</jk> CreateAddress(<js>"1600 Pennsylvania Ave"</js>, <js>"Washington"</js>, <js>"DC"</js>, 20500, <jk>true</jk>),
- <jk>new</jk> CreateAddress(<js>"5046 S Greenwood Ave"</js>, <js>"Chicago"</js>, <js>"IL"</js>, 60615, <jk>false</jk>)
- );
- Person p = client.doPost(root + <js>"/people"</js>, cp).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created person "</js> + p.<jf>name</jf> + <js>", uri = "</js> + p.<jf>uri</jf>);
-
- <jc>// Add 2nd person again, but add addresses separately</jc>
- cp = <jk>new</jk> CreatePerson(
- <js>"George Walker Bush"</js>,
- toCalendar(<js>"Jul 6, 1946"</js>)
- );
- p = client.doPost(root + <js>"/people"</js>, cp).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created person "</js> + p.<jf>name</jf> + <js>", uri = "</js> + p.<jf>uri</jf>);
-
- <jc>// Add addresses to 2nd person</jc>
- CreateAddress ca = <jk>new</jk> CreateAddress(<js>"43 Prairie Chapel Rd"</js>, <js>"Crawford"</js>, <js>"TX"</js>, 76638, <jk>true</jk>);
- Address a = client.doPost(p.<jf>uri</jf> + <js>"/addresses"</js>, ca).getResponse(Address.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created address "</js> + a.<jf>uri</jf>);
-
- ca = <jk>new</jk> CreateAddress(<js>"1600 Pennsylvania Ave"</js>, <js>"Washington"</js>, <js>"DC"</js>, 20500, <jk>false</jk>);
- a = client.doPost(p.<jf>uri</jf> + "/addresses"</js>, ca).getResponse(Address.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created address "</js> + a.<jf>uri</jf>);
-
- <jc>// Find 1st person, and change name</jc>
- Person[] pp = client.doGet(root + <js>"?q={name:\"'Barack+Obama'\"}"</js>).getResponse(Person[].<jk>class</jk>);
- String r = client.doPut(pp[0].<jf>uri</jf> + <js>"/name"</js>, <js>"Barack Hussein Obama"</js>).getResponse(String.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Changed name, response = "</js> + r);
- p = client.doGet(pp[0].<jf>uri</jf>).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"New name = "</js> + p.<jf>name</jf>);
- </p>
- <h6 class='figure'>Results</h6>
- <p class='bcode'>
- Number of entries = 2
- Deleted person Barack Obama, response = DELETE successful
- Deleted person George Walker Bush, response = DELETE successful
- Number of entries = 0
- Created person Barack Obama, uri = http://localhost:9080/sample/addressBook/people/3
- Created person George Walker Bush, uri = http://localhost:9080/sample/addressBook/people/4
- Created address http://localhost:9080/sample/addressBook/addresses/7
- Created address http://localhost:9080/sample/addressBook/addresses/8
- Changed name, response = PUT successful
- New name = Barack Hussein Obama
- </p>
- </div>
-</div>
<p align="center"><i><b>*** fín ***</b></i></p>
</body>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/AMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/AMap.java b/juneau-core/src/main/java/org/apache/juneau/utils/AMap.java
index 69e5f8a..8fe5d92 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/AMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/AMap.java
@@ -20,7 +20,8 @@ import java.util.*;
* Primarily used for testing purposes for quickly creating populated maps.
* <p class='bcode'>
* <jc>// Example:</jc>
- * Map<String,Integer> m = <jk>new</jk> AMap<String,Integer>().append(<js>"foo"</js>,1).append(<js>"bar"</js>,2);
+ * Map<String,Integer> m = <jk>new</jk> AMap<String,Integer>()
+ * .append(<js>"foo"</js>,1).append(<js>"bar"</js>,2);
* </p>
*
* @param <K> The key type.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/Args.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/Args.java b/juneau-core/src/main/java/org/apache/juneau/utils/Args.java
index 8768d25..72a1f0a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/Args.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/Args.java
@@ -19,9 +19,11 @@ import java.util.*;
import org.apache.juneau.*;
/**
- * Utility class to make it easier to work with command-line arguments pass in through a <code>main(String[] args)</code> method.
+ * Utility class to make it easier to work with command-line arguments pass in through a
+ * <code>main(String[] args)</code> method.
* <p>
- * Used to parse command-line arguments of the form <js>"[zero or more main arguments] [zero or more optional arguments]"</js>.
+ * Used to parse command-line arguments of the form
+ * <js>"[zero or more main arguments] [zero or more optional arguments]"</js>.
* <p>
* The format of a main argument is a token that does not start with <js>'-'</js>.
* <p>
@@ -135,7 +137,7 @@ public final class Args extends ObjectMap {
/**
* Returns main argument at the specified index, or <jk>null</jk> if the index is out of range.
* <p>
- * Can be used in conjuction with {@link #hasArg(int)} to check for existence of arg.
+ * Can be used in conjunction with {@link #hasArg(int)} to check for existence of arg.
* <p class='bcode'>
* <jc>// Check for no arguments</jc>
* <jk>if</jk> (! args.hasArg(0))
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/IOPipe.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/IOPipe.java b/juneau-core/src/main/java/org/apache/juneau/utils/IOPipe.java
index 86a4d68..e4f94af 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/IOPipe.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/IOPipe.java
@@ -119,7 +119,7 @@ public class IOPipe {
}
/**
- * Sames as calling {@link #byLines()} with <jk>true</jk>.
+ * Same as calling {@link #byLines()} with <jk>true</jk>.
*
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/ManifestFile.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/ManifestFile.java b/juneau-core/src/main/java/org/apache/juneau/utils/ManifestFile.java
index dbca516..fb024ba 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/ManifestFile.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/ManifestFile.java
@@ -24,8 +24,8 @@ import org.apache.juneau.*;
/**
* Utility class for working with Jar manifest files.
* <p>
- * Copies the contents of a {@link Manifest} into an {@link ObjectMap} so that the various
- * convenience methods on that class can be used to retrieve values.
+ * Copies the contents of a {@link Manifest} into an {@link ObjectMap} so that the various convenience methods on that
+ * class can be used to retrieve values.
*/
public class ManifestFile extends ObjectMap {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java b/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java
index 5b22725..4812adb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java
@@ -28,10 +28,12 @@ import org.apache.juneau.annotation.*;
* <li>Instead of throwing {@link MissingResourceException}, the {@link #getString(String)} method
* will return <js>"{!!key}"</js> if the bundle was not found, and <js>"{!key}"</js> if bundle
* was found but the key is not in the bundle.
- * <li>A client locale can be set as a {@link ThreadLocal} object using the static {@link #setClientLocale(Locale)} so that client localized
- * messages can be retrieved using the {@link #getClientString(String, Object...)} method on all instances of this class.
+ * <li>A client locale can be set as a {@link ThreadLocal} object using the static {@link #setClientLocale(Locale)}
+ * so that client localized messages can be retrieved using the {@link #getClientString(String, Object...)}
+ * method on all instances of this class.
* <li>Resource bundles on parent classes can be added to the search path for this class by using the
- * {@link #addSearchPath(Class, String)} method. This allows messages to be retrieved from the resource bundles of parent classes.
+ * {@link #addSearchPath(Class, String)} method.
+ * This allows messages to be retrieved from the resource bundles of parent classes.
* <li>Locale-specific bundles can be retrieved by using the {@link #getBundle(Locale)} method.
* <li>The {@link #getString(Locale, String, Object...)} method can be used to retrieve locale-specific messages.
* <li>Messages in the resource bundle can optionally be prefixed with the simple class name.
@@ -79,7 +81,8 @@ public class MessageBundle extends ResourceBundle {
* @param forClass The class using this resource bundle.
* @param bundlePath The path of the resource bundle to wrap.
* This can be an absolute path (e.g. <js>"com.foo.MyMessages"</js>) or a path
- * relative to the package of the <l>forClass</l> (e.g. <js>"MyMessages"</js> if <l>forClass</l> is <js>"com.foo.MyClass"</js>).
+ * relative to the package of the <l>forClass</l> (e.g. <js>"MyMessages"</js> if <l>forClass</l> is
+ * <js>"com.foo.MyClass"</js>).
*/
public MessageBundle(Class<?> forClass, String bundlePath) {
this(forClass, bundlePath, Locale.getDefault());
@@ -157,7 +160,9 @@ public class MessageBundle extends ResourceBundle {
*
* @param key The resource bundle key.
* @param args Optional {@link MessageFormat}-style arguments.
- * @return The resolved value. Never <jk>null</jk>. <js>"{!!key}"</js> if the bundle is missing. <js>"{!key}"</js> if the key is missing.
+ * @return The resolved value. Never <jk>null</jk>.
+ * <js>"{!!key}"</js> if the bundle is missing.
+ * <js>"{!key}"</js> if the key is missing.
*/
public String getString(String key, Object...args) {
String s = getString(key);
@@ -172,7 +177,9 @@ public class MessageBundle extends ResourceBundle {
* @param locale The locale of the resource bundle to retrieve message from.
* @param key The resource bundle key.
* @param args Optional {@link MessageFormat}-style arguments.
- * @return The resolved value. Never <jk>null</jk>. <js>"{!!key}"</js> if the bundle is missing. <js>"{!key}"</js> if the key is missing.
+ * @return The resolved value. Never <jk>null</jk>.
+ * <js>"{!!key}"</js> if the bundle is missing.
+ * <js>"{!key}"</js> if the key is missing.
*/
public String getString(Locale locale, String key, Object...args) {
if (locale == null)
@@ -181,11 +188,14 @@ public class MessageBundle extends ResourceBundle {
}
/**
- * Same as {@link #getString(String, Object...)} but uses the locale specified on the call to {@link #setClientLocale(Locale)}.
+ * Same as {@link #getString(String, Object...)} but uses the locale specified on the call to
+ * {@link #setClientLocale(Locale)}.
*
* @param key The resource bundle key.
* @param args Optional {@link MessageFormat}-style arguments.
- * @return The resolved value. Never <jk>null</jk>. <js>"{!!key}"</js> if the bundle is missing. <js>"{!key}"</js> if the key is missing.
+ * @return The resolved value. Never <jk>null</jk>.
+ * <js>"{!!key}"</js> if the bundle is missing.
+ * <js>"{!key}"</js> if the key is missing.
*/
public String getClientString(String key, Object...args) {
return getString(clientLocale.get(), key, args);
@@ -270,7 +280,7 @@ public class MessageBundle extends ResourceBundle {
* <p>
* Useful for debugging purposes.
* Note that any class that implements a <code>toObjectMap()</code> method will automatically be serialized by
- * calling this method and serializing the result.
+ * calling this method and serializing the result.
* <p>
* This method always constructs a new {@link ObjectMap} on each call.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/MetadataMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/MetadataMap.java b/juneau-core/src/main/java/org/apache/juneau/utils/MetadataMap.java
index ab03730..127536b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/MetadataMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/MetadataMap.java
@@ -71,7 +71,8 @@ public class MetadataMap {
throw new RuntimeException(e);
}
if (o == null)
- throw new BeanRuntimeException(c, "Could not find a constructor on class with a parameter to handle type {0}", constructorArg.getClass());
+ throw new BeanRuntimeException(c,
+ "Could not find a constructor on class with a parameter to handle type {0}", constructorArg.getClass());
classes2[classes.length] = c;
metadata2[classes.length] = o;
classes = classes2;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java b/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java
index a48c3fc..912dc18 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java
@@ -18,129 +18,137 @@ import org.apache.juneau.transform.*;
/**
* Utility class for efficiently converting objects between types.
* <p>
- * If the value isn't an instance of the specified type, then converts
- * the value if possible.<br>
+ * If the value isn't an instance of the specified type, then converts the value if possible.
* <p>
* The following conversions are valid:
- * <table class='styled'>
- * <tr><th>Convert to type</th><th>Valid input value types</th><th>Notes</th></tr>
- * <tr>
- * <td>
- * A class that is the normal type of a registered {@link PojoSwap}.
- * </td>
- * <td>
- * A value whose class matches the transformed type of that registered {@link PojoSwap}.
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * A class that is the transformed type of a registered {@link PojoSwap}.
- * </td>
- * <td>
- * A value whose class matches the normal type of that registered {@link PojoSwap}.
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * {@code Number} (e.g. {@code Integer}, {@code Short}, {@code Float},...)<br>
- * <code>Number.<jsf>TYPE</jsf></code> (e.g. <code>Integer.<jsf>TYPE</jsf></code>, <code>Short.<jsf>TYPE</jsf></code>, <code>Float.<jsf>TYPE</jsf></code>,...)
- * </td>
- * <td>
- * {@code Number}, {@code String}, <jk>null</jk>
- * </td>
- * <td>
- * For primitive {@code TYPES}, <jk>null</jk> returns the JVM default value for that type.
- * </td>
- * </tr>
- * <tr>
- * <td>
- * {@code Map} (e.g. {@code Map}, {@code HashMap}, {@code TreeMap}, {@code ObjectMap})
- * </td>
- * <td>
- * {@code Map}
- * </td>
- * <td>
- * If {@code Map} is not constructible, a {@code ObjectMap} is created.
- * </td>
- * </tr>
- * <tr>
- * <td>
- * {@code Collection} (e.g. {@code List}, {@code LinkedList}, {@code HashSet}, {@code ObjectList})
- * </td>
- * <td>
- * {@code Collection<Object>}<br>
- * {@code Object[]}
- * </td>
- * <td>
- * If {@code Collection} is not constructible, a {@code ObjectList} is created.
- * </td>
- * </tr>
- * <tr>
- * <td>
- * {@code X[]} (array of any type X)<br>
- * </td>
- * <td>
- * {@code List<X>}<br>
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * {@code X[][]} (multi-dimensional arrays)<br>
- * </td>
- * <td>
- * {@code List<List<X>>}<br>
- * {@code List<X[]>}<br>
- * {@code List[]<X>}<br>
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * {@code Enum}<br>
- * </td>
- * <td>
- * {@code String}<br>
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * Bean<br>
- * </td>
- * <td>
- * {@code Map}<br>
- * </td>
- * <td> </td>
- * </tr>
- * <tr>
- * <td>
- * {@code String}<br>
- * </td>
- * <td>
- * Anything<br>
- * </td>
- * <td>
- * Arrays are converted to JSON arrays<br>
- * </td>
- * </tr>
- * <tr>
- * <td>
- * Anything with one of the following methods:<br>
- * <code><jk>public static</jk> T fromString(String)</code><br>
- * <code><jk>public static</jk> T valueOf(String)</code><br>
- * <code><jk>public</jk> T(String)</code><br>
- * </td>
- * <td>
- * <code>String</code><br>
- * </td>
- * <td>
- * <br>
- * </td>
- * </tr>
- * </table>
+ * <table class='styled'>
+ * <tr><th>Convert to type</th><th>Valid input value types</th><th>Notes</th></tr>
+ * <tr>
+ * <td>
+ * A class that is the normal type of a registered {@link PojoSwap}.
+ * </td>
+ * <td>
+ * A value whose class matches the transformed type of that registered {@link PojoSwap}.
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * A class that is the transformed type of a registered {@link PojoSwap}.
+ * </td>
+ * <td>
+ * A value whose class matches the normal type of that registered {@link PojoSwap}.
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code Number} (e.g. {@code Integer}, {@code Short}, {@code Float},...)
+ * <br>
+ * <code>Number.<jsf>TYPE</jsf></code> (e.g. <code>Integer.<jsf>TYPE</jsf></code>,
+ * <code>Short.<jsf>TYPE</jsf></code>, <code>Float.<jsf>TYPE</jsf></code>,...)
+ * </td>
+ * <td>
+ * {@code Number}, {@code String}, <jk>null</jk>
+ * </td>
+ * <td>
+ * For primitive {@code TYPES}, <jk>null</jk> returns the JVM default value for that type.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code Map} (e.g. {@code Map}, {@code HashMap}, {@code TreeMap}, {@code ObjectMap})
+ * </td>
+ * <td>
+ * {@code Map}
+ * </td>
+ * <td>
+ * If {@code Map} is not constructible, a {@code ObjectMap} is created.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code Collection} (e.g. {@code List}, {@code LinkedList}, {@code HashSet}, {@code ObjectList})
+ * </td>
+ * <td>
+ * {@code Collection<Object>}
+ * <br>
+ * {@code Object[]}
+ * </td>
+ * <td>
+ * If {@code Collection} is not constructible, a {@code ObjectList} is created.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code X[]} (array of any type X)
+ * <br>
+ * </td>
+ * <td>
+ * {@code List<X>}
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code X[][]} (multi-dimensional arrays)
+ * </td>
+ * <td>
+ * {@code List<List<X>>}
+ * <br>
+ * {@code List<X[]>}
+ * <br>
+ * {@code List[]<X>}
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code Enum}
+ * </td>
+ * <td>
+ * {@code String}
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * Bean
+ * </td>
+ * <td>
+ * {@code Map}
+ * </td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * {@code String}
+ * </td>
+ * <td>
+ * Anything
+ * </td>
+ * <td>
+ * Arrays are converted to JSON arrays
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>
+ * Anything with one of the following methods:
+ * <br>
+ * <code><jk>public static</jk> T fromString(String)</code>
+ * <br>
+ * <code><jk>public static</jk> T valueOf(String)</code>
+ * <br>
+ * <code><jk>public</jk> T(String)</code>
+ * </td>
+ * <td>
+ * <code>String</code>
+ * </td>
+ * <td>
+ * <br>
+ * </td>
+ * </tr>
+ * </table>
*/
public class ObjectUtils {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
index f7eb6d4..7eea934 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
@@ -25,7 +25,8 @@ import org.apache.juneau.parser.*;
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* String s = <js>"foobar"</js>;
- * String s2 = (String)<jk>new</jk> PojoIntrospector(s).invoke(<js>"substring(int,int)"</js>, <js>"[3,6]"</js>); <jc>// "bar"</jc>
+ * String s2 = (String)<jk>new</jk> PojoIntrospector(s)
+ * .invoke(<js>"substring(int,int)"</js>, <js>"[3,6]"</js>); <jc>// "bar"</jc>
* </p>
*/
public final class PojoIntrospector {
@@ -37,7 +38,8 @@ public final class PojoIntrospector {
* Constructor.
*
* @param o The object on which Java methods will be invoked.
- * @param p The parser to use to parse the method arguments. If <jk>null</jk>, {@link JsonParser#DEFAULT} is used.
+ * @param p The parser to use to parse the method arguments.
+ * If <jk>null</jk>, {@link JsonParser#DEFAULT} is used.
*/
public PojoIntrospector(Object o, ReaderParser p) {
if (p == null)
@@ -59,23 +61,26 @@ public final class PojoIntrospector {
* Primary method. Invokes the specified method on this bean.
*
* @param method The method being invoked.
- * @param args The arguments to pass as parameters to the method.<br>
- * These will automatically be converted to the appropriate object type if possible.<br>
+ * @param args The arguments to pass as parameters to the method.
+ * These will automatically be converted to the appropriate object type if possible.
* Can be <jk>null</jk> if method has no arguments.
* @return The object returned by the call to the method, or <jk>null</jk> if target object is <jk>null</jk>.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is inaccessible.
+ * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
+ * the underlying constructor is inaccessible.
* @throws IllegalArgumentException If one of the following occurs:
- * <ul class='spaced-list'>
- * <li>The number of actual and formal parameters differ.
- * <li>An unwrapping conversion for primitive arguments fails.
- * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion.
- * <li>The constructor pertains to an enum type.
- * </ul>
+ * <ul class='spaced-list'>
+ * <li>The number of actual and formal parameters differ.
+ * <li>An unwrapping conversion for primitive arguments fails.
+ * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
+ * conversion.
+ * <li>The constructor pertains to an enum type.
+ * </ul>
* @throws InvocationTargetException If the underlying constructor throws an exception.
* @throws ParseException If the input contains a syntax error or is malformed.
* @throws IOException
*/
- public Object invokeMethod(Method method, Reader args) throws InvocationTargetException, IllegalArgumentException, IllegalAccessException, ParseException, IOException {
+ public Object invokeMethod(Method method, Reader args) throws InvocationTargetException, IllegalArgumentException,
+ IllegalAccessException, ParseException, IOException {
if (o == null)
return null;
Object[] params = args == null ? null : p.parseArgs(args, method.getGenericParameterTypes());
@@ -86,24 +91,26 @@ public final class PojoIntrospector {
* Convenience method for invoking argument from method signature (@see {@link ClassUtils#getMethodSignature(Method)}.
*
* @param method The method being invoked.
- * @param args The arguments to pass as parameters to the method.<br>
- * These will automatically be converted to the appropriate object type if possible.<br>
+ * @param args The arguments to pass as parameters to the method.
+ * These will automatically be converted to the appropriate object type if possible.
* Can be <jk>null</jk> if method has no arguments.
* @return The object returned by the call to the method, or <jk>null</jk> if target object is <jk>null</jk>.
* @throws NoSuchMethodException If method does not exist.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is inaccessible.
+ * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
+ * the underlying constructor is inaccessible.
* @throws IllegalArgumentException If one of the following occurs:
- * <ul class='spaced-list'>
- * <li>The number of actual and formal parameters differ.
- * <li>An unwrapping conversion for primitive arguments fails.
- * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion.
- * <li>The constructor pertains to an enum type.
- * </ul>
+ * <ul class='spaced-list'>
+ * <li>The number of actual and formal parameters differ.
+ * <li>An unwrapping conversion for primitive arguments fails.
+ * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion.
+ * <li>The constructor pertains to an enum type.
+ * </ul>
* @throws InvocationTargetException If the underlying constructor throws an exception.
* @throws ParseException If the input contains a syntax error or is malformed.
* @throws IOException
*/
- public Object invokeMethod(String method, String args) throws NoSuchMethodException, IllegalArgumentException, InvocationTargetException, IllegalAccessException, ParseException, IOException {
+ public Object invokeMethod(String method, String args) throws NoSuchMethodException, IllegalArgumentException,
+ InvocationTargetException, IllegalAccessException, ParseException, IOException {
if (o == null)
return null;
Method m = p.getBeanContext().createSession().getClassMeta(o.getClass()).getPublicMethods().get(method);
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java
index 17292ef..aa51b3a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java
@@ -29,12 +29,12 @@ import org.apache.juneau.internal.*;
* It can also perform just view filtering on beans/maps.
* <p>
* Examples of tabular POJO models:
- * <ul>
- * <li><tt>Collection{@code <Map>}</tt>
- * <li><tt>Collection{@code <Bean>}</tt>
- * <li><tt>Map[]</tt>
- * <li><tt>Bean[]</tt>
- * </ul>
+ * <ul>
+ * <li><tt>Collection{@code <Map>}</tt>
+ * <li><tt>Collection{@code <Bean>}</tt>
+ * <li><tt>Map[]</tt>
+ * <li><tt>Bean[]</tt>
+ * </ul>
* <p>
* Tabular POJO models can be thought of as tables of data. For example, a list of the following beans...
* <p class='bcode'>
@@ -53,18 +53,18 @@ import org.apache.juneau.internal.*;
* </table>
* <p>
* From this table, you can perform the following functions:
- * <ul class='spaced-list'>
- * <li>Search - Return only rows where a search pattern matches.
- * <li>View - Return only the specified subset of columns in the specified order.
- * <li>Sort - Sort the table by one or more columns.
- * <li>Position/limit - Only return a subset of rows.
- * </ul>
+ * <ul class='spaced-list'>
+ * <li>Search - Return only rows where a search pattern matches.
+ * <li>View - Return only the specified subset of columns in the specified order.
+ * <li>Sort - Sort the table by one or more columns.
+ * <li>Position/limit - Only return a subset of rows.
+ * </ul>
*
* <h5 class='topic'>Search</h5>
* <p>
- * The search capabilities allow you to filter based on query patterns against
- * strings, dates, and numbers. Queries take the form of a Map with column names
- * as keys, and search patterns as values. <br>
+ * The search capabilities allow you to filter based on query patterns against strings, dates, and numbers.
+ * Queries take the form of a Map with column names as keys, and search patterns as values.
+ * <br>
* Multiple search patterns are ANDed (i.e. all patterns must match for the row to be returned).
*
* <h5 class='section'>Example:</h5>
@@ -76,9 +76,9 @@ import org.apache.juneau.internal.*;
*
* <h5 class='topic'>String Patterns</h5>
* <p>
- * Any objects can be queried against using string patterns. If the objects being
- * searched are not strings, then the patterns are matched against whatever is
- * return by the {@code Object#toString()} method.
+ * Any objects can be queried against using string patterns.
+ * If the objects being searched are not strings, then the patterns are matched against whatever is return by the
+ * {@code Object#toString()} method.
*
* <h6 class='topic'>Example string query patterns:</h6>
* <ul>
@@ -123,7 +123,8 @@ import org.apache.juneau.internal.*;
* <p>
* Any object of type {@link Date} or {@link Calendar} can be searched using date patterns.
* <p>
- * The default valid input timestamp formats (which can be overridden via the {@link #setValidTimestampFormats(String...)} method are...
+ * The default valid input timestamp formats (which can be overridden via the
+ * {@link #setValidTimestampFormats(String...)} method are...
*
* <ul>
* <li><tt>yyyy.MM.dd.HH.mm.ss</tt>
@@ -151,8 +152,8 @@ import org.apache.juneau.internal.*;
*
* <h5 class='topic'>View</h5>
* <p>
- * The view capability allows you to return only the specified subset of columns in the
- * specified order.<br>
+ * The view capability allows you to return only the specified subset of columns in the specified order.
+ * <br>
* The view parameter is a list of either <tt>Strings</tt> or <tt>Maps</tt>.
*
* <h6 class='topic'>Example view parameters:</h6>
@@ -163,9 +164,10 @@ import org.apache.juneau.internal.*;
*
* <h5 class='topic'>Sort</h5>
* <p>
- * The sort capability allows you to sort values by the specified rows.<br>
+ * The sort capability allows you to sort values by the specified rows.
+ * <br>
* The sort parameter is a list of strings with an optional <js>'+'</js> or <js>'-'</js> suffix representing
- * ascending and descending order accordingly.
+ * ascending and descending order accordingly.
*
* <h6 class='topic'>Example sort parameters:</h6>
* <ul>
@@ -177,8 +179,7 @@ import org.apache.juneau.internal.*;
*
* <h5 class='topic'>Paging</h5>
* <p>
- * Use the <tt>position</tt> and <tt>limit</tt> parameters to specify a subset of rows to
- * return.
+ * Use the <tt>position</tt> and <tt>limit</tt> parameters to specify a subset of rows to return.
*/
@SuppressWarnings({"unchecked","rawtypes"})
public final class PojoQuery {
@@ -204,7 +205,7 @@ public final class PojoQuery {
*
* @param args The search arguments.
* @return The filtered collection.
- * <br>Returns the unaltered input if the input is not a collection or array of objects.
+ * Returns the unaltered input if the input is not a collection or array of objects.
*/
public List filter(SearchArgs args) {
@@ -490,6 +491,7 @@ public final class PojoQuery {
/**
* Construct a number matcher for the given search pattern.
+ *
* @param searchPattern A date search paattern. See class usage for a description.
*/
public NumberMatcher(String searchPattern) {
@@ -634,8 +636,8 @@ public final class PojoQuery {
}
/**
- * Use this method to override the allowed search patterns when used in locales where time formats are
- * different.
+ * Use this method to override the allowed search patterns when used in locales where time formats are different.
+ *
* @param s A comma-delimited list of valid time formats.
*/
public void setValidTimestampFormats(String...s) {
@@ -650,6 +652,7 @@ public final class PojoQuery {
/**
* Construct a timestamp matcher for the given search pattern.
+ *
* @param searchPattern The search pattern.
*/
DateMatcher(String searchPattern) {
@@ -659,9 +662,10 @@ public final class PojoQuery {
}
/**
- * Returns <jk>true</jk> if the specified date matches the pattern passed in through
- * the contstructor.<br>
- * The Object can be of type {@link Date} or {@link Calendar}.<br>
+ * Returns <jk>true</jk> if the specified date matches the pattern passed in through the constructor.
+ * <br>
+ * The Object can be of type {@link Date} or {@link Calendar}.
+ * <br>
* Always returns <jk>false</jk> on <jk>null</jk> input.
*/
@Override /* IMatcher */
@@ -833,9 +837,10 @@ public final class PojoQuery {
* Parses a timestamp string off the beginning of the string segment 'seg'.
* Goes through each possible valid timestamp format until it finds a match.
* The position where the parsing left off is stored in pp.
+ *
* @param seg The string segment being parsed.
* @param pp Where parsing last left off.
- * @return An object represening a timestamp.
+ * @return An object representing a timestamp.
*/
private CalendarP parseDate(String seg, ParsePosition pp) {
@@ -899,6 +904,7 @@ public final class PojoQuery {
/**
* Construct a string matcher for the given search pattern.
+ *
* @param searchPattern The search pattern. See class usage for details.
* @param ignoreCase If <jk>true</jk>, use case-insensitive matching.
*/
[10/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 c32bd3c..b06dc5b 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
@@ -76,17 +76,6 @@
<li><p><a class='doclink' href='#ParserConfigurableProperties'>Configurable properties</a></p>
<li><p><a class='doclink' href='#ParserOtherNotes'>Other notes</a></p>
</ol>
- <li><p><a class='doclink' href='#RestApiSupport'>REST API support</a></p>
- <ol>
- <li><p><a class='doclink' href='#RestServerSupport'>REST server support</a></p>
- <ol>
- <li><p><a class='doclink' href='#RestServletDefault'>Using RestServletDefault</a></p>
- <li><p><a class='doclink' href='#RestServlet'>Using RestServlet with annotations</a></p>
- <li><p><a class='doclink' href='#DefaultProvider'>Using JAX-RS DefaultProvider</a></p>
- <li><p><a class='doclink' href='#BaseProvider'>Using JAX-RS BaseProvider with annotations</a></p>
- </ol>
- <li><p><a class='doclink' href='#RestClientSupport'>REST client support</a></p>
- </ol>
</ol>
<!-- ======================================================================================================== -->
@@ -94,23 +83,31 @@
<h2 class='topic' onclick='toggle(this)'>1 -JSON support overview</h2>
<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 highly-efficient state machine.<br>
+ 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
+ highly-efficient state machine.
+ <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>, <code>Float</code>).
- <li>Java Collections Framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything on this list.
+ <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
+ 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 <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 serializable forms.
+ <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
+ 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.
+ 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>
@@ -123,16 +120,19 @@
<h3 class='topic' onclick='toggle(this)'>1.1 - JSON support overview - example</h3>
<div class='topic'>
<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> containing
- zero or more <code>Address</code> beans.
+ 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>
+ containing zero or more <code>Address</code> beans.
</p>
<p>
When you point a browser at <code>/sample/addressBook</code>, the POJO is rendered as HTML:
</p>
<img class='bordered' src="doc-files/Example_HTML.png">
<p>
- By appending <code>?Accept=<i>mediaType</i>&plainText=true</code> to the URL, you can view the data in the various supported JSON formats:
+ By appending <code>?Accept=<i>mediaType</i>&plainText=true</code> to the URL, you can view the data in
+ the various supported JSON formats:
</p>
<h6 class='figure'>Normal JSON</h6>
@@ -142,7 +142,8 @@
<img class='bordered' src="doc-files/Example_JSONSimple.png">
<p>
- In addition to serializing POJOs to JSON, Juneau includes support for serializing POJO metamodels to JSON Schema.
+ In addition to serializing POJOs to JSON, Juneau includes support for serializing POJO metamodels to
+ JSON Schema.
</p>
<h6 class='figure'>JSON Schema</h6>
@@ -152,9 +153,9 @@
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.<br>
- <li>Beans and Maps are converted to JSON objects.<br>
- <li>Collections and arrays are converted to JSON arrays.<br>
+ <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>
@@ -203,7 +204,9 @@
</table>
<p>
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>
+ <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:
</p>
<ul class='spaced-list'>
@@ -212,7 +215,8 @@
<li>On bean properties through the <code><ja>@BeanProperty</ja></code> annotations.
</ul>
<p>
- For more information about transforms, refer to <a class='doclink' href='../transform/package-summary.html#TOC'>org.apache.juneau.transform</a>.
+ For more information about transforms, refer to <a class='doclink'
+ href='../transform/package-summary.html#TOC'>org.apache.juneau.transform</a>.
</p>
</div>
</div>
@@ -222,22 +226,27 @@
<h2 class='topic' onclick='toggle(this)'>2 - JsonSerializer class</h2>
<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.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.
</p>
<p>
- The JSON serializer includes several configurable settings.<br>
+ The JSON serializer includes several configurable 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 necessary.
+ <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.
</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>
+ 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.
</p>
<p>
@@ -295,21 +304,28 @@
<h3 class='topic' onclick='toggle(this)'>2.1 - @Bean and @BeanProperty annotations</h3>
<div class='topic'>
<p>
- 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>
+ 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:
</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 serializable forms).
+ <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>
+ 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.
</p>
<p class='bcode'>
@@ -342,7 +358,8 @@
</p>
<p class='bcode'>
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
</p>
<p>
Now when we rerun the sample code, we'll get the following:
@@ -357,8 +374,9 @@
}
</p>
<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>
+ 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.
It converts bean property names to lowercase-dashed format.
</p>
@@ -419,7 +437,8 @@
JsonSerializer s = JsonSerializer.<jsf>DEFAULT_LAX_READABLE</jsf>;
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
Address a = <jk>new</jk> Address();
a.<jf>uri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/address/1"</js>);
a.<jf>personUri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/person/1"</js>);
@@ -463,15 +482,17 @@
<h3 class='topic' onclick='toggle(this)'>2.3 - JSON-Schema support</h3>
<div class='topic'>
<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 added for creating instances of schema serializers from the regular serializer instance.
+ 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
+ added for creating instances of schema serializers from the regular serializer instance.
</p>
<p>
- <i>Note:</i> As of this writing, JSON-Schema has not been standardized, so the output generated by the schema
- serializer may be subject to future modifications.
+ <i>Note:</i> As of this writing, JSON-Schema has not been standardized, so the output generated by the
+ schema serializer may be subject to future modifications.
</p>
<p>
Lets start with the classes from the previous examples:
@@ -518,7 +539,8 @@
JsonSchemaSerializer s = JsonSerializer.<jsf>DEFAULT_LAX_READABLE</jsf>.getSchemaSerializer();
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
Address a = <jk>new</jk> Address();
a.<jf>uri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/address/1"</js>);
a.<jf>personUri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/person/1"</js>);
@@ -612,16 +634,20 @@
<h3 class='topic' onclick='toggle(this)'>2.4 - Non-tree models and recursion detection</h3>
<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>
+ 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
- be thrown (if {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_maxDepth} is not reached first).
+ 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 serialization when a duplicate is encountered.
+ {@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
+ serialization when a duplicate is encountered.
</p>
<p>
For example, let's make a POJO model out of the following classes:
@@ -670,7 +696,8 @@
Without recursion detection enabled, this would cause a stack-overflow error.
</p>
<p>
- Recursion detection introduces a performance penalty of around 20%.<br>
+ Recursion detection introduces a performance penalty of around 20%.
+ <br>
For this reason the setting is disabled by default.
</p>
</div>
@@ -695,8 +722,11 @@
<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 of bean classes encountered.<br>
- For performance reasons, it's recommended that serializers be reused whenever possible instead of always creating new instances.
+ <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
+ always creating new instances.
</ul>
</div>
</div>
@@ -726,7 +756,8 @@
<li>{@link org.apache.juneau.json.JsonParser#DEFAULT}
</ul>
<p>
- Let's build upon the previous example and parse the generated JSON back into the original bean.<br>
+ 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.
</p>
<p class='bcode'>
@@ -734,7 +765,8 @@
JsonSerializer s = JsonSerializer.<jsf>DEFAULT_LAX_READABLE</jsf>;
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
Address a = <jk>new</jk> Address();
a.<jf>uri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/address/1"</js>);
a.<jf>personUri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/person/1"</js>);
@@ -814,22 +846,25 @@
<h3 class='topic' onclick='toggle(this)'>3.1 - Parsing into generic POJO models</h3>
<div class='topic'>
<p>
- The JSON parser is not limited to parsing back into the original bean classes.<br>
+ 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
- parse into a generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive
- objects.
+ parse into a generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive
+ objects.
</p>
<p>
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>, <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.
+ 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>,
+ <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>
<p>
- When the map or list type is not specified, or is the abstract <code>Map</code>, <code>Collection</code>, or <code>List</code> types,
- the parser will use <code>ObjectMap</code> and <code>ObjectList</code> by default.
+ When the map or list type is not specified, or is the abstract <code>Map</code>, <code>Collection</code>,
+ or <code>List</code> types, the parser will use <code>ObjectMap</code> and <code>ObjectList</code> by
+ default.
</p>
<p>
Starting back with our original JSON:
@@ -866,9 +901,10 @@
String json = JsonSerializer.<jsf>DEFAULT_LAX_READABLE</jsf>.serialize(m);
</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 <code>Boolean</code> objects
- when parsing into generic models.
+ 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
+ <code>Boolean</code> objects when parsing into generic models.
</p>
<p class='bcode'>
{
@@ -918,7 +954,8 @@
</p>
<p>
- As a general rule, parsing into beans is often more efficient than parsing into generic models.<br>
+ 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.
</p>
</div>
@@ -943,415 +980,15 @@
<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 classes encountered.<br>
- For performance reasons, it's recommended that parser be reused whenever possible instead of always creating new instances.
+ <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
+ creating new instances.
</ul>
</div>
</div>
-
-
-<!-- ======================================================================================================== -->
-<a id="RestApiSupport"></a>
-<h2 class='topic' onclick='toggle(this)'>4 - REST API support</h2>
-<div class='topic'>
- <p>
- Juneau provides fully-integrated support for JSON serialization/parsing in the REST server and client APIs.<br>
- The next two sections describe these in detail.
- </p>
-
- <!-- ======================================================================================================== -->
- <a id="RestServerSupport"></a>
- <h3 class='topic' onclick='toggle(this)'>4.1 - REST server support</h3>
- <div class='topic'>
- <p>
- There are four general ways of defining REST interfaces with support for JSON.
- Two using the built-in Juneau Server API, and two using the JAX-RS integration component.
- </p>
- <ul class='spaced-list'>
- <li>Create a servlet that subclasses from {@link org.apache.juneau.rest.RestServletDefault}.<br>
- This includes JSON serialization/parsing support by default, in addition to several other media types.
- <li>Create a servlet that subclasses from {@link org.apache.juneau.rest.RestServlet} and specify the
- a JSON serializer and/or parser using the {@link org.apache.juneau.rest.annotation.RestResource#serializers()} and
- {@link org.apache.juneau.rest.annotation.RestResource#parsers()} on the entire servlet class, or
- the {@link org.apache.juneau.rest.annotation.RestMethod#serializers()} and {@link org.apache.juneau.rest.annotation.RestMethod#parsers()}
- annotations on individual methods within the class.
- <li>Register {@link org.apache.juneau.rest.jaxrs.DefaultProvider} with JAX-RS.<br>
- This includes JSON serialization/parsing support by default, in addition to several other media types.
- <li>Create and register a subclass of {@link org.apache.juneau.rest.jaxrs.BaseProvider} and specify the serializers and parsers to use on JAX-RS resources.
- </ul>
- <p>
- In general, the Juneau REST server API is much more configurable and easier to use than JAX-RS, but beware that the author may be slightly biased in this statement.
- </p>
-
- <!-- ======================================================================================================== -->
- <a id="RestServletDefault"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.1 - Using RestServletDefault</h4>
- <div class='topic'>
- <p>
- The quickest way to implement a REST resource with JSON support is to create a subclass of {@link org.apache.juneau.rest.RestServletDefault}.<br>
- This class provides support for JSON, XML, HTML, URL-Encoding, and others.
- </p>
- <p>
- The <code>AddressBookResource</code> example shown in the first chapter uses the <code>RestServletJenaDefault</code> class
- which is a subclass of <code>RestServletDefault</code> with additional support for RDF languages.<br>
- The start of the class definition is shown below:
- </p>
- <p class='bcode'>
- <jc>// Proof-of-concept resource that shows off the capabilities of working with POJO resources.
- // Consists of an in-memory address book repository.</jc>
- <ja>@RestResource</ja>(
- messages=<js>"nls/AddressBookResource"</js>,
- title=<js>"$L{title}"</js>,
- description=<js>"$L{description}"</js>,
- htmldoc=<ja>@HtmlDoc</ja>(
- links=<js>"{options:'?method=OPTIONS'}"</js>
- ),
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>),
- <ja>@Property</ja>(name=HtmlSerializerContext.<jsf>HTML_uriAnchorText</jsf>, value=<jsf>TO_STRING</jsf>)
- },
- encoders=GzipEncoder.<jk>class</jk>
- )
- <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
- </p>
- <p>
- Notice how serializer and parser properties can be specified using the <code>@RestResource.properties()</code> annotation.<br>
- The <jsf>SERIALIZER_quoteChar</jsf> is a property common to all serializers, including the JSON serializer.
- The remaining properties are specific to the HTML serializer.
- </p>
- <p>
- The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the <code>messages</code> annotation.
- These variables are replaced at runtime based on the HTTP request locale.
- Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.
- See {@link org.apache.juneau.rest.RestContext#getVarResolver()} for more information.
- </p>
- <p>
- This document won't go into all the details of the Juneau <code>RestServlet</code> class.<br>
- Refer to the <a class='doclink' href='../rest/package-summary.html#TOC'>org.apache.juneau.rest</a> documentation for more information on the REST servlet class in general.
- </p>
- <p>
- The rest of the code in the resource class consists of REST methods that simply accept and return POJOs.<br>
- The framework takes care of all content negotiation, serialization/parsing, and error handling.<br>
- Below are 3 of those methods to give you a general idea of the concept:
- </p>
- <p class='bcode'>
- <jc>// GET person request handler</jc>
- <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/people/{id}/*"</js>, rc={200,404})
- <jk>public</jk> Person getPerson(RestRequest req, RestResponse res, <ja>@Path</ja> <jk>int</jk> id) throws Exception {
- res.setPageTitle(req.getPathInfo());
- <jk>return</jk> findPerson(id);
- }
-
- <jc>// POST person handler</jc>
- <ja>@RestMethod</ja>(name=<js>"POST"</js>, path=<js>"/people"</js>, guards=AdminGuard.<jk>class</jk>, rc={307,404})
- <jk>public void</jk> createPerson(RestResponse res, <ja>@Body</ja> CreatePerson cp) <jk>throws</jk> Exception {
- Person p = addressBook.createPerson(cp);
- res.sendRedirect(p.<jf>uri</jf>);
- }
-
- <jc>// DELETE person handler</jc>
- <ja>@RestMethod</ja>(name=<js>"DELETE"</js>, path=<js>"/people/{id}"</js>, guards=AdminGuard.<jk>class</jk>, rc={200,404})
- <jk>public</jk> String deletePerson(RestResponse res, <ja>@Path</ja> <jk>int</jk> id) <jk>throws</jk> Exception {
- Person p = findPerson(id);
- addressBook.remove(p);
- <jk>return</jk> <js>"DELETE successful"</js>;
- }
- </p>
- <p>
- The resource class can be registered with the web application like any other servlet, or can be
- defined as a child of another resource through the {@link org.apache.juneau.rest.annotation.RestResource#children()} annotation.
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="RestServlet"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.2 - Using RestServlet with annotations</h4>
- <div class='topic'>
- <p>
- For fine-tuned control of media types, the {@link org.apache.juneau.rest.RestServlet} class
- can be subclassed directly.<br>
- The serializers/parsers can be specified through annotations at the class and/or method levels.
- </p>
- <p>
- An equivalent <code>AddressBookResource</code> class could be defined to only support JSON using
- the following definition:
- </p>
- <p class='bcode'>
- <ja>@RestResource</ja>(
- serializers={JsonSerializer.<jk>class</jk>},
- parsers={JsonParser.<jk>class</jk>},
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServlet {
- </p>
- <p>
- Likewise, serializers and parsers can be specified/augmented/overridden at the method level like so:
- </p>
- <p class='bcode'>
- <jc>// GET person request handler</jc>
- <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/people/{id}/*"</js>, rc={200,404},
- serializers={JsonSerializer.<jk>class</jk>},
- parsers={JsonParser.<jk>class</jk>},
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public</jk> Person getPerson(RestRequest req, RestResponse res, <ja>@Path</ja> <jk>int</jk> id) throws Exception {
- res.setPageTitle(req.getPathInfo());
- <jk>return</jk> findPerson(id);
- }
- </p>
- <p>
- The {@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit()} and
- {@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit()} control how various artifacts
- are inherited from the parent class.<br>
- Refer to <a class='doclink' href='../rest/package-summary.html#TOC'>org.apache.juneau.rest</a> for additional information on using these annotations.
- </p>
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="DefaultProvider"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.3 - Using JAX-RS DefaultProvider</h4>
- <div class='topic'>
- <p>
- JSON media type support in JAX-RS can be achieved by using the {@link org.apache.juneau.rest.jaxrs.DefaultProvider} class.<br>
- It implements the JAX-RS <code>MessageBodyReader</code> and <code>MessageBodyWriter</code> interfaces for all Juneau supported media types.
- </p>
- <p>
- The <code>DefaultProvider</code> class definition is shown below:
- </p>
- <p class='bcode'>
- <ja>@Provider</ja>
- <ja>@Produces</ja>(
- <js>"application/json,text/json,"</js>+ <jc>// JsonSerializer</jc>
- <js>"application/json+simple,text/json+simple"</js>+ <jc>// JsonSerializer.Simple</jc>
- <js>"application/json+schema,text/json+schema"</js>+ <jc>// JsonSchemaSerializer</jc>
- <js>"text/xml"</js>+ <jc>// XmlDocSerializer</jc>
- <js>"text/xml+simple"</js>+ <jc>// XmlDocSerializer.Simple</jc>
- <js>"text/xml+schema"</js>+ <jc>// XmlSchemaDocSerializer</jc>
- <js>"text/html"</js>+ <jc>// HtmlDocSerializer</jc>
- <js>"application/x-www-form-urlencoded"</js>+ <jc>// UrlEncodingSerializer</jc>
- <js>"text/xml+soap"</js>+ <jc>// SoapXmlSerializer</jc>
- <js>"application/x-java-serialized-object"</js> <jc>// JavaSerializedObjectSerializer</jc>
- )
- <ja>@Consumes</ja>(
- <js>"application/json,text/json,"</js>+ <jc>// JsonParser</jc>
- <js>"text/xml,"</js>+ <jc>// XmlParser</jc>
- <js>"text/html,"</js>+ <jc>// HtmlParser</jc>
- <js>"application/x-www-form-urlencoded,"</js>+ <jc>// UrlEncodingParser</jc>
- <js>"application/x-java-serialized-object"</js> <jc>// JavaSerializedObjectParser</jc>
- )
- <ja>@JuneauProvider</ja>(
- serializers={
- JsonSerializer.<jk>class</jk>,
- JsonSerializer.Simple.<jk>class</jk>,
- JsonSchemaSerializer.<jk>class</jk>,
- XmlDocSerializer.<jk>class</jk>,
- XmlDocSerializer.Simple.<jk>class</jk>,
- XmlSchemaDocSerializer.<jk>class</jk>,
- HtmlDocSerializer.<jk>class</jk>,
- UrlEncodingSerializer.<jk>class</jk>,
- SoapXmlSerializer.<jk>class</jk>,
- JavaSerializedObjectSerializer.<jk>class</jk>
- },
- parsers={
- JsonParser.<jk>class</jk>,
- XmlParser.<jk>class</jk>,
- HtmlParser.<jk>class</jk>,
- UrlEncodingParser.<jk>class</jk>,
- JavaSerializedObjectParser.<jk>class</jk>,
- }
- )
- <jk>public final class</jk> DefaultProvider <jk>extends</jk> BaseProvider {}
- </p>
- <p>
- That's the entire class. It consists of only annotations to hook up media types to Juneau serializers and parsers.
- The <ja>@Provider</ja>, <ja>@Produces</ja>, and <ja>@Consumes</ja> annotations are standard JAX-RS annotations, and the <ja>@JuneauProvider</ja> annotation is from Juneau.
- </p>
- <p>
- To enable the provider, you need to make the JAX-RS environment aware of it.
- In Wink, this is accomplished by adding an entry to a config file.
- </p>
- <p class='bcode'>
- <xt><web-app</xt> <xa>version</xa>=<xs>"2.3"</xs><xt>></xt>
- <xt><servlet></xt>
- <xt><servlet-name></xt>WinkService<xt></servlet-name></xt>
- <xt><servlet-class></xt>org.apache.wink.server.internal.servlet.RestServlet<xt></servlet-class></xt>
- <xt><init-param></xt>
- <xt><param-name></xt>applicationConfigLocation<xt></param-name></xt>
- <xt><param-value></xt>/WEB-INF/wink.cfg<xt></param-value></xt>
- <xt></init-param></xt>
- <xt></servlet></xt>
- </p>
- <p>
- Simply include a reference to the provider in the configuration file.
- <p class='bcode'>
- org.apache.juneau.rest.jaxrs.DefaultProvider
- </p>
- <p>
- Properties can be specified on providers through the {@link org.apache.juneau.rest.jaxrs.JuneauProvider#properties()} annotation.<br>
- Properties can also be specified at the method level by using the {@link org.apache.juneau.rest.annotation.RestMethod#properties} annotation, like so:
- </p>
- <p class='bcode'>
- <ja>@GET</ja>
- <ja>@Produces</ja>(<js>"*/*"</js>)
- <ja>@RestMethod</ja>( <jc>/* Override some properties */</jc>
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public</jk> Message getMessage() {
- <jk>return</jk> message;
- }
- </p>
- <h6 class='topic'>Limitations</h6>
- <p>
- In general, the Juneau REST API is considerably more flexible than the JAX-RS API, since you can specify and override
- serializers, parsers, properties, transforms, converters, guards, etc... at both the class and method levels.<br>
- Therefore, the JAX-RS API has the following limitations that the Juneau Server API does not:
- </p>
- <ul class='spaced-list'>
- <li>The ability to specify different media type providers at the class and method levels.<br>
- For example, you may want to use <code>JsonSerializer</code> with one set of properties on
- one class, and another instance with different properties on another class.<br>
- There is currently no way to define this at the class level.<br>
- You can override properties at the method level, but this can be cumbersome since it would have to be
- done for all methods in the resource.
- <li>The Juneau Server API allows you to manipulate properties programatically through the {@link org.apache.juneau.rest.RestResponse#setProperty(String,Object)}
- method, and through the {@link org.apache.juneau.rest.annotation.Properties} annotation.<br>
- There is no equivalent in JAX-RS.
- </ul>
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="BaseProvider"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.4 - Using JAX-RS BaseProvider with annotations</h4>
- <div class='topic'>
- <p>
- To provide support for only JSON media types, you can define your own provider class, like so:
- </p>
- <p class='bcode'>
- <ja>@Provider</ja>
- <ja>@Produces</ja>(
- <js>"application/json,text/json,"</js>+ <jc>// JsonSerializer</jc>
- <js>"application/json+simple,text/json+simple,"</js>+ <jc>// JsonSerializer.Simple</jc>
- <js>"application/json+schema,text/json+schema"</js> <jc>// JsonSchemaSerializer</jc>
- )
- <ja>@Consumes</ja>(
- <js>"application/json,text/json"</js> <jc>// JsonParser</jc>
- )
- <ja>@JuneauProvider</ja>(
- serializers={
- JsonSerializer.<jk>class</jk>,
- JsonSerializer.Simple.<jk>class</jk>,
- JsonSchemaSerializer.<jk>class</jk>,
- },
- parsers={
- JsonParser.<jk>class</jk>,
- }
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public final class</jk> MyRdfProvider <jk>extends</jk> BaseProvider {}
- </p>
- <p>
- Then register it with Wink the same way as <code>DefaultProvider</code>.
- </p>
- </div>
-
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="RestClientSupport"></a>
- <h3 class='topic' onclick='toggle(this)'>4.2 - REST client support</h3>
- <div class='topic'>
- <p>
- The {@link org.apache.juneau.rest.client.RestClient} class provides an easy-to-use REST client interface with
- pluggable media type handling using any of the Juneau serializers and parsers.<br>
- Defining a client to support JSON media types on HTTP requests and responses can be done in one line of code:
- </p>
- <p class='bcode'>
- <jc>// Create a client to handle JSON requests and responses.</jc>
- RestClient client = <jk>new</jk> RestClientBuilder().build();
- </p>
- <p>
- The client handles all content negotiation based on the registered serializers and parsers.
- </p>
- <p>
- The following code is pulled from the main method of the <code>ClientTest</code> class in the sample web application, and
- is run against the <code>AddressBookResource</code> class running within the sample app.<br>
- It shows how the client can be used to interact with the REST API while completely hiding the negotiated content type and working with nothing more than beans.
- </p>
- <h6 class='topic'>Example:</h6>
- <p class='bcode'>
- String root = <js>"http://localhost:9080/sample/addressBook"</js>;
-
- <jc>// Get the current contents of the address book</jc>
- AddressBook ab = client.doGet(root).getResponse(AddressBook.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Number of entries = "</js> + ab.size());
-
- <jc>// Delete the existing entries</jc>
- <jk>for</jk> (Person p : ab) {
- String r = client.doDelete(p.<jf>uri</jf>).getResponse(String.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Deleted person "</js> + p.<jf>name</jf> + <js>", response = "</js> + r);
- }
-
- <jc>// Make sure they're gone</jc>
- ab = client.doGet(root).getResponse(AddressBook.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Number of entries = "</js> + ab.size());
-
- <jc>// Add 1st person again</jc>
- CreatePerson cp = <jk>new</jk> CreatePerson(
- <js>"Barack Obama"</js>,
- <jsm>toCalendar</jsm>(<js>"Aug 4, 1961"</js>),
- <jk>new</jk> CreateAddress(<js>"1600 Pennsylvania Ave"</js>, <js>"Washington"</js>, <js>"DC"</js>, 20500, <jk>true</jk>),
- <jk>new</jk> CreateAddress(<js>"5046 S Greenwood Ave"</js>, <js>"Chicago"</js>, <js>"IL"</js>, 60615, <jk>false</jk>)
- );
- Person p = client.doPost(root + <js>"/people"</js>, cp).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created person "</js> + p.<jf>name</jf> + <js>", uri = "</js> + p.<jf>uri</jf>);
-
- <jc>// Add 2nd person again, but add addresses separately</jc>
- cp = <jk>new</jk> CreatePerson(
- <js>"George Walker Bush"</js>,
- toCalendar(<js>"Jul 6, 1946"</js>)
- );
- p = client.doPost(root + <js>"/people"</js>, cp).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created person "</js> + p.<jf>name</jf> + <js>", uri = "</js> + p.<jf>uri</jf>);
-
- <jc>// Add addresses to 2nd person</jc>
- CreateAddress ca = <jk>new</jk> CreateAddress(<js>"43 Prairie Chapel Rd"</js>, <js>"Crawford"</js>, <js>"TX"</js>, 76638, <jk>true</jk>);
- Address a = client.doPost(p.<jf>uri</jf> + <js>"/addresses"</js>, ca).getResponse(Address.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created address "</js> + a.<jf>uri</jf>);
-
- ca = <jk>new</jk> CreateAddress(<js>"1600 Pennsylvania Ave"</js>, <js>"Washington"</js>, <js>"DC"</js>, 20500, <jk>false</jk>);
- a = client.doPost(p.<jf>uri</jf> + "/addresses"</js>, ca).getResponse(Address.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created address "</js> + a.<jf>uri</jf>);
-
- <jc>// Find 1st person, and change name</jc>
- Person[] pp = client.doGet(root + <js>"?q={name:\"'Barack+Obama'\"}"</js>).getResponse(Person[].<jk>class</jk>);
- String r = client.doPut(pp[0].<jf>uri</jf> + <js>"/name"</js>, <js>"Barack Hussein Obama"</js>).getResponse(String.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Changed name, response = "</js> + r);
- p = client.doGet(pp[0].<jf>uri</jf>).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"New name = "</js> + p.<jf>name</jf>);
- </p>
- <h6 class='figure'>Results</h6>
- <p class='bcode'>
- Number of entries = 2
- Deleted person Barack Obama, response = DELETE successful
- Deleted person George Walker Bush, response = DELETE successful
- Number of entries = 0
- Created person Barack Obama, uri = http://localhost:9080/sample/addressBook/people/3
- Created person George Walker Bush, uri = http://localhost:9080/sample/addressBook/people/4
- Created address http://localhost:9080/sample/addressBook/addresses/7
- Created address http://localhost:9080/sample/addressBook/addresses/8
- Changed name, response = PUT successful
- New name = Barack Hussein Obama
- </p>
- </div>
-</div>
<p align="center"><i><b>*** fín ***</b></i></p>
</body>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 a9896dd..13e52ad 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
@@ -56,6 +56,7 @@ public final class MsgPackInputStream extends InputStream {
/**
* Constructor.
+ *
* @param is The input stream being wrapped.
*/
protected MsgPackInputStream(InputStream is) {
@@ -171,22 +172,22 @@ public final class MsgPackInputStream extends InputStream {
break;
}
case STRING:{
- // fixstr stores a byte array whose length is upto 31 bytes:
+ // fixstr stores a byte array whose length is up to 31 bytes:
// +--------+========+
// |101XXXXX| data |
// +--------+========+
//
- // str 8 stores a byte array whose length is upto (2^8)-1 bytes:
+ // str 8 stores a byte array whose length is up to (2^8)-1 bytes:
// +--------+--------+========+
// | 0xd9 |YYYYYYYY| data |
// +--------+--------+========+
//
- // str 16 stores a byte array whose length is upto (2^16)-1 bytes:
+ // str 16 stores a byte array whose length is up to (2^16)-1 bytes:
// +--------+--------+--------+========+
// | 0xda |ZZZZZZZZ|ZZZZZZZZ| data |
// +--------+--------+--------+========+
//
- // str 32 stores a byte array whose length is upto (2^32)-1 bytes:
+ // str 32 stores a byte array whose length is up to (2^32)-1 bytes:
// +--------+--------+--------+--------+--------+========+
// | 0xdb |AAAAAAAA|AAAAAAAA|AAAAAAAA|AAAAAAAA| data |
// +--------+--------+--------+--------+--------+========+
@@ -208,17 +209,17 @@ public final class MsgPackInputStream extends InputStream {
break;
}
case ARRAY: {
- // fixarray stores an array whose length is upto 15 elements:
+ // fixarray stores an array whose length is up to 15 elements:
// +--------+~~~~~~~~~~~~~~~~~+
// |1001XXXX| N objects |
// +--------+~~~~~~~~~~~~~~~~~+
//
- // array 16 stores an array whose length is upto (2^16)-1 elements:
+ // array 16 stores an array whose length is up to (2^16)-1 elements:
// +--------+--------+--------+~~~~~~~~~~~~~~~~~+
// | 0xdc |YYYYYYYY|YYYYYYYY| N objects |
// +--------+--------+--------+~~~~~~~~~~~~~~~~~+
//
- // array 32 stores an array whose length is upto (2^32)-1 elements:
+ // array 32 stores an array whose length is up to (2^32)-1 elements:
// +--------+--------+--------+--------+--------+~~~~~~~~~~~~~~~~~+
// | 0xdd |ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ| N objects |
// +--------+--------+--------+--------+--------+~~~~~~~~~~~~~~~~~+
@@ -237,17 +238,17 @@ public final class MsgPackInputStream extends InputStream {
break;
}
case BIN:{
- // bin 8 stores a byte array whose length is upto (2^8)-1 bytes:
+ // bin 8 stores a byte array whose length is up to (2^8)-1 bytes:
// +--------+--------+========+
// | 0xc4 |XXXXXXXX| data |
// +--------+--------+========+
//
- // bin 16 stores a byte array whose length is upto (2^16)-1 bytes:
+ // bin 16 stores a byte array whose length is up to (2^16)-1 bytes:
// +--------+--------+--------+========+
// | 0xc5 |YYYYYYYY|YYYYYYYY| data |
// +--------+--------+--------+========+
//
- // bin 32 stores a byte array whose length is upto (2^32)-1 bytes:
+ // bin 32 stores a byte array whose length is up to (2^32)-1 bytes:
// +--------+--------+--------+--------+--------+========+
// | 0xc6 |ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ| data |
// +--------+--------+--------+--------+--------+========+
@@ -294,17 +295,17 @@ public final class MsgPackInputStream extends InputStream {
// data (cont.) |
// +--------+--------+--------+--------+--------+--------+--------+--------+
//
- // ext 8 stores an integer and a byte array whose length is upto (2^8)-1 bytes:
+ // ext 8 stores an integer and a byte array whose length is up to (2^8)-1 bytes:
// +--------+--------+--------+========+
// | 0xc7 |XXXXXXXX| type | data |
// +--------+--------+--------+========+
//
- // ext 16 stores an integer and a byte array whose length is upto (2^16)-1 bytes:
+ // ext 16 stores an integer and a byte array whose length is up to (2^16)-1 bytes:
// +--------+--------+--------+--------+========+
// | 0xc8 |YYYYYYYY|YYYYYYYY| type | data |
// +--------+--------+--------+--------+========+
//
- // ext 32 stores an integer and a byte array whose length is upto (2^32)-1 bytes:
+ // ext 32 stores an integer and a byte array whose length is up to (2^32)-1 bytes:
// +--------+--------+--------+--------+--------+--------+========+
// | 0xc9 |ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ| type | data |
// +--------+--------+--------+--------+--------+--------+========+
@@ -337,17 +338,17 @@ public final class MsgPackInputStream extends InputStream {
break;
}
case MAP:{
- // fixmap stores a map whose length is upto 15 elements
+ // fixmap stores a map whose length is up to 15 elements
// +--------+~~~~~~~~~~~~~~~~~+
// |1000XXXX| N*2 objects |
// +--------+~~~~~~~~~~~~~~~~~+
//
- // map 16 stores a map whose length is upto (2^16)-1 elements
+ // map 16 stores a map whose length is up to (2^16)-1 elements
// +--------+--------+--------+~~~~~~~~~~~~~~~~~+
// | 0xde |YYYYYYYY|YYYYYYYY| N*2 objects |
// +--------+--------+--------+~~~~~~~~~~~~~~~~~+
//
- // map 32 stores a map whose length is upto (2^32)-1 elements
+ // map 32 stores a map whose length is up to (2^32)-1 elements
// +--------+--------+--------+--------+--------+~~~~~~~~~~~~~~~~~+
// | 0xdf |ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ| N*2 objects |
// +--------+--------+--------+--------+--------+~~~~~~~~~~~~~~~~~+
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 73673dd..778a9f7 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
@@ -32,6 +32,7 @@ public final class MsgPackOutputStream extends OutputStream {
/**
* Constructor.
+ *
* @param os The output stream being wrapped.
*/
protected MsgPackOutputStream(OutputStream os) {
@@ -187,22 +188,22 @@ public final class MsgPackOutputStream extends OutputStream {
*/
final MsgPackOutputStream appendString(CharSequence cs) throws IOException {
- // fixstr stores a byte array whose length is upto 31 bytes:
+ // fixstr stores a byte array whose length is up to 31 bytes:
// +--------+========+
// |101XXXXX| data |
// +--------+========+
//
- // str 8 stores a byte array whose length is upto (2^8)-1 bytes:
+ // str 8 stores a byte array whose length is up to (2^8)-1 bytes:
// +--------+--------+========+
// | 0xd9 |YYYYYYYY| data |
// +--------+--------+========+
//
- // str 16 stores a byte array whose length is upto (2^16)-1 bytes:
+ // str 16 stores a byte array whose length is up to (2^16)-1 bytes:
// +--------+--------+--------+========+
// | 0xda |ZZZZZZZZ|ZZZZZZZZ| data |
// +--------+--------+--------+========+
//
- // str 32 stores a byte array whose length is upto (2^32)-1 bytes:
+ // str 32 stores a byte array whose length is up to (2^32)-1 bytes:
// +--------+--------+--------+--------+--------+========+
// | 0xdb |AAAAAAAA|AAAAAAAA|AAAAAAAA|AAAAAAAA| data |
// +--------+--------+--------+--------+--------+========+
@@ -227,17 +228,17 @@ public final class MsgPackOutputStream extends OutputStream {
* Appends a binary field to the stream.
*/
final MsgPackOutputStream appendBinary(byte[] b) throws IOException {
- // bin 8 stores a byte array whose length is upto (2^8)-1 bytes:
+ // bin 8 stores a byte array whose length is up to (2^8)-1 bytes:
// +--------+--------+========+
// | 0xc4 |XXXXXXXX| data |
// +--------+--------+========+
//
- // bin 16 stores a byte array whose length is upto (2^16)-1 bytes:
+ // bin 16 stores a byte array whose length is up to (2^16)-1 bytes:
// +--------+--------+--------+========+
// | 0xc5 |YYYYYYYY|YYYYYYYY| data |
// +--------+--------+--------+========+
//
- // bin 32 stores a byte array whose length is upto (2^32)-1 bytes:
+ // bin 32 stores a byte array whose length is up to (2^32)-1 bytes:
// +--------+--------+--------+--------+--------+========+
// | 0xc6 |ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ| data |
// +--------+--------+--------+--------+--------+========+
@@ -259,17 +260,17 @@ public final class MsgPackOutputStream extends OutputStream {
* Appends an array data type flag to the stream.
*/
final MsgPackOutputStream startArray(int size) throws IOException {
- // fixarray stores an array whose length is upto 15 elements:
+ // fixarray stores an array whose length is up to 15 elements:
// +--------+~~~~~~~~~~~~~~~~~+
// |1001XXXX| N objects |
// +--------+~~~~~~~~~~~~~~~~~+
//
- // array 16 stores an array whose length is upto (2^16)-1 elements:
+ // array 16 stores an array whose length is up to (2^16)-1 elements:
// +--------+--------+--------+~~~~~~~~~~~~~~~~~+
// | 0xdc |YYYYYYYY|YYYYYYYY| N objects |
// +--------+--------+--------+~~~~~~~~~~~~~~~~~+
//
- // array 32 stores an array whose length is upto (2^32)-1 elements:
+ // array 32 stores an array whose length is up to (2^32)-1 elements:
// +--------+--------+--------+--------+--------+~~~~~~~~~~~~~~~~~+
// | 0xdd |ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ| N objects |
// +--------+--------+--------+--------+--------+~~~~~~~~~~~~~~~~~+
@@ -291,17 +292,17 @@ public final class MsgPackOutputStream extends OutputStream {
* Appends a map data type flag to the stream.
*/
final MsgPackOutputStream startMap(int size) throws IOException {
- // fixmap stores a map whose length is upto 15 elements
+ // fixmap stores a map whose length is up to 15 elements
// +--------+~~~~~~~~~~~~~~~~~+
// |1000XXXX| N*2 objects |
// +--------+~~~~~~~~~~~~~~~~~+
//
- // map 16 stores a map whose length is upto (2^16)-1 elements
+ // map 16 stores a map whose length is up to (2^16)-1 elements
// +--------+--------+--------+~~~~~~~~~~~~~~~~~+
// | 0xde |YYYYYYYY|YYYYYYYY| N*2 objects |
// +--------+--------+--------+~~~~~~~~~~~~~~~~~+
//
- // map 32 stores a map whose length is upto (2^32)-1 elements
+ // map 32 stores a map whose length is up to (2^32)-1 elements
// +--------+--------+--------+--------+--------+~~~~~~~~~~~~~~~~~+
// | 0xdf |ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ|ZZZZZZZZ| N*2 objects |
// +--------+--------+--------+--------+--------+~~~~~~~~~~~~~~~~~+
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
index b02ee46..1eb1a92 100644
--- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
@@ -49,6 +49,7 @@ public class MsgPackParser extends InputStreamParser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public MsgPackParser(PropertyStore propertyStore) {
@@ -64,7 +65,8 @@ public class MsgPackParser extends InputStreamParser {
/**
* Workhorse method.
*/
- private <T> T parseAnything(MsgPackParserSession session, ClassMeta<T> eType, MsgPackInputStream is, Object outer, BeanPropertyMeta pMeta) throws Exception {
+ private <T> T parseAnything(MsgPackParserSession session, ClassMeta<T> eType, MsgPackInputStream is, Object outer,
+ BeanPropertyMeta pMeta) throws Exception {
if (eType == null)
eType = (ClassMeta<T>)object();
@@ -154,7 +156,11 @@ public class MsgPackParser extends InputStreamParser {
m.put(parseAnything(session, string(), is, outer, pMeta), parseAnything(session, object(), is, m, pMeta));
o = session.cast(m, pMeta, eType);
} else if (dt == ARRAY) {
- Collection l = (sType.canCreateNewInstance(outer) ? (Collection)sType.newInstance() : new ObjectList(session));
+ Collection l = (
+ sType.canCreateNewInstance(outer)
+ ? (Collection)sType.newInstance()
+ : new ObjectList(session)
+ );
for (int i = 0; i < length; i++)
l.add(parseAnything(session, sType.getElementType(), is, l, pMeta));
o = l;
@@ -168,7 +174,11 @@ public class MsgPackParser extends InputStreamParser {
m.put(parseAnything(session, string(), is, outer, pMeta), parseAnything(session, object(), is, m, pMeta));
o = session.cast(m, pMeta, eType);
} else if (dt == ARRAY) {
- Collection l = (sType.isCollection() && sType.canCreateNewInstance(outer) ? (Collection)sType.newInstance() : new ObjectList(session));
+ Collection l = (
+ sType.isCollection() && sType.canCreateNewInstance(outer)
+ ? (Collection)sType.newInstance()
+ : new ObjectList(session)
+ );
for (int i = 0; i < length; i++)
l.add(parseAnything(session, sType.isArgs() ? sType.getArg(i) : sType.getElementType(), is, l, pMeta));
o = session.toArray(sType, l);
@@ -182,7 +192,8 @@ public class MsgPackParser extends InputStreamParser {
if (m.containsKey(session.getBeanTypePropertyName(eType)))
o = session.cast(m, pMeta, eType);
else
- throw new ParseException(session, "Class ''{0}'' could not be instantiated. Reason: ''{1}''", sType.getInnerClass().getName(), sType.getNotABeanReason());
+ throw new ParseException(session, "Class ''{0}'' could not be instantiated. Reason: ''{1}''",
+ sType.getInnerClass().getName(), sType.getNotABeanReason());
} else {
throw new ParseException(session, "Invalid data type {0} encountered for parse type {1}", dt, sType);
}
@@ -203,7 +214,8 @@ public class MsgPackParser extends InputStreamParser {
//--------------------------------------------------------------------------------
@Override /* Parser */
- public MsgPackParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public MsgPackParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer,
+ Locale locale, TimeZone timeZone, MediaType mediaType) {
return new MsgPackParserSession(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
index de0744c..b364222 100644
--- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
@@ -32,6 +32,7 @@ public class MsgPackParserBuilder extends ParserBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public MsgPackParserBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 1fdaed1..aa83954 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,9 +25,11 @@ 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.
+ * <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.
+ * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
+ * - Configurable properties common to all parsers.
* </ul>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
index 57beda3..170e165 100644
--- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
@@ -52,7 +52,8 @@ public final class MsgPackParserSession extends ParserSession {
* If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
*/
- public MsgPackParserSession(MsgPackParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public MsgPackParserSession(MsgPackParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer,
+ Locale locale, TimeZone timeZone, MediaType mediaType) {
super(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java
index 0f4949c..85f6708 100644
--- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java
@@ -50,6 +50,7 @@ public class MsgPackSerializer extends OutputStreamSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public MsgPackSerializer(PropertyStore propertyStore) {
@@ -63,11 +64,12 @@ public class MsgPackSerializer extends OutputStreamSerializer {
}
/**
- * Workhorse method. Determines the type of object, and then calls the
- * appropriate type-specific serialization method.
+ * Workhorse method. Determines the type of object, and then calls the appropriate type-specific serialization
+ * method.
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
- MsgPackOutputStream serializeAnything(MsgPackSerializerSession session, MsgPackOutputStream out, Object o, ClassMeta<?> eType, String attrName, BeanPropertyMeta pMeta) throws Exception {
+ MsgPackOutputStream serializeAnything(MsgPackSerializerSession session, MsgPackOutputStream out, Object o,
+ ClassMeta<?> eType, String attrName, BeanPropertyMeta pMeta) throws Exception {
if (o == null)
return out.appendNull();
@@ -132,7 +134,8 @@ public class MsgPackSerializer extends OutputStreamSerializer {
}
@SuppressWarnings({ "rawtypes", "unchecked" })
- private void serializeMap(MsgPackSerializerSession session, MsgPackOutputStream out, Map m, ClassMeta<?> type) throws Exception {
+ private void serializeMap(MsgPackSerializerSession session, MsgPackOutputStream out, Map m, ClassMeta<?> type)
+ throws Exception {
ClassMeta<?> keyType = type.getKeyType(), valueType = type.getValueType();
@@ -155,7 +158,8 @@ public class MsgPackSerializer extends OutputStreamSerializer {
}
}
- private void serializeBeanMap(MsgPackSerializerSession session, MsgPackOutputStream out, final BeanMap<?> m, String typeName) throws Exception {
+ private void serializeBeanMap(MsgPackSerializerSession session, MsgPackOutputStream out, final BeanMap<?> m,
+ String typeName) throws Exception {
List<BeanPropertyValue> values = m.getValues(session.isTrimNulls(), typeName != null ? session.createBeanTypeNameProperty(m, typeName) : null);
@@ -191,7 +195,8 @@ public class MsgPackSerializer extends OutputStreamSerializer {
}
@SuppressWarnings({"rawtypes", "unchecked"})
- private void serializeCollection(MsgPackSerializerSession session, MsgPackOutputStream out, Collection c, ClassMeta<?> type) throws Exception {
+ private void serializeCollection(MsgPackSerializerSession session, MsgPackOutputStream out, Collection c,
+ ClassMeta<?> type) throws Exception {
ClassMeta<?> elementType = type.getElementType();
List<Object> l = new ArrayList<Object>(c.size());
@@ -211,7 +216,8 @@ public class MsgPackSerializer extends OutputStreamSerializer {
//--------------------------------------------------------------------------------
@Override /* Serializer */
- public MsgPackSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ public MsgPackSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale,
+ TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
return new MsgPackSerializerSession(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
index 330ad04..19a33d2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
@@ -32,6 +32,7 @@ public class MsgPackSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public MsgPackSerializerBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 975acee..93348da 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,9 +25,12 @@ 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> - Properties associated with handling beans on serializers and parsers.
+ * <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.
+ * <li class='jc'><a class="doclink"
+ * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
* </ul>
* </ul>
*/
@@ -43,9 +46,11 @@ public final class MsgPackSerializerContext extends SerializerContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred through reflection.
+ * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
+ * through reflection.
* 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.
+ * For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined from
+ * the value type.
* <p>
* When present, this value overrides the {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -64,7 +69,8 @@ public final class MsgPackSerializerContext extends SerializerContext {
*/
public MsgPackSerializerContext(PropertyStore ps) {
super(ps);
- addBeanTypeProperties = ps.getProperty(MSGPACK_addBeanTypeProperties, boolean.class, ps.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));
+ addBeanTypeProperties = ps.getProperty(MSGPACK_addBeanTypeProperties, boolean.class,
+ ps.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));
}
@Override /* Context */
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
index 5cf5897..9a489d8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
@@ -36,20 +36,21 @@ public final class MsgPackSerializerSession extends SerializerSession {
* Create a new session using properties specified in the context.
*
* @param ctx The context creating this session object.
- * The context contains all the configuration settings for this object.
+ * The context contains all the configuration settings for this object.
* @param output The output object. See {@link JsonSerializerSession#getOutputStream()} for valid class types.
* @param op The override properties.
- * These override any context properties defined in the context.
+ * These override any context properties defined in the context.
* @param javaMethod The java method that called this serializer, usually the method in a REST servlet.
* @param locale The session locale.
- * If <jk>null</jk>, then the locale defined on the context is used.
+ * If <jk>null</jk>, then the locale defined on the context is used.
* @param timeZone The session timezone.
- * If <jk>null</jk>, then the timezone defined on the context is used.
+ * If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
* @param uriContext The URI context.
- * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
+ * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
*/
- protected MsgPackSerializerSession(MsgPackSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ protected MsgPackSerializerSession(MsgPackSerializerContext ctx, ObjectMap op, Object output, Method javaMethod,
+ Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
super(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
if (op == null || op.isEmpty()) {
addBeanTypeProperties = ctx.addBeanTypeProperties;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/package.html b/juneau-core/src/main/java/org/apache/juneau/package.html
index 5200d49..3c84aa1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/package.html
@@ -71,12 +71,16 @@
<h2 class='topic' onclick='toggle(this)'>1 - Bean Context API</h2>
<div class='topic'>
<p>
- The {@link org.apache.juneau.BeanContext} class is the core class in the Juneau architecture. It serves multiple functions...
+ The {@link org.apache.juneau.BeanContext} class is the core class in the Juneau architecture. It serves
+ multiple functions...
</p>
<ul class='normal'>
<li>It provides the ability to create instances of {@link org.apache.juneau.BeanMap BeanMaps}.
- <li>It serves as a repository for {@link org.apache.juneau.transform.BeanFilter BeanFilters} and {@link org.apache.juneau.transform.PojoSwap PojoSwaps}, which are used to tailor how Java objects are handled.
- <li>It's used by all built-in {@link org.apache.juneau.serializer.Serializer Serializers} and {@link org.apache.juneau.parser.Parser Parsers} for working with POJOs in a consistent way.
+ <li>It serves as a repository for {@link org.apache.juneau.transform.BeanFilter BeanFilters} and
+ {@link org.apache.juneau.transform.PojoSwap PojoSwaps}, which are used to tailor how Java objects are
+ handled.
+ <li>It's used by all built-in {@link org.apache.juneau.serializer.Serializer Serializers} and
+ {@link org.apache.juneau.parser.Parser Parsers} for working with POJOs in a consistent way.
</ul>
<!-- ======================================================================================================== -->
@@ -84,17 +88,24 @@
<h3 class='topic' onclick='toggle(this)'>1.1 - The BeanMap class</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.BeanMap} class allows you to access the properties of a bean through the familiar {@code Map} interface.
- So, for example, you can use the {@code Map.get(key)} method to retrieve a property value in leu of it's getter method, and the {@code Map.put(key, value)} method to set a property value in leu of it's setter method.
+ The {@link org.apache.juneau.BeanMap} class allows you to access the properties of a bean through the
+ familiar {@code Map} interface.
+ So, for example, you can use the {@code Map.get(key)} method to retrieve a property value in lieu of it's
+ getter method, and the {@code Map.put(key, value)} method to set a property value in lieu of it's
+ setter method.
</p>
<p>
- The serialization and parsing of beans in Juneau is accomplished by wrapping Java beans inside instances of the class {@code BeanMap}.
+ The serialization and parsing of beans in Juneau is accomplished by wrapping Java beans inside instances of
+ the class {@code BeanMap}.
</p>
<p>
- <b>Note:</b> Instances of {@link org.apache.juneau.BeanMap} objects are always retrieved through the {@link org.apache.juneau.BeanContext} class. You cannot instantiate {@code BeanMaps} directly since the rules for defining what constitutes a bean depend on various settings in the bean context.
+ <b>Note:</b> Instances of {@link org.apache.juneau.BeanMap} objects are always retrieved through the
+ {@link org.apache.juneau.BeanContext} class. You cannot instantiate {@code BeanMaps} directly since the
+ rules for defining what constitutes a bean depend on various settings in the bean context.
</p>
<p>
- In general, the performance on using the {@link org.apache.juneau.BeanMap} class to access properties is equivalent to using reflection directly.
+ In general, the performance on using the {@link org.apache.juneau.BeanMap} class to access properties is
+ equivalent to using reflection directly.
</p>
<p>
See the {@link org.apache.juneau.BeanMap} javadoc for more information.
@@ -106,11 +117,14 @@
<h3 class='topic' onclick='toggle(this)'>1.2 - The BeanContext and BeanSession classes</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.BeanContext} and {@link org.apache.juneau.BeanSession} classes are the workhorse class used to wrap Java beans inside {@link org.apache.juneau.BeanMap BeanMaps}.
- There are several options provided on the {@link org.apache.juneau.BeanContext} class to tailor the definition of a bean.
+ The {@link org.apache.juneau.BeanContext} and {@link org.apache.juneau.BeanSession} classes are the
+ workhorse class used to wrap Java beans inside {@link org.apache.juneau.BeanMap BeanMaps}.
+ There are several options provided on the {@link org.apache.juneau.BeanContext} class to tailor the
+ definition of a bean.
</p>
<p>
- The following is a very simple example of how to wrap a bean inside a {@link org.apache.juneau.BeanMap} wrapper and use the wrapper interface to get and set property values on the bean.
+ The following is a very simple example of how to wrap a bean inside a {@link org.apache.juneau.BeanMap}
+ wrapper and use the wrapper interface to get and set property values on the bean.
In this case, we're using the DEFAULT bean context.
</p>
<p class='bcode'>
@@ -168,19 +182,24 @@
<h3 class='topic' onclick='toggle(this)'>1.3 - Bean annotations</h3>
<div class='topic'>
<p>
- Juneau provides the following annotations that can be used to fine-tune what properties are associated with beans:
+ Juneau provides the following annotations that can be used to fine-tune what properties are associated with
+ beans:
</p>
<ul class='normal'>
<li>{@link org.apache.juneau.annotation.Bean} - Fine-tune properties associated with beans.
- <li>{@link org.apache.juneau.annotation.BeanProperty} - Fine-tune bean properties (fields / getters / setters).
- <li>{@link org.apache.juneau.annotation.BeanConstructor} - Define read-only bean properties that can only be set through constructor arguments.
- <li>{@link org.apache.juneau.annotation.BeanIgnore} - Prevent bean classes/methods/fields from being interpreted as bean constructs.
+ <li>{@link org.apache.juneau.annotation.BeanProperty} - Fine-tune bean properties
+ (fields / getters / setters).
+ <li>{@link org.apache.juneau.annotation.BeanConstructor} - Define read-only bean properties that can only
+ be set through constructor arguments.
+ <li>{@link org.apache.juneau.annotation.BeanIgnore} - Prevent bean classes/methods/fields from being
+ interpreted as bean constructs.
</ul>
<p>
These annotations always override the settings defined in the {@link org.apache.juneau.BeanContext} class.
</p>
<p>
- For example, the following bean class will only have one property associated with it, <js>"name"</js>, since it's the only one listed in the list of properties.
+ For example, the following bean class will only have one property associated with it, <js>"name"</js>,
+ since it's the only one listed in the list of properties.
</p>
<p class='bcode'>
<jc>// Bean with only one 'name' property</jc>
@@ -193,17 +212,23 @@
}
</p>
<p>
- When this bean is serialized using one of the {@link org.apache.juneau.serializer.Serializer Serializers}, the age property will be ignored.
+ When this bean is serialized using one of the {@link org.apache.juneau.serializer.Serializer Serializers},
+ the age property will be ignored.
</p>
<p>
- Using the <ja>@Bean</ja> and <ja>@BeanProperty</ja> annotations, it's also possible to include non-standard properties (for example, getters or setters with non-standard names), or override the names of properties (for example, {@code "Name"} or {@code "fullName"} instead of {@code "name"}).
+ Using the <ja>@Bean</ja> and <ja>@BeanProperty</ja> annotations, it's also possible to include non-standard
+ properties (for example, getters or setters with non-standard names), or override the names of properties
+ (for example, {@code "Name"} or {@code "fullName"} instead of {@code "name"}).
</p>
<p>
- It should be noted that the {@link org.apache.juneau.transform.BeanFilter} class can also be used to exclude properties from beans.
+ It should be noted that the {@link org.apache.juneau.transform.BeanFilter} class can also be used to
+ exclude properties from beans.
However, only the annotations can be used to include non-standard properties or override property names.
</p>
<p>
- See the {@link org.apache.juneau.annotation.Bean}, {@link org.apache.juneau.annotation.BeanProperty}, {@link org.apache.juneau.annotation.BeanConstructor}, and {@link org.apache.juneau.annotation.BeanIgnore} javadocs for more information.
+ See the {@link org.apache.juneau.annotation.Bean}, {@link org.apache.juneau.annotation.BeanProperty},
+ {@link org.apache.juneau.annotation.BeanConstructor}, and {@link org.apache.juneau.annotation.BeanIgnore}
+ javadocs for more information.
</p>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/parser/InputStreamParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/InputStreamParser.java b/juneau-core/src/main/java/org/apache/juneau/parser/InputStreamParser.java
index 84a9279..622dd35 100644
--- a/juneau-core/src/main/java/org/apache/juneau/parser/InputStreamParser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/parser/InputStreamParser.java
@@ -36,6 +36,7 @@ public abstract class InputStreamParser extends Parser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
protected InputStreamParser(PropertyStore propertyStore) {
[02/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/javadoc/overview.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/javadoc/overview.html b/juneau-core/src/main/javadoc/overview.html
index 310cd26..8537719 100644
--- a/juneau-core/src/main/javadoc/overview.html
+++ b/juneau-core/src/main/javadoc/overview.html
@@ -61,7 +61,8 @@
<li>A REST client API for interacting with REST interfaces using POJOs.
<li>A remote proxy API built on top of REST.
<li>A sophisticated INI config file API.
- <li>A REST microservice API that combines all the features above for creating lightweight standalone REST interfaces that start up in milliseconds.
+ <li>A REST microservice API that combines all the features above for creating lightweight stand-alone REST
+ interfaces that start up in milliseconds.
</ul>
<a id='TOC'></a><h5 class='toc'>Table of Contents</h5>
@@ -142,8 +143,10 @@
<li><p><a class='doclink' href='#Cookbook.Core'>Core API</a></p>
<li><p><a class='doclink' href='#Cookbook.Server'>Server API</a></p>
<ol>
- <li><p><a class='doclink' href='#Cookbook.Server.applyDoubletransform'>Apply a transform that changes the format of doubles</a></p>
- <li><p><a class='doclink' href='#Cookbook.Server.applyTransformsSubset'>Apply transforms to a subset of serializers or parsers</a></p>
+ <li><p><a class='doclink' href='#Cookbook.Server.applyDoubletransform'>Apply a transform that changes the
+ format of doubles</a></p>
+ <li><p><a class='doclink' href='#Cookbook.Server.applyTransformsSubset'>Apply transforms to a subset of
+ serializers or parsers</a></p>
</ol>
<li><p><a class='doclink' href='#Cookbook.Client'>Client API</a></p>
<ol>
@@ -163,7 +166,8 @@
<div class='topic'>
<p>
Juneau started off as a popular internal IBM toolkit called Juno.
- Originally used for serializing POJOs to and from JSON, it later expanded in scope to include a variety of content types, and then later REST servlet, client, and microservice APIs.
+ Originally used for serializing POJOs to and from JSON, it later expanded in scope to include a variety of
+ content types, and then later REST servlet, client, and microservice APIs.
It's use grew to more than 50 projects and was one of the most popular community source projects within IBM.
</p>
<p>
@@ -172,7 +176,8 @@
<h5 class='toc'>Features</h5>
<ol class='toc'>
<li>
- <p>Extensive and extensible support for a large variety of POJOs, including structured data (beans) and unstructured data (<code>Maps</code> and <code>Collections</code>).</p>
+ <p>Extensive and extensible support for a large variety of POJOs, including structured data (beans) and
+ unstructured data (<code>Maps</code> and <code>Collections</code>).</p>
<li>
<p>Serialization support:</p>
<ul>
@@ -241,25 +246,33 @@
Juneau requires Java 6+. The majority of the code has no other dependencies except for the following packages:
</p>
<ul class='doctree'>
- <li class='jp'> <a class='doclink' href='org/apache/juneau/jena/package-summary.html#TOC'>org.apache.juneau.jena</a> - RDF support. Requires Apache Jena 2.7.1+.
- <li class='jp'> <a class='doclink' href='org/apache/juneau/rest/package-summary.html#TOC'>org.apache.juneau.rest</a> - REST servlet support. Requires JEE 1.3+.
- <li class='jp'> <a class='doclink' href='org/apache/juneau/rest/client/package-summary.html#TOC'>org.apache.juneau.rest.client</a> - REST client support. Requires Apache HttpClient 4.5+.
+ <li class='jp'> <a class='doclink'
+ href='org/apache/juneau/jena/package-summary.html#TOC'>org.apache.juneau.jena</a>
+ - RDF support. Requires Apache Jena 2.7.1+.
+ <li class='jp'> <a class='doclink'
+ href='org/apache/juneau/rest/package-summary.html#TOC'>org.apache.juneau.rest</a>
+ - REST servlet support. Requires JEE 1.3+.
+ <li class='jp'> <a class='doclink'
+ href='org/apache/juneau/rest/client/package-summary.html#TOC'>org.apache.juneau.rest.client</a>
+ - REST client support. Requires Apache HttpClient 4.5+.
</ul>
<p>
OSGi bundles are also provided that break down Juneau into the following components:
</p>
<ul class='spaced-list'>
- <li><l>org.apache.juneau.core.jar</l> - Serializers, parsers, INI file support.<br>
- <li><l>org.apache.juneau.rest.jar</l> - REST servlet support.<br>
- <li><l>org.apache.juneau.rest.client.jar</l> - REST client support.<br>
- <li><l>org.apache.juneau.microservice.jar</l> - Microservice support.<br>
+ <li><l>org.apache.juneau.core.jar</l> - Serializers, parsers, INI file support.
+ <li><l>org.apache.juneau.rest.jar</l> - REST servlet support.
+ <li><l>org.apache.juneau.rest.client.jar</l> - REST client support.
+ <li><l>org.apache.juneau.microservice.jar</l> - Microservice support.
</ul>
<p>
The following zip files are also provided:
</p>
<ul class='spaced-list'>
- <li><l>microservice-project.zip</l> - Contains a template Eclipse project for quickly creating REST resources as executable jars.
- <li><l>microservice-samples-project.zip</l> - Contains sample code demonstrating various aspects of Juneau.<br>
+ <li><l>microservice-project.zip</l> - Contains a template Eclipse project for quickly creating REST resources
+ as executable jars.
+ <li><l>microservice-samples-project.zip</l> - Contains sample code demonstrating various aspects of Juneau.
+ <br>
These are discussed in detail in the <a class='doclink' href="#Samples">Samples</a> section.
</ul>
@@ -275,13 +288,15 @@
<h2 class='topic' onclick='toggle(this)'>2 - Juneau Core (org.apache.juneau)</h2>
<div class='topic'>
<p>
- The core packages of Juneau contains serializers and parsers for converting POJOs to and from a wide variety of content types.
+ The core packages of Juneau contains serializers and parsers for converting POJOs to and from a wide variety of
+ content types.
It uses a common API for defining serializers and parsers.
</p>
<p>
One of the goals of Juneau was to make serialization as simple as possible.
In a single line of code, you should be able to serialize and parse most POJOs.
- Despite this simplicity, Juneau provides lots of extensibility and configuration properties for tailoring how POJOs are serialized and parsed.
+ Despite this simplicity, Juneau provides lots of extensibility and configuration properties for tailoring how
+ POJOs are serialized and parsed.
</p>
<!-- ======================================================================================================== -->
@@ -290,7 +305,8 @@
<div class='topic'>
<p>
The built-in serializers in Juneau are fast, efficient, and highly configurable.
- They work by serializing POJOs directly to streams instead of using intermediate Document Object Model objects.
+ They work by serializing POJOs directly to streams instead of using intermediate Document Object Model
+ objects.
</p>
<p>
In most cases, you can serialize objects in one line of code by using one of the default serializers:
@@ -355,13 +371,18 @@
String json = serializer.serialize(someObject);
</p>
<p>
- Default serialization support is provided for Java primitives, <code>Maps</code>, <code>Collections</code>, beans, and arrays. <br>
- Extensible support for other data types such as <code>Calendars</code>, <code>Dates</code>, <code>Iterators</code> is available through the use of POJO swaps (described later).
+ Default serialization support is provided for Java primitives, <code>Maps</code>, <code>Collections</code>,
+ beans, and arrays.
+ <br>
+ Extensible support for other data types such as <code>Calendars</code>, <code>Dates</code>,
+ <code>Iterators</code> is available through the use of POJO swaps (described later).
</p>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/serializer/package-summary.html#TOC'>org.apache.juneau.serializer</a> - Serializer API Javadoc
+ <li class='jp'><a class='doclink'
+ href='org/apache/juneau/serializer/package-summary.html#TOC'>org.apache.juneau.serializer</a>
+ - Serializer API Javadoc
</ul>
</div>
@@ -370,7 +391,8 @@
<h3 class='topic' onclick='toggle(this)'>2.2 - Parsers</h3>
<div class='topic'>
<p>
- Parsers work by parsing input directly into POJOs instead of having to create intermediate Document Object Models.
+ Parsers work by parsing input directly into POJOs instead of having to create intermediate Document Object
+ Models.
This allows them to parse input with minimal object creation.
</p>
<p>
@@ -402,7 +424,8 @@
<jc>// Parse a JSON object as a HashMap<String,LinkedList<Person>>.</jc>
json = <js>"{a:[{name:'John Smith',age:21},{name:'Joe Smith',age:42}]}"</js>;
- Map<String,List<Person>> m5 = parser.parse(json, HashMap.<jk>class</jk>, String.<jk>class</jk>, LinkedList.<jk>class</jk>, Person.<jk>class</jk>)
+ Map<String,List<Person>> m5 = parser.parse(json, HashMap.<jk>class</jk>, String.<jk>class</jk>,
+ LinkedList.<jk>class</jk>, Person.<jk>class</jk>)
<jc>// Parse a JSON array of integers as a Collection of Integers or int[] array.</jc>
json = <js>"[1,2,3]"</js>;
@@ -434,14 +457,19 @@
<ul class='doctree'>
<li class='info'>
In the example above, we're parsing "lax" JSON (single quotes, unquoted attributes).
- The JSON parser can handle any valid JSON syntax (such as quoted or unquoted attributes, single or double quotes).<br>
- It can also handle JSON fragements and embedded Javascript comments.
- Many of the JSON examples provided will use lax syntax which is easier to read since we don't have to deal with escapes.
+ The JSON parser can handle any valid JSON syntax (such as quoted or unquoted attributes, single or double
+ quotes).
+ <br>
+ It can also handle JSON fragments and embedded Javascript comments.
+ Many of the JSON examples provided will use lax syntax which is easier to read since we don't have to deal
+ with escapes.
</ul>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/parser/package-summary.html#TOC'>org.apache.juneau.parser</a> - Parser API Javadoc
+ <li class='jp'><a class='doclink'
+ href='org/apache/juneau/parser/package-summary.html#TOC'>org.apache.juneau.parser</a>
+ - Parser API Javadoc
</ul>
</div>
@@ -450,8 +478,10 @@
<h3 class='topic' onclick='toggle(this)'>2.3 - SerializerGroups and ParserGroups</h3>
<div class='topic'>
<p>
- Above the serializers and parsers are the {@link org.apache.juneau.serializer.SerializerGroup} and {@link org.apache.juneau.parser.ParserGroup} classes.
- These classes allow serializers and parsers to be retrieved by W3C-compliant HTTP <code>Accept</code> and <code>Content-Type</code> values...
+ Above the serializers and parsers are the {@link org.apache.juneau.serializer.SerializerGroup} and
+ {@link org.apache.juneau.parser.ParserGroup} classes.
+ These classes allow serializers and parsers to be retrieved by W3C-compliant HTTP <code>Accept</code>
+ and <code>Content-Type</code> values...
</p>
<p class='bcode'>
<jc>// Construct a new serializer group with configuration parameters that get applied to all serializers.</jc>
@@ -490,9 +520,12 @@
<h3 class='topic' onclick='toggle(this)'>2.4 - ObjectMap and ObjectList</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.ObjectMap} and {@link org.apache.juneau.ObjectList} classes are generic Java representations of JSON objects and arrays.
- These classes can be used to create "unstructured" models for serialization (as opposed to "structured" models consisting of beans).
- If you want to quickly generate JSON/XML/HTML from generic maps/collections, or parse JSON/XML/HTML into generic maps/collections, these classes work well.
+ The {@link org.apache.juneau.ObjectMap} and {@link org.apache.juneau.ObjectList} classes are generic Java
+ representations of JSON objects and arrays.
+ These classes can be used to create "unstructured" models for serialization (as opposed to "structured"
+ models consisting of beans).
+ If you want to quickly generate JSON/XML/HTML from generic maps/collections, or parse JSON/XML/HTML into
+ generic maps/collections, these classes work well.
</p>
<p>
These classes extend directly from the following JCF classes:
@@ -508,20 +541,22 @@
</ul>
</ul>
<p>
- The <l>ObjectMap</l> and <l>ObjectList</l> classes are very similar to the <l>JSONObject</l> and <l>JSONArray</l>
- classes found in other libraries. However, the names were chosen
- because the concepts of <l>Maps</l> and <l>Lists</l> are already familiar to
- Java programmers, and these classes can be used with any of the serializers or parsers.
+ The <l>ObjectMap</l> and <l>ObjectList</l> classes are very similar to the <l>JSONObject</l> and
+ <l>JSONArray</l> classes found in other libraries.
+ However, the names were chosen because the concepts of <l>Maps</l> and <l>Lists</l> are already familiar to
+ Java programmers, and these classes can be used with any of the serializers or parsers.
</p>
<p>
These object can be serialized in one of two ways:
</p>
<ol class='spaced-list'>
- <li>Using the provided {@link org.apache.juneau.ObjectMap#serializeTo(java.io.Writer)} or {@link org.apache.juneau.ObjectList#serializeTo(java.io.Writer)} methods.
+ <li>Using the provided {@link org.apache.juneau.ObjectMap#serializeTo(java.io.Writer)} or
+ {@link org.apache.juneau.ObjectList#serializeTo(java.io.Writer)} methods.
<li>Passing them to one of the {@link org.apache.juneau.serializer.Serializer} serialize methods.
</ol>
<p>
- Any valid JSON can be parsed into an unstructured model consisting of generic {@link org.apache.juneau.ObjectMap} and {@link org.apache.juneau.ObjectList} objects.
+ Any valid JSON can be parsed into an unstructured model consisting of generic
+ {@link org.apache.juneau.ObjectMap} and {@link org.apache.juneau.ObjectList} objects.
</p>
<p class='bcode'>
<jc>// Parse an arbitrary JSON document into an unstructered data model
@@ -541,8 +576,8 @@
</p>
<ul class='doctree'>
<li class='info'>
- As a general rule, if you do not specify a target type during parsing, or if the target type cannot be determined
- through reflection, the parsers automatically generate <l>ObjectMaps</l> and <l>ObjectLists</l>.
+ As a general rule, if you do not specify a target type during parsing, or if the target type cannot be
+ determined through reflection, the parsers automatically generate <l>ObjectMaps</l> and <l>ObjectLists</l>.
</ul>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
@@ -556,14 +591,16 @@
<h3 class='topic' onclick='toggle(this)'>2.5 - Configurable Properties</h3>
<div class='topic'>
<p>
- Serializers and parsers have a wide variety of configurable properties.<br>
+ Serializers and parsers have a wide variety of configurable properties.
+ <br>
For example, the following code shows how to configure a JSON serializer:
</p>
<p class='bcode'>
JsonSerializer s = <jk>new</jk> JsonSerializerBuilder().simple().ws().sq().build();
</p>
<p>
- However, each of the serializers and parsers already contain reusable instances with common configurations.<br>
+ However, each of the serializers and parsers already contain reusable instances with common configurations.
+ <br>
For example, JSON has the following predefined reusable serializers and parsers:
</p>
<ul class='doctree'>
@@ -652,21 +689,31 @@
These classes are:
</p>
<ul class='doctree'>
- <li class='jc'>{@link org.apache.juneau.transform.PojoSwap} - Tailor how specific non-bean classes are handled by the framework.
- <li class='jc'>{@link org.apache.juneau.transform.BeanFilter} - Tailor how specific bean classes are handled by the framework.
+ <li class='jc'>{@link org.apache.juneau.transform.PojoSwap}
+ - Tailor how specific non-bean classes are handled by the framework.
+ <li class='jc'>{@link org.apache.juneau.transform.BeanFilter}
+ - Tailor how specific bean classes are handled by the framework.
</ul>
<p>
Annotations are also provided that allow you to use transformations directly on class definitions:
</p>
<ul class='doctree'>
- <li class='ja'>{@link org.apache.juneau.annotation.Pojo @Pojo} - Used to tailor how non-bean POJOs get interpreted by the framework.
- <li class='ja'>{@link org.apache.juneau.annotation.Bean @Bean} - Used to tailor how beans get interpreted by the framework.
- <li class='ja'>{@link org.apache.juneau.annotation.BeanConstructor @BeanConstructor} - Maps constructor arguments to property names on beans with read-only properties.
- <li class='ja'>{@link org.apache.juneau.annotation.BeanIgnore @BeanIgnore} - Ignore classes, fields, and methods from being interpreted as bean or bean components.
- <li class='ja'>{@link org.apache.juneau.annotation.BeanProperty @BeanProperty} - Used to tailor how bean properties get interpreted by the framework.
- <li class='ja'>{@link org.apache.juneau.annotation.NameProperty @NameProperty} - Identifies a setter as a method for setting the name of a POJO as it's known by its parent object.
- <li class='ja'>{@link org.apache.juneau.annotation.ParentProperty @ParentProperty} - Identifies a setter as a method for adding a parent reference to a child object.
- <li class='ja'>{@link org.apache.juneau.annotation.URI @URI} - Used to identify a class or bean property as a URI.
+ <li class='ja'>{@link org.apache.juneau.annotation.Pojo @Pojo}
+ - Used to tailor how non-bean POJOs get interpreted by the framework.
+ <li class='ja'>{@link org.apache.juneau.annotation.Bean @Bean}
+ - Used to tailor how beans get interpreted by the framework.
+ <li class='ja'>{@link org.apache.juneau.annotation.BeanConstructor @BeanConstructor}
+ - Maps constructor arguments to property names on beans with read-only properties.
+ <li class='ja'>{@link org.apache.juneau.annotation.BeanIgnore @BeanIgnore}
+ - Ignore classes, fields, and methods from being interpreted as bean or bean components.
+ <li class='ja'>{@link org.apache.juneau.annotation.BeanProperty @BeanProperty}
+ - Used to tailor how bean properties get interpreted by the framework.
+ <li class='ja'>{@link org.apache.juneau.annotation.NameProperty @NameProperty}
+ - Identifies a setter as a method for setting the name of a POJO as it's known by its parent object.
+ <li class='ja'>{@link org.apache.juneau.annotation.ParentProperty @ParentProperty}
+ - Identifies a setter as a method for adding a parent reference to a child object.
+ <li class='ja'>{@link org.apache.juneau.annotation.URI @URI}
+ - Used to identify a class or bean property as a URI.
</ul>
<!-- ======================================================================================================== -->
@@ -679,14 +726,17 @@
</p>
<p>
Swaps are very easy to understand.
- Simply put, they can be thought of as 'object swappers' that swap in serializable objects for non-serializable ones during serialization, and vis-versa during parsing.
+ Simply put, they can be thought of as 'object swappers' that swap in serializable objects for
+ non-serializable ones during serialization, and vis-versa during parsing.
</p>
<p>
- Some examples of non-serializable POJOs are <code>File</code>, <code>Reader</code>, <code>Iterable</code>, etc...
+ Some examples of non-serializable POJOs are <code>File</code>, <code>Reader</code>,
+ <code>Iterable</code>, etc...
These are classes that aren't beans and cannot be represented as simple maps, collections, or primitives.
</p>
<p>
- In the following example, we introduce a <code>PojoSwap</code> that will swap in ISO8601 strings for <code>Date</code> objects:
+ In the following example, we introduce a <code>PojoSwap</code> that will swap in ISO8601 strings for
+ <code>Date</code> objects:
</p>
<p class='bcode'>
<jc>// Sample swap for converting Dates to ISO8601 strings.</jc>
@@ -734,7 +784,8 @@
Several <code>PojoSwaps</code> are already provided for common Java objects:
</p>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/transforms/package-summary.html#TOC'>org.apache.juneau.transforms</a>
+ <li class='jp'><a class='doclink'
+ href='org/apache/juneau/transforms/package-summary.html#TOC'>org.apache.juneau.transforms</a>
<ul>
<li class='jc'>{@link org.apache.juneau.transforms.ByteArrayBase64Swap}
<li class='jac'>{@link org.apache.juneau.transforms.CalendarSwap}
@@ -746,13 +797,15 @@
</ul>
</ul>
<p>
- In particular, the {@link org.apache.juneau.transforms.CalendarSwap} and {@link org.apache.juneau.transforms.DateSwap} tramsforms
- provide a large number of customized swaps to ISO, RFC, or localized strings.
+ In particular, the {@link org.apache.juneau.transforms.CalendarSwap} and
+ {@link org.apache.juneau.transforms.DateSwap} transforms provide a large number of customized swaps to
+ ISO, RFC, or localized strings.
</p>
<ul class='doctree'>
<li class='info'>
The 'swapped' class type must be a serializable type.<br>
- See the definition for Category 4 objects in <a class='doclink' href='#Core.PojoCategories'>POJO Categories</a>.
+ See the definition for Category 4 objects in <a class='doclink'
+ href='#Core.PojoCategories'>POJO Categories</a>.
</ul>
</div>
@@ -765,11 +818,12 @@
This can often be simpler than using <code>PojoSwaps</code>.
</p>
<p>
- Objects serialized as <code>Strings</code> can be parsed back into their original objects by implementing
- one of the following methods on the class:
+ Objects serialized as <code>Strings</code> can be parsed back into their original objects by
+ implementing one of the following methods on the class:
</p>
<ul>
- <li><code><jk>public static</jk> T fromString(String)</code> method.<br>
+ <li><code><jk>public static</jk> T fromString(String)</code> method.
+ <br>
Any of the following method names also work:
<ul>
<li><code>valueOf(String)</code>
@@ -781,32 +835,42 @@
<li><code><jk>public</jk> T(String)</code> constructor.
</ul>
<p>
- Note that these methods cover conversion from several built-in Java types, meaning the parsers can automatically construct these objects from strings:
+ Note that these methods cover conversion from several built-in Java types, meaning the parsers can
+ automatically construct these objects from strings:
</p>
<ul>
<li><code>fromString(String)</code> - {@link java.util.UUID}
- <li><code>valueOf(String)</code> - {@link java.lang.Boolean}, {@link java.lang.Byte}, {@link java.lang.Double}, {@link java.lang.Float},
- {@link java.lang.Integer}, {@link java.lang.Long}, {@link java.lang.Short}, {@link java.sql.Date}, {@link java.sql.Time}, {@link java.sql.Timestamp}
- <li><code>parse(String)</code> - {@link java.text.DateFormat}, {@link java.text.MessageFormat}, {@link java.text.NumberFormat}, {@link java.util.Date}, {@link java.util.logging.Level}
+ <li><code>valueOf(String)</code> - {@link java.lang.Boolean}, {@link java.lang.Byte},
+ {@link java.lang.Double}, {@link java.lang.Float},
+ {@link java.lang.Integer}, {@link java.lang.Long}, {@link java.lang.Short}, {@link java.sql.Date},
+ {@link java.sql.Time}, {@link java.sql.Timestamp}
+ <li><code>parse(String)</code> - {@link java.text.DateFormat}, {@link java.text.MessageFormat},
+ {@link java.text.NumberFormat}, {@link java.util.Date}, {@link java.util.logging.Level}
<li><code>parseString(String)</code> - {@link javax.xml.bind.DatatypeConverter}
<li><code>forName(String)</code> - {@link java.lang.Class}
</ul>
<p>
- If you want to force a bean-like class to be serialized as a string, you can use the {@link org.apache.juneau.annotation.BeanIgnore @BeanIgnore}
- annotation on the class to force it to be serialized to a string using the <code>toString()</code> method.
+ If you want to force a bean-like class to be serialized as a string, you can use the
+ {@link org.apache.juneau.annotation.BeanIgnore @BeanIgnore} annotation on the class to force it to be
+ serialized to a string using the <code>toString()</code> method.
</p>
<p>
- Serializing to other intermediate objects can be accomplished by defining a swap method directly on the class:
+ Serializing to other intermediate objects can be accomplished by defining a swap method directly on the
+ class:
</p>
<ul>
- <li><code><jk>public</jk> X swap(BeanSession)</code> method, where <code>X</code> is any serializable object.
+ <li><code><jk>public</jk> X swap(BeanSession)</code> method, where <code>X</code> is any serializable
+ object.
</ul>
<p>
- The <code>BeanSession</code> parameter allows you access to various information about the current serialization session.
- For example, you could provide customized results based on the media type being produced ({@link org.apache.juneau.BeanSession#getMediaType()}).
+ The <code>BeanSession</code> parameter allows you access to various information about the current
+ serialization session.
+ For example, you could provide customized results based on the media type being produced
+ ({@link org.apache.juneau.BeanSession#getMediaType()}).
</p>
<p>
- The following example shows how an HTML5 form template object can be created that gets serialized as a populated HTML5 {@link org.apache.juneau.dto.html5.Form} bean.
+ The following example shows how an HTML5 form template object can be created that gets serialized as a
+ populated HTML5 {@link org.apache.juneau.dto.html5.Form} bean.
</p>
<p class='bcode'>
<jk>import static</jk> org.apache.juneau.dto.html5.HtmlBuilder.*;
@@ -837,14 +901,17 @@
}
</p>
<p>
- Swapped objects can be converted back into their original form by the parsers by specifying one of the following methods:
+ Swapped objects can be converted back into their original form by the parsers by specifying one of the
+ following methods:
</p>
<ul>
- <li><code><jk>public static</jk> T unswap(BeanSession, X)</code> method where <code>X</code> is the swap class type.
+ <li><code><jk>public static</jk> T unswap(BeanSession, X)</code> method where <code>X</code> is the
+ swap class type.
<li><code><jk>public</jk> T(X)</code> constructor where <code>X</code> is the swap class type.
</ul>
<p>
- The following shows how our form template class can be modified to allow the parsers to reconstruct our original object:
+ The following shows how our form template class can be modified to allow the parsers to reconstruct our
+ original object:
</p>
<p class='bcode'>
<jk>import static</jk> org.apache.juneau.dto.html5.HtmlBuilder.*;
@@ -863,8 +930,10 @@
<jc>// Our 'unswap' constructor</jc>
<jk>public</jk> FormTemplate(Form f) {
<jk>this</jk>.<jf>action</jf> = f.getAttr(<js>"action"</js>);
- <jk>this</jk>.<jf>value1</jf> = f.getChild(Input.<jk>class</jk>, 0).getAttr(<jk>int</jk>.<jk>class</jk>, <js>"value"</js>);
- <jk>this</jk>.<jf>value2</jf> = f.getChild(Input.<jk>class</jk>, 1).getAttr(<jk>boolean</jk>.<jk>class</jk>, <js>"value"</js>);
+ <jk>this</jk>.<jf>value1</jf> = f.getChild(Input.<jk>class</jk>, 0)
+ .getAttr(<jk>int</jk>.<jk>class</jk>, <js>"value"</js>);
+ <jk>this</jk>.<jf>value2</jf> = f.getChild(Input.<jk>class</jk>, 1)
+ .getAttr(<jk>boolean</jk>.<jk>class</jk>, <js>"value"</js>);
}
<jk>public</jk> FormTemplate(String action, <jk>int</jk> value1, <jk>boolean</jk> value2) {
@@ -887,7 +956,8 @@
<h4 class='topic' onclick='toggle(this)'>2.6.3 - BeanFilters and @Bean annotations</h4>
<div class='topic'>
<p>
- {@link org.apache.juneau.transform.BeanFilter BeanFilters} are used to control aspects of how beans are handled during serialization and parsing.
+ {@link org.apache.juneau.transform.BeanFilter BeanFilters} are used to control aspects of how beans are
+ handled during serialization and parsing.
They allow you to control various aspects of beans, such as...
</p>
<ul>
@@ -897,8 +967,8 @@
<li>Overriding reading and writing of properties.
</ul>
<p>
- In practice, however, it's simpler to use the {@link org.apache.juneau.annotation.Bean @Bean} and {@link org.apache.juneau.annotation.BeanProperty @BeanProperty}
- annotations on your bean classes.
+ In practice, however, it's simpler to use the {@link org.apache.juneau.annotation.Bean @Bean} and
+ {@link org.apache.juneau.annotation.BeanProperty @BeanProperty} annotations on your bean classes.
The annotations are functionally equivalent to the bean filter class.
</p>
<p class='bcode'>
@@ -938,7 +1008,8 @@
The <code>addBeanFilter(Class...)</code> method also allows you to pass in interfaces.
Any class that's not a subclass of {@link org.apache.juneau.transform.BeanFilterBuilder} get interpreted
as bean interface classes.
- These cause bean implementations of those interfaces to only expose the properties defined on the interface.
+ These cause bean implementations of those interfaces to only expose the properties defined on the
+ interface.
</p>
<p class='bcode'>
<jc>// An interface with the 3 properties we want serialized.</jc>
@@ -959,7 +1030,8 @@
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/transform/package-summary.html#TOC'>org.apache.juneau.transform</a>
+ <li class='jp'><a class='doclink'
+ href='org/apache/juneau/transform/package-summary.html#TOC'>org.apache.juneau.transform</a>
</ul>
</div>
@@ -970,22 +1042,28 @@
<h3 class='topic' onclick='toggle(this)'>2.7 - Bean Names and Dictionaries</h3>
<div class='topic'>
<p>
- While parsing into beans, Juneau attempts to determine the class types of bean properties through reflection on the bean property getter or setter.
- Often this is insufficient if the property type is an interface or abstract class that cannot be instantiated.
+ While parsing into beans, Juneau attempts to determine the class types of bean properties through
+ reflection on the bean property getter or setter.
+ Often this is insufficient if the property type is an interface or abstract class that cannot be
+ instantiated.
This is where bean names and dictionaries come into play.
</p>
<p>
- Bean names and dictionary are used for identifying class types when they cannot be inferred through reflection.
+ Bean names and dictionary are used for identifying class types when they cannot be inferred through
+ reflection.
</p>
<p>
- Bean classes are given names through the {@link org.apache.juneau.annotation.Bean#typeName() @Bean.typeName()} annotation.
- These names are then added to the serialized output as virtual <js>"_type"</js> properties (or element names in XML).
+ Bean classes are given names through the {@link org.apache.juneau.annotation.Bean#typeName() @Bean.typeName()}
+ annotation.
+ These names are then added to the serialized output as virtual <js>"_type"</js> properties (or element
+ names in XML).
</p>
<p>
On the parsing side, these type names are resolved to classes through the use of bean dictionaries.
</p>
<p>
- For example, if a bean property is of type <code>Object</code>, then the serializer will add <js>"_type"</js> attributes so that the class can be determined during parsing.
+ For example, if a bean property is of type <code>Object</code>, then the serializer will add
+ <js>"_type"</js> attributes so that the class can be determined during parsing.
</p>
<p class='bcode'>
<ja>@Bean</ja>(typeName=<js>"foo"</js>)
@@ -1002,7 +1080,8 @@
<jk>public class</jk> Baz {}
</p>
<p>
- When serialized as JSON, <js>"_type"</js> attributes would be added when needed to infer the type during parsing:
+ When serialized as JSON, <js>"_type"</js> attributes would be added when needed to infer the type during
+ parsing:
</p>
<p class='bcode'>
{
@@ -1015,7 +1094,8 @@
<p>
Type names can be represented slightly differently in different languages.
For example, the dictionary name is used as element names when serialized to XML.
- This allows the <code>typeName</code> annotation to be used as a shortcut for defining element names for beans.
+ This allows the <code>typeName</code> annotation to be used as a shortcut for defining element names for
+ beans.
</p>
<p>
When serialized as XML, the bean is rendered as:
@@ -1032,20 +1112,27 @@
Bean dictionaries are defined at two levels:
</p>
<ul>
- <li>On individual bean properties through the {@link org.apache.juneau.annotation.BeanProperty#beanDictionary() @BeanProperty.beanDictionary()} annotation.
- <li>Globally for a parser using the {@link org.apache.juneau.parser.ParserBuilder#beanDictionary(Class...)} method.
+ <li>On individual bean properties through the
+ {@link org.apache.juneau.annotation.BeanProperty#beanDictionary() @BeanProperty.beanDictionary()}
+ annotation.
+ <li>Globally for a parser using the {@link org.apache.juneau.parser.ParserBuilder#beanDictionary(Class...)}
+ method.
</ul>
<ul class='doctree'>
<li class='info'>
Type names do not need to be universally unique.
However, they must be unique within a dictionary.
<li class='info'>
- The following reserved words cannot be used as type names: <code>object, array, number, boolean, null</code>.
+ The following reserved words cannot be used as type names:
+ <code>object, array, number, boolean, null</code>.
<li class='info'>
Serialized type names are DISABLED by default.
- They must be enabled on the serializer using the {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_addBeanTypeProperties} configuration property.
+ They must be enabled on the serializer using the
+ {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_addBeanTypeProperties}
+ configuration property.
<li class='info'>
- The <js>"_type"</js> property name can be overridden using the {@link org.apache.juneau.BeanContext#BEAN_beanTypePropertyName} configuration property.
+ The <js>"_type"</js> property name can be overridden using the
+ {@link org.apache.juneau.BeanContext#BEAN_beanTypePropertyName} configuration property.
</ul>
<!-- ======================================================================================================== -->
@@ -1236,7 +1323,8 @@
<td style='text-align:center'>3a</td>
<td>
<b>With standard properties</b><br>
- These are beans that have no-arg constructors and one or more properties defined by public getter and setter methods or public fields.<br>
+ These are beans that have no-arg constructors and one or more properties defined by public getter
+ and setter methods or public fields.<br>
Property values are group [1, 2, 3ac, 4a, 5a] objects.
</td>
<td> </td>
@@ -1247,8 +1335,8 @@
<td style='text-align:center'>3b</td>
<td>
<b>With non-standard properties or not true beans</b><br>
- These include true beans that have no-arg constructors and one or more properties defined by getter and setter methods or properties,
- but property types include group [3b, 4b, 5b, 6] objects.<br>
+ These include true beans that have no-arg constructors and one or more properties defined by getter
+ and setter methods or properties, but property types include group [3b, 4b, 5b, 6] objects.<br>
This also includes classes that look like beans but aren't true beans.
For example, classes that have getters but not setters, or classes without no-arg constructors.
</td>
@@ -1271,10 +1359,13 @@
<td style='text-align:center'>4</td>
<td>
<b>Swapped objects</b><br>
- These are objects that are not directly serializable, but have {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated with them.
- The purpose of a POJO swap is to convert an object to another object that is easier to serialize and parse.
- For example, the {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} class can be used to serialize {@link java.util.Date} objects
- to ISO8601 strings, and parse them back into {@link java.util.Date} objects.
+ These are objects that are not directly serializable, but have
+ {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated with them.
+ The purpose of a POJO swap is to convert an object to another object that is easier to serialize
+ and parse.
+ For example, the {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} class can be used to
+ serialize {@link java.util.Date} objects to ISO8601 strings, and parse them back into
+ {@link java.util.Date} objects.
</td>
<td> </td>
<td> </td>
@@ -1324,7 +1415,8 @@
<td>
Classes with a method that converts it to a serializable form:
<ul>
- <li><code><jk>public</jk> X swap(BeanSession);</code> where <code>X</code> is in groups [1, 2a, 3ac].
+ <li><code><jk>public</jk> X swap(BeanSession);</code> where <code>X</code> is in groups
+ [1, 2a, 3ac].
<li><code><jk>public</jk> String toString();</code> where the string is any meaningful data.
</ul>
And a method that converts it back into the original object:
@@ -1336,7 +1428,8 @@
<li><code><jk>public static</jk> T forName(String);</code>
<li><code><jk>public static</jk> T forString(String);</code>
<li><code><jk>public</jk> T(X);</code> where <code>X</code> is in groups [1, 2a, 3ac].
- <li><code><jk>public static</jk> T unswap(BeanSession,X);</code> where <code>X</code> is in groups [1, 2a, 3ac].
+ <li><code><jk>public static</jk> T unswap(BeanSession,X);</code> where <code>X</code> is in
+ groups [1, 2a, 3ac].
</ul>
</td>
<td>
@@ -1360,7 +1453,8 @@
<td>
Classes that only have a method to convert to a serializable form:
<ul>
- <li><code><jk>public</jk> X swap(BeanSession);</code> where <code>X</code> is in groups [1, 2, 3].
+ <li><code><jk>public</jk> X swap(BeanSession);</code> where <code>X</code> is in groups
+ [1, 2, 3].
<li><code><jk>public</jk> String toString();</code> where the string is any meaningful data.
</ul>
</td>
@@ -1371,8 +1465,10 @@
<tr class='dark' style='background-color:lightyellow'>
<td style='text-align:center'>6</td>
<td>
- <b>All other objects</b><br>
- Anything that doesn't fall into one of the groups above are simply converted to {@code Strings} using the {@code toString()} method.
+ <b>All other objects</b>
+ <br>
+ Anything that doesn't fall into one of the groups above are simply converted to {@code Strings}
+ using the {@code toString()} method.
</td>
<td> </td>
<td style='background-color:lightgreen;text-align:center'><b>yes</b></td>
@@ -1382,9 +1478,11 @@
<ul class='doctree'>
<li class='info'>
Serializers are designed to work on tree-shaped POJO models.
- These are models where there are no referential loops (e.g. leaves with references to nodes, or nodes in one branch referencing nodes in another branch).
- There is a serializer setting {@code detectRecursions} to look for and handle these kinds of loops (by setting these references to <jk>null</jk>),
- but it is not enabled by default since it introduces a moderate performance penalty.
+ These are models where there are no referential loops (e.g. leaves with references to nodes, or nodes
+ in one branch referencing nodes in another branch).
+ There is a serializer setting {@code detectRecursions} to look for and handle these kinds of loops
+ (by setting these references to <jk>null</jk>), but it is not enabled by default since it introduces
+ a moderate performance penalty.
</ul>
</div>
@@ -1393,8 +1491,10 @@
<h4 class='topic' onclick='toggle(this)'>2.10 - Simple Variable Language</h4>
<div class='topic'>
<p>
- The <a class='doclink' href='org/apache/juneau/svl/package-summary.html#TOC'>org.apache.juneau.svl</a> package defines an API for a language called "Simple Variable Language".
- In a nutshell, Simple Variable Language (or SVL) is text that contains variables of the form <js>"$varName{varKey}"</js>.
+ The <a class='doclink' href='org/apache/juneau/svl/package-summary.html#TOC'>org.apache.juneau.svl</a>
+ package defines an API for a language called "Simple Variable Language".
+ In a nutshell, Simple Variable Language (or SVL) is text that contains variables of the form
+ <js>"$varName{varKey}"</js>.
</p>
<p>
Variables can be recursively nested within the varKey (e.g. <js>"$FOO{$BAR{xxx},$BAZ{xxx}}"</js>).
@@ -1420,7 +1520,9 @@
</p>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/svl/package-summary.html#TOC'>org.apache.juneau.svl</a> - Simple Variable Language Javadocs.
+ <li class='jp'><a class='doclink'
+ href='org/apache/juneau/svl/package-summary.html#TOC'>org.apache.juneau.svl</a>
+ - Simple Variable Language Javadocs.
</ul>
</div>
@@ -1429,7 +1531,9 @@
<h3 class='topic' onclick='toggle(this)'>2.11 - Configuration Files</h3>
<div class='topic'>
<p>
- The <a class='doclink' href='org/apache/juneau/ini/package-summary.html#TOC'>org.apache.juneau.ini</a> package contains a powerful API for creating and using INI-style config files.
+ The <a class='doclink'
+ href='org/apache/juneau/ini/package-summary.html#TOC'>org.apache.juneau.ini</a> package contains a powerful
+ API for creating and using INI-style config files.
</p>
<p>
An example of an INI file:
@@ -1495,7 +1599,8 @@
.save();
</p>
<p>
- The following is equivalent, except that it uses {@link org.apache.juneau.ini.ConfigFile#put(String, Object)} to set values:
+ The following is equivalent, except that it uses {@link org.apache.juneau.ini.ConfigFile#put(String, Object)}
+ to set values:
</p>
<p class='bcode'>
<jc>// Construct the sample INI file programmatically</jc>
@@ -1515,14 +1620,18 @@
cf.save();
</p>
<p>
- Values are LAX JSON (i.e. unquoted attributes, single quotes) except for top-level strings which are left unquoted.
- Any parsable object types are supported as values (e.g. arrays, collections, beans, swappable objects, enums, etc...).
+ Values are LAX JSON (i.e. unquoted attributes, single quotes) except for top-level strings which are left
+ unquoted.
+ Any parsable object types are supported as values (e.g. arrays, collections, beans, swappable objects,
+ enums, etc...).
</p>
<p>
- The config file looks deceptively simple, the config file API is a very powerful feature with many capabilities, including:
+ The config file looks deceptively simple, the config file API is a very powerful feature with many
+ capabilities, including:
</p>
<ul class='spaced-list'>
- <li>The ability to use variables to reference environment variables, system properties, other config file entries, and a host of other types.
+ <li>The ability to use variables to reference environment variables, system properties, other config file
+ entries, and a host of other types.
<li>APIs for updating, modifying, and saving configuration files without losing comments or formatting.
<li>Extensive listener APIs.
</ul>
@@ -1590,7 +1699,8 @@
String firstArg = cf.getString(<js>"MySection/firstArg"</js>);
</p>
<p>
- Config files can also be used to directly populate beans using the {@link org.apache.juneau.ini.ConfigFile#getSectionAsBean(String,Class,boolean)}:
+ Config files can also be used to directly populate beans using the
+ {@link org.apache.juneau.ini.ConfigFile#getSectionAsBean(String,Class,boolean)}:
</p>
<p class='bcode'>
<jc>// Example config file</jc>
@@ -1613,7 +1723,8 @@
Address myAddress = cf.getSectionAsBean(<js>"MySection"</js>, Address.<jk>class</jk>);
</p>
<p>
- Config file sections can also be accessed via interface proxies using {@link org.apache.juneau.ini.ConfigFile#getSectionAsInterface(String,Class)}:
+ Config file sections can also be accessed via interface proxies using
+ {@link org.apache.juneau.ini.ConfigFile#getSectionAsInterface(String,Class)}:
</p>
<p class='bcode'>
<jc>// Example config file</jc>
@@ -1656,7 +1767,8 @@
</p>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/ini/package-summary.html#TOC'>org.apache.juneau.ini</a> - Config API Javadocs.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/ini/package-summary.html#TOC'>
+ org.apache.juneau.ini</a> - Config API Javadocs.
</ul>
</div>
@@ -1690,7 +1802,7 @@
<div class='topic'>
<p>
Juneau was developed independently from Jackson, but shares many of the same features and capabilities.
- Whereas Jackson was created to work primariliy with JSON, Juneau was created to work for multiple languages.
+ Whereas Jackson was created to work primarily with JSON, Juneau was created to work for multiple languages.
Therefore, the terminology and annotations in Juneau are similar, but language-agnostic.
</p>
<p>
@@ -1726,9 +1838,12 @@
<tr>
<td><code><ja>@JsonAutoDetect</ja>(fieldVisibility=...)</code></td>
<td>
- No equivalent annotation, but can be controlled via: <br>
- {@link org.apache.juneau.BeanContext#BEAN_beanFieldVisibility}<br>
- {@link org.apache.juneau.BeanContext#BEAN_methodVisibility}<br>
+ No equivalent annotation, but can be controlled via:
+ <br>
+ {@link org.apache.juneau.BeanContext#BEAN_beanFieldVisibility}
+ <br>
+ {@link org.apache.juneau.BeanContext#BEAN_methodVisibility}
+ <br>
Future annotation support planned.
</td>
</tr>
@@ -1741,7 +1856,8 @@
<tr>
<td><ja>@JacksonInject</ja></td>
<td>
- No equivalent.<br>
+ No equivalent.
+ <br>
Future support planned.
</td>
@@ -1749,31 +1865,39 @@
<tr>
<td><ja>@JsonSerialize</ja><br><ja>@JsonDeserialize</ja></td>
<td>
- Juneau uses swaps to convert non-serializable object to serializable forms:<br>
- {@link org.apache.juneau.annotation.BeanProperty#swap() @BeanProperty(swap=...)}<br>
+ Juneau uses swaps to convert non-serializable object to serializable forms:
+ <br>
+ {@link org.apache.juneau.annotation.BeanProperty#swap() @BeanProperty(swap=...)}
+ <br>
{@link org.apache.juneau.annotation.Pojo#swap() @Pojo(swap=...)}
</td>
</tr>
<tr>
<td><ja>@JsonInclude</ja></td>
<td>
- No equivalent annotation, but can be controlled via various settings:<br>
- {@link org.apache.juneau.BeanContext}<br>
- {@link org.apache.juneau.serializer.SerializerContext}<br>
+ No equivalent annotation, but can be controlled via various settings:
+ <br>
+ {@link org.apache.juneau.BeanContext}
+ <br>
+ {@link org.apache.juneau.serializer.SerializerContext}
+ <br>
Future annotation support planned.
</td>
</tr>
<tr>
<td><ja>@JsonPropertyOrder</ja></td>
<td>
- {@link org.apache.juneau.annotation.Bean#properties @Bean(properties="...")}<br>
- {@link org.apache.juneau.annotation.Bean#sort @Bean(sort=x)}<br>
+ {@link org.apache.juneau.annotation.Bean#properties @Bean(properties="...")}
+ <br>
+ {@link org.apache.juneau.annotation.Bean#sort @Bean(sort=x)}
+ <br>
</td>
</tr>
<tr>
<td><ja>@JsonValue</ja><br><ja>@JsonRawValue</ja></td>
<td>
- No equivalents.<br>
+ No equivalents.
+ <br>
Future support unlikely since these are JSON-centric.
</td>
</tr>
@@ -1796,8 +1920,8 @@
<div class='topic'>
<p>
The Juneau HTML5 DTOs are simply beans with fluent-style setters that allow you to quickly construct HTML
- fragments as Java objects. These object can then be serialized to HTML using one of the existing HTML serializers,
- or to other languages such as JSON using the JSON serializers.
+ fragments as Java objects. These object can then be serialized to HTML using one of the existing HTML
+ serializers, or to other languages such as JSON using the JSON serializers.
</p>
<p>
The {@link org.apache.juneau.dto.html5.HtmlBuilder} class is a utility class with predefined static methods
@@ -1877,8 +2001,10 @@
</td>
<td class='code'><xt>
<form <xa>action</xa>=<xs>'/submit'</xs> <xa>method</xa>=<xs>'POST'</xs>>
- <xv>Position (1-10000):</xv> <input <xa>name</xa>=<xs>'pos'</xs> <xa>type</xa>=<xs>'number'</xs> <xa>value</xa>=<xs>'1'</xs>/><br/>
- <xv>Limit (1-10000):</xv> <input <xa>name</xa>=<xs>'pos'</xs> <xa>type</xa>=<xs>'number'</xs> <xa>value</xa>=<xs>'100'</xs>/><br/>
+ <xv>Position (1-10000):</xv> <input <xa>name</xa>=<xs>'pos'</xs> <xa>type</xa>=<xs>'number'</xs>
+ <xa>value</xa>=<xs>'1'</xs>/><br/>
+ <xv>Limit (1-10000):</xv> <input <xa>name</xa>=<xs>'pos'</xs> <xa>type</xa>=<xs>'number'</xs>
+ <xa>value</xa>=<xs>'100'</xs>/><br/>
<button <xa>type</xa>=<xs>'submit'</xs>><xv>Submit</xv></button>
<button <xa>type</xa>=<xs>'reset'</xs>><xv>Reset</xv></button>
</form>
@@ -1887,7 +2013,7 @@
</table>
<p>
Using the HTML5 DTOs, you should be able to construct any valid HTML5 from full document bodies
- to any possible fragements.
+ to any possible fragments.
</p>
<p>
The {@link org.apache.juneau.html.HtmlParser} class can be used convert these HTML documents back
@@ -1900,7 +2026,8 @@
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/dto/html5/package-summary.html#TOC'>org.apache.juneau.dto.html5</a> - HTML5 beans.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/dto/html5/package-summary.html#TOC'>
+ org.apache.juneau.dto.html5</a> - HTML5 beans.
</ul>
</div>
@@ -1909,8 +2036,10 @@
<h3 class='topic' onclick='toggle(this)'>3.2 - Atom</h3>
<div class='topic'>
<p>
- The Juneau ATOM feed DTOs are simply beans with fluent-style setters.<br>
- The following code shows a feed being created programmatically using the {@link org.apache.juneau.dto.atom.AtomBuilder} class.
+ The Juneau ATOM feed DTOs are simply beans with fluent-style setters.
+ <br>
+ The following code shows a feed being created programmatically using the
+ {@link org.apache.juneau.dto.atom.AtomBuilder} class.
</p>
<p class='bcode'>
@@ -1967,8 +2096,10 @@
<xt><id></xt>
tag:juneau.apache.org
<xt></id></xt>
- <xt><link</xt> <xa>href</xa>=<xs>'http://juneau.apache.org/'</xs> <xa>rel</xa>=<xs>'alternate'</xs> <xa>type</xa>=<xs>'text/html'</xs> <xa>hreflang</xa>=<xs>'en'</xs>/<xt>></xt>
- <xt><link</xt> <xa>href</xa>=<xs>'http://juneau.apache.org/feed.atom'</xs> <xa>rel</xa>=<xs>'self'</xs> <xa>type</xa>=<xs>'application/atom+xml'</xs>/<xt>></xt>
+ <xt><link</xt> <xa>href</xa>=<xs>'http://juneau.apache.org/'</xs> <xa>rel</xa>=<xs>'alternate'</xs>
+ <xa>type</xa>=<xs>'text/html'</xs> <xa>hreflang</xa>=<xs>'en'</xs>/<xt>></xt>
+ <xt><link</xt> <xa>href</xa>=<xs>'http://juneau.apache.org/feed.atom'</xs> <xa>rel</xa>=<xs>'self'</xs>
+ <xa>type</xa>=<xs>'application/atom+xml'</xs>/<xt>></xt>
<xt><rights></xt>
Copyright (c) 2016, Apache Foundation
<xt></rights></xt>
@@ -1994,22 +2125,25 @@
<xt><id></xt>
tag:juneau.apache.org
<xt></id></xt>
- <xt><link</xt> <xa>href</xa>=<xs>'http://juneau.apache.org/juneau.atom'</xs> <xa>rel</xa>=<xs>'alternate'</xs> <xa>type</xa>=<xs>'text/html'</xs>/<xt>></xt>
- <xt><link</xt> <xa>href</xa>=<xs>'http://juneau.apache.org/audio/juneau_podcast.mp3'</xs> <xa>rel</xa>=<xs>'enclosure'</xs> <xa>type</xa>=<xs>'audio/mpeg'</xs> <xa>length</xa>=<xs>'12345'</xs>/<xt>></xt>
+ <xt><link</xt> <xa>href</xa>=<xs>'http://juneau.apache.org/juneau.atom'</xs>
+ <xa>rel</xa>=<xs>'alternate'</xs> <xa>type</xa>=<xs>'text/html'</xs>/<xt>></xt>
+ <xt><link</xt> <xa>href</xa>=<xs>'http://juneau.apache.org/audio/juneau_podcast.mp3'</xs>
+ <xa>rel</xa>=<xs>'enclosure'</xs> <xa>type</xa>=<xs>'audio/mpeg'</xs> <xa>length</xa>=<xs>'12345'</xs>/<xt>></xt>
<xt><title></xt>
Juneau ATOM specification snapshot
<xt></title></xt>
<xt><updated></xt>2016-01-02T03:04:05Z<xt></updated></xt>
- <xt><content</xt> <xa>base</xa>=<xs>'http://www.apache.org/'</xs> <xa>lang</xa>=<xs>'en'</xs> <xa>type</xa>=<xs>'xhtml'</xs><xt>></xt>
- <xt><div</xt> <xa>xmlns</xa>=<xs>"http://www.w3.org/1999/xhtml"</xs><xt>><p><i></xt>[Update: Juneau supports ATOM.]<xt></i></p></div></xt>
+ <xt><content</xt> <xa>base</xa>=<xs>'http://www.apache.org/'</xs> <xa>lang</xa>=<xs>'en'</xs>
+ <xa>type</xa>=<xs>'xhtml'</xs><xt>></xt>
+ <xt><div</xt> <xa>xmlns</xa>=<xs>"http://www.w3.org/1999/xhtml"</xs>
+ <xt>><p><i></xt>[Update: Juneau supports ATOM.]<xt></i></p></div></xt>
<xt></content></xt>
<xt><published></xt>2016-01-02T03:04:05Z<xt></published></xt>
<xt></entry></xt>
<xt></feed></xt>
</p>
<p>
- The {@link org.apache.juneau.xml.XmlParser} class can be used convert these Atom documents back
- into POJOs.
+ The {@link org.apache.juneau.xml.XmlParser} class can be used convert these Atom documents back into POJOs.
</p>
<p>
Other serializers and parsers (e.g. {@link org.apache.juneau.json.JsonSerializer}) can be used to
@@ -2018,7 +2152,8 @@
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/dto/atom/package-summary.html#TOC'>org.apache.juneau.dto.atom</a> - Atom DTOs.
+ <li class='jp'><a class='doclink'
+ href='org/apache/juneau/dto/atom/package-summary.html#TOC'>org.apache.juneau.dto.atom</a> - Atom DTOs.
</ul>
</div>
@@ -2027,16 +2162,18 @@
<h3 class='topic' onclick='toggle(this)'>3.3 - Swagger</h3>
<div class='topic'>
<p>
- The Juneau Swagger DTOs are simply beans with fluent-style setters that allow you to quickly construct Swagger
- documents as Java objects. These object can then be serialized to JSON using one of the existing JSON serializers,
- or to other languages such as XML or HTML using the other serializers.
+ The Juneau Swagger DTOs are simply beans with fluent-style setters that allow you to quickly construct
+ Swagger documents as Java objects.
+ These object can then be serialized to JSON using one of the existing JSON serializers, or to other
+ languages such as XML or HTML using the other serializers.
</p>
<p>
- The {@link org.apache.juneau.dto.swagger.SwaggerBuilder} class is a utility class with predefined static methods
- that allow you to easily construct DTO instances in a minimal amount of code.
+ The {@link org.apache.juneau.dto.swagger.SwaggerBuilder} class is a utility class with predefined static
+ methods that allow you to easily construct DTO instances in a minimal amount of code.
</p>
<p>
- The following is an example Swagger document from the <a href="http://petstore.swagger.io/">Swagger website</a>.
+ The following is an example Swagger document from the
+ <a href="http://petstore.swagger.io/">Swagger website</a>.
</p>
<p class='bcode'>
{
@@ -2175,11 +2312,12 @@
The Juneau REST Server API provides servlet-based REST resources on top of existing POJOs.
</p>
<p>
- The API automatically detects <l>Accept</l> header of requests and converts POJOs to any of the supported languages.
+ The API automatically detects <l>Accept</l> header of requests and converts POJOs to any of the supported
+ languages.
The toolkit is extensible and also allows for support of user-defined content types.
</p>
<p>
- Automatic built-in support is provided for negotiation of response charsets and gzip encoding.
+ Automatic built-in support is provided for negotiation of response character sets and gzip encoding.
</p>
<p>
The following is an example of a REST API used to view and set JVM system properties.
@@ -2218,7 +2356,8 @@
license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>,
version=<js>"2.0"</js>,
termsOfService=<js>"You're on your own."</js>,
- tags=<js>"[{name:'Java',description:'Java utility',externalDocs:{description:'Home page',url:'http://juneau.apache.org'}}]"</js>,
+ tags=<js>"[{name:'Java',description:'Java utility',
+ externalDocs:{description:'Home page',url:'http://juneau.apache.org'}}]"</js>,
externalDocs=<js>"{description:'Home page',url:'http://juneau.apache.org'}"</js>
)
)
@@ -2229,13 +2368,15 @@
summary=<js>"Show all system properties"</js>,
description=<js>"Returns all system properties defined in the JVM."</js>,
parameters={
- <ja>@Parameter</ja>(in=<js>"query"</js>, name=<js>"sort"</js>, description=<js>"Sort results alphabetically."</js>, _default=<js>"false"</js>)
+ <ja>@Parameter</ja>(in=<js>"query"</js>, name=<js>"sort"</js>,
+ description=<js>"Sort results alphabetically."</js>, _default=<js>"false"</js>)
},
responses={
<ja>@Response</ja>(value=200, description=<js>"Returns a map of key/value pairs."</js>)
}
)
- <jk>public</jk> Map getSystemProperties(<ja>@Query</ja>(<js>"sort"</js>) <jk>boolean</jk> sort) <jk>throws</jk> Throwable {
+ <jk>public</jk> Map getSystemProperties(<ja>@Query</ja>(<js>"sort"</js>) <jk>boolean</jk> sort)
+ <jk>throws</jk> Throwable {
<jk>if</jk> (sort)
<jk>return new</jk> TreeMap(System.<jsm>getProperties</jsm>());
<jk>return</jk> System.<jsm>getProperties</jsm>();
@@ -2246,7 +2387,8 @@
summary=<js>"Get system property"</js>,
description=<js>"Returns the value of the specified system property."</js>,
parameters={
- <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"propertyName"</js>, description=<js>"The system property name."</js>)
+ <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"propertyName"</js>,
+ description=<js>"The system property name."</js>)
},
responses={
<ja>@Response</ja>(value=200, description=<js>"The system property value, or null if not found."</js>)
@@ -2262,13 +2404,15 @@
description=<js>"Sets a new value for the specified system property."</js>,
guards=AdminGuard.<jk>class</jk>,
parameters={
- <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"propertyName"</js>, description=<js>"The system property name."</js>),
+ <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"propertyName"</js>,
+ description=<js>"The system property name."</js>),
<ja>@Parameter</ja>(in=<js>"body"</js>, description=<js>"The new system property value."</js>),
},
responses={
<ja>@Response</ja>(value=302,
headers={
- <ja>@Parameter</ja>(name=<js>"Location"</js>, description=<js>"The root URL of this resource."</js>)
+ <ja>@Parameter</ja>(name=<js>"Location"</js>,
+ description=<js>"The root URL of this resource."</js>)
}
),
<ja>@Response</ja>(value=403, description=<js>"User is not an admin."</js>)
@@ -2285,13 +2429,16 @@
description=<js>"Takes in a map of key/value pairs and creates a set of new system properties."</js>,
guards=AdminGuard.<jk>class</jk>,
parameters={
- <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"propertyName"</js>, description=<js>"The system property key."</js>),
- <ja>@Parameter</ja>(in=<js>"body"</js>, description=<js>"The new system property values.", schema="{example:{key1:'val1',key2:123}}"</js>),
+ <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"propertyName"</js>,
+ description=<js>"The system property key."</js>),
+ <ja>@Parameter</ja>(in=<js>"body"</js>, description=<js>"The new system property values.",
+ schema="{example:{key1:'val1',key2:123}}"</js>),
},
responses={
<ja>@Response</ja>(value=302,
headers={
- <ja>@Parameter</ja>(name=<js>"Location"</js>, description=<js>"The root URL of this resource."</js>)
+ <ja>@Parameter</ja>(name=<js>"Location"</js>,
+ description=<js>"The root URL of this resource."</js>)
}
),
<ja>@Response</ja>(value=403, description=<js>"Unauthorized: User is not an admin."</js>)
@@ -2308,12 +2455,14 @@
description=<js>"Deletes the specified system property."</js>,
guards=AdminGuard.<jk>class</jk>,
parameters={
- <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"propertyName"</js>, description=<js>"The system property name."</js>),
+ <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"propertyName"</js>,
+ description=<js>"The system property name."</js>),
},
responses={
<ja>@Response</ja>(value=302,
headers={
- <ja>@Parameter</ja>(name=<js>"Location"</js>, description=<js>"The root URL of this resource."</js>)
+ <ja>@Parameter</ja>(name=<js>"Location"</js>,
+ description=<js>"The root URL of this resource."</js>)
}
),
<ja>@Response</ja>(value=403, description=<js>"Unauthorized: User is not an admin"</js>)
@@ -2351,21 +2500,26 @@
<xt></web-app></xt>
</p>
<p>
- Pointing your browser to the resource renders the POJOs as HTML (since that's what the browser specifies in the <code>Accept</code> header).
+ Pointing your browser to the resource renders the POJOs as HTML (since that's what the browser specifies in the
+ <code>Accept</code> header).
</p>
<img class='bordered' src="doc-files/Server.SystemPropertiesResource.png">
<p>
One of the most useful aspects of using this API is the self-discovering, self-documenting OPTIONS pages.
- These are constructed automatically using reflection, augmented with information pulled from annotations (as shown above), resource bundles, or Swagger JSON files:
+ These are constructed automatically using reflection, augmented with information pulled from annotations
+ (as shown above), resource bundles, or Swagger JSON files:
</p>
<img class='bordered' src="doc-files/Server.Options.png">
<p>
- Arbitrarily complex POJO models can be serialized using any of the supported serializers, and content can be parsed using any of the supported parsers.
+ Arbitrarily complex POJO models can be serialized using any of the supported serializers, and content can be
+ parsed using any of the supported parsers.
</p>
<p>
- The <l>juneau-examples-rest</l> project contains various REST resource examples in an easy-to-use REST microservice.
- One of these is <l>AddressBookResource</l> which serializes <l>AddressBook</l> objects defined below (some code omitted):
+ The <l>juneau-examples-rest</l> project contains various REST resource examples in an easy-to-use REST
+ microservice.
+ One of these is <l>AddressBookResource</l> which serializes <l>AddressBook</l> objects defined below
+ (some code omitted):
</p>
<p class='bcode'>
<jd>/** package-info.java */</jd>
@@ -2412,13 +2566,14 @@
}
</p>
<p>
- The framework allows you to override header values through GET parameters, so that you can specify the <l>ACCEPT</l> header to see each type.
+ The framework allows you to override header values through GET parameters, so that you can specify the
+ <l>ACCEPT</l> header to see each type.
Adding <l>&plainText=true</l> forces the response <l>Content-Type</l> to be <l>text/plain.</l>
<h6 class='figure'>HTML</h6>
<img class='bordered' src="doc-files/Server.Html.png">
<p>
Also, localization can be tested by passing in an <l>Accept-Language</l> header.
- <h6 class='figure'>HTML/french</h6>
+ <h6 class='figure'>HTML/French</h6>
<img class='bordered' src="doc-files/Server.Html.french.png">
<h6 class='figure'>JSON</h6>
<img class='bordered' src="doc-files/Server.Json.png">
@@ -2445,7 +2600,9 @@
</p>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/server/package-summary.html#TOC'>org.apache.juneau.rest</a> - Juneau Server API Javadocs.
+ <li class='jp'><a class='doclink'
+ href='org/apache/juneau/server/package-summary.html#TOC'>org.apache.juneau.rest</a>
+ - Juneau Server API Javadocs.
</ul>
</div>
@@ -2454,12 +2611,12 @@
<h2 class='topic' onclick='toggle(this)'>5 - Juneau Client (org.apache.juneau.rest.client)</h2>
<div class='topic'>
<p>
- The REST client API provides the ability to access remote REST interfaces and transparently convert the input and output to and from POJOs using any
- of the provided serializers and parsers.
+ The REST client API provides the ability to access remote REST interfaces and transparently convert the input
+ and output to and from POJOs using any of the provided serializers and parsers.
</p>
<p>
- Built upon the Apache HttpClient libraries, it extends that API and provides specialized APIs for working with REST interfaces while
- maintaining all the functionality available in the HttpClient API.
+ Built upon the Apache HttpClient libraries, it extends that API and provides specialized APIs for working with
+ REST interfaces while maintaining all the functionality available in the HttpClient API.
</p>
<p class='bcode'>
<jc>// Create a reusable JSON client.</jc>
@@ -2488,7 +2645,9 @@
</p>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/client/package-summary.html#TOC'>org.apache.juneau.rest.client</a> - Juneau Client API Javadocs.
+ <li class='jp'><a class='doclink'
+ href='org/apache/juneau/client/package-summary.html#TOC'>org.apache.juneau.rest.client</a>
+ - Juneau Client API Javadocs.
</ul>
</div>
@@ -2502,7 +2661,8 @@
define and use, and allowing much more flexibility in the types of objects serialized.
</p>
<p>
- The remote proxy interface API allows you to invoke server-side POJO methods on the client side using REST as the communications protocol:
+ The remote proxy interface API allows you to invoke server-side POJO methods on the client side using REST as
+ the communications protocol:
</p>
<p class='bcode'>
@@ -2550,8 +2710,8 @@
The object returned by the method is then serialized as the body of the response.
</p>
<p>
- To define a remoteable interface, simply add the {@link org.apache.juneau.remoteable.Remoteable @Remoteable} annotation
- to your interface class.
+ To define a remoteable interface, simply add the {@link org.apache.juneau.remoteable.Remoteable @Remoteable}
+ annotation to your interface class.
</p>
<p class='bcode'>
<ja>@Remoteable</ja>
@@ -2559,11 +2719,12 @@
</p>
<p>
This annotation tells the framework that all methods defined on this interface can be executed remotely.
- It can be applied to super-interfaces, super-classes, etc..., and exposes the methods at whatever level it is defined.
+ It can be applied to super-interfaces, super-classes, etc..., and exposes the methods at whatever level it is
+ defined.
</p>
<p>
- The {@link org.apache.juneau.remoteable.RemoteMethod @RemoteMethod} annotation can also be used on individual methods
- to tailor which methods are exposed or their paths.
+ The {@link org.apache.juneau.remoteable.RemoteMethod @RemoteMethod} annotation can also be used on individual
+ methods to tailor which methods are exposed or their paths.
</p>
<p>
There are two ways to expose remoteable proxies on the server side:
@@ -2573,8 +2734,8 @@
<li>Using a <code><ja>@RestMethod</ja>(name=<js>"PROXY"</js>)</code> annotation on a Java method.
</ol>
<p>
- The <code>RemoteableServlet</code> class is a simple specialized servlet with an abstract <code>getServiceMap()</code>
- method to define the server-side POJOs:
+ The <code>RemoteableServlet</code> class is a simple specialized servlet with an abstract
+ <code>getServiceMap()</code> method to define the server-side POJOs:
</p>
<p class='bcode'>
<ja>@RestResource</ja>(
@@ -2599,8 +2760,10 @@
}
</p>
<p>
- The <code><ja>@RestMethod</ja>(name=<js>"PROXY"</js>)</code> approach is easier if you only have a single interface you want to expose.
- You simply define a Java method whose return type is an interface, and return the implementation of that interface:
+ The <code><ja>@RestMethod</ja>(name=<js>"PROXY"</js>)</code> approach is easier if you only have a single
+ interface you want to expose.
+ You simply define a Java method whose return type is an interface, and return the implementation of that
+ interface:
</p>
<p class='bcode'>
<jc>// Our exposed proxy object.</jc>
@@ -2611,20 +2774,30 @@
</p>
<p>
In either case, the proxy communications layer is pure REST.
- <br>Therefore, in cases where the interface classes are not available on the client side,
- the same method calls can be made through pure REST calls.
- <br>This can also aid significantly in debugging, since calls to the remoteable service
- can be made directly from a browser with no coding involved.
+ <br>
+ Therefore, in cases where the interface classes are not available on the client side, the same method calls can
+ be made through pure REST calls.
+ <br>
+ This can also aid significantly in debugging, since calls to the remoteable service can be made directly from
+ a browser with no coding involved.
</p>
<p>
- The parameters and return types of the Java methods can be any of the supported serializable and parsable types in <a class='doclink' href='#Core.PojoCategories'>POJO Categories</a>.
- <br>This ends up being WAY more flexible than other proxy interfaces since Juneau can handle so may POJO types out-of-the-box.
- <br>Most of the time you don't even need to modify your existing Java implementation code.
+ The parameters and return types of the Java methods can be any of the supported serializable and parsable types
+ in <a class='doclink' href='#Core.PojoCategories'>POJO Categories</a>.
+ <br>
+ This ends up being WAY more flexible than other proxy interfaces since Juneau can handle so may POJO types
+ out-of-the-box.
+ <br>
+ Most of the time you don't even need to modify your existing Java implementation code.
</p>
<p>
- The RemoteableServlet class itself shows how sophisticated REST interfaces can be built on the Juneau RestServlet API using very little code.
- <br>The RemoteableServlet class itself consists of only 53 lines of code, yet is a sophisticated discoverable and self-documenting REST interface.
- <br>And since the remote proxy API is built on top of REST, it can be debugged using just a browser.
+ The RemoteableServlet class itself shows how sophisticated REST interfaces can be built on the Juneau
+ RestServlet API using very little code.
+ <br>
+ The RemoteableServlet class itself consists of only 53 lines of code, yet is a sophisticated discoverable and
+ self-documenting REST interface.
+ <br>
+ And since the remote proxy API is built on top of REST, it can be debugged using just a browser.
</p>
<p>
The requirements for a method to be callable through a remoteable service are:
@@ -2633,12 +2806,14 @@
<li>The method must be public.
<li>The parameter and return types must be <a href='#Core.PojoCategories'>serializable and parsable</a>.
Parameterized types are supported.
- <li>Methods can throw <code>Throwables</code> with public no-arg or single-arg-string constructors which will be automatically
- recreated on the client side.
+ <li>Methods can throw <code>Throwables</code> with public no-arg or single-arg-string constructors which will
+ be automatically recreated on the client side.
</ul>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/server/remoteable/package-summary.html#TOC'>org.apache.juneau.rest.remoteable</a> - Juneau Remoteable API Javadocs.
+ <li class='jp'><a class='doclink'
+ href='org/apache/juneau/server/remoteable/package-summary.html#TOC'>org.apache.juneau.rest.remoteable</a>
+ - Juneau Remoteable API Javadocs.
</ul>
<!-- ======================================================================================================== -->
@@ -2647,11 +2822,13 @@
<div class='topic'>
<p>
Remoteable proxies can also be used to define interface proxies against 3rd-party REST interfaces.
- This is an extremely powerful feature that allows you to quickly define easy-to-use interfaces against virtually any REST interface.
+ This is an extremely powerful feature that allows you to quickly define easy-to-use interfaces against
+ virtually any REST interface.
</p>
<p>
Similar in concept to remoteable services defined above, but in this case we simply define our interface with
- special annotations that tell us how to convert input and output to HTTP headers, query paramters, form post parameters, or request/response bodies.
+ special annotations that tell us how to convert input and output to HTTP headers, query parameters, form
+ post parameters, or request/response bodies.
</p>
<p class='bcode'>
<ja>@Remoteable</ja>
@@ -2666,62 +2843,99 @@
String response = p.doMethod(UUID.<jsm>generate</jsm>(), <jk>true</jk>, <jk>new</jk> MyPojo());
</p>
<p>
- The Java method arguements can be annotated with any of the following:
+ The Java method arguments can be annotated with any of the following:
</p>
<ul class='spaced-list'>
<li>{@link org.apache.juneau.remoteable.Query @Query} - A URL query parameter.
<br>The argument can be any of the following types:
<ul>
- <li>Any serializable POJO - Converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
- <li><code>Map<String,Object></code> - Individual name-value pairs.
- <br>Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
- <li><code>String</code> - Treated as a query string.
- </ul>
- <li>{@link org.apache.juneau.remoteable.QueryIfNE @QueryIfNE} - Same as <ja>@Query</ja> except skips the value if it's null/empty.
- <li>{@link org.apache.juneau.remoteable.FormData @FormData} - A form-data parameter.
- <br>Note that this is only available if the HTTP method is <code>POST</code>.
- <br>The argument can be any of the following types:
- <ul>
- <li>Any serializable POJO - Converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
- <li>{@link org.apache.juneau.rest.client.NameValuePairs} - Individual name-value pairs.
- <li><code>Map<String,Object></code> - Individual name-value pairs.
- <br>Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
+ <li>Any serializable POJO
+ - Converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
+ <li><code>Map<String,Object></code>
+ - Individual name-value pairs.
+ <br>
+ Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
+ <li><code>String</code>
+ - Treated as a query string.
+ </ul>
+ <li>{@link org.apache.juneau.remoteable.QueryIfNE @QueryIfNE}
+ - Same as <ja>@Query</ja> except skips the value if it's null/empty.
+ <li>{@link org.apache.juneau.remoteable.FormData @FormData}
+ - A form-data parameter.
+ <br>
+ Note that this is only available if the HTTP method is <code>POST</code>.
+ <br>
+ The argument can be any of the following types:
+ <ul>
+ <li>Any serializable POJO
+ - Converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
+ <li>{@link org.apache.juneau.rest.client.NameValuePairs}
+ - Individual name-value pairs.
+ <li><code>Map<String,Object></code>
+ - Individual name-value pairs.
+ <br>
+ Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
</ul>
- <li>{@link org.apache.juneau.remoteable.FormDataIfNE @FormDataIfNE} - Same as <ja>@FormData</ja> except skips the value if it's null/empty.
- <li>{@link org.apache.juneau.remoteable.Header @Header} - A request header.
- <br>The argument can be any of the following types:
+ <li>{@link org.apache.juneau.remoteable.FormDataIfNE @FormDataIfNE}
+ - Same as <ja>@FormData</ja> except skips the value if it's null/empty.
+ <li>{@link org.apache.juneau.remoteable.Header @Header}
+ - A request header.
+ <br>
+ The argument can be any of the following types:
<ul>
- <li>Any serializable POJO - Converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
- <li><code>Map<String,Object></code> - Individual name-value pairs.
- <br>Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
+ <li>Any serializable POJO
+ - Converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
+ <li><code>Map<String,Object></code>
+ - Individual name-value pairs.
+ <br>
+ Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
</ul>
- <li>{@link org.apache.juneau.remoteable.HeaderIfNE @HeaderIfNE} - Same as <ja>@Header</ja> except skips the value if it's null/empty.
- <li>{@link org.apache.juneau.remoteable.Body @Body} - The HTTP request body.
+ <li>{@link org.apache.juneau.remoteable.HeaderIfNE @HeaderIfNE}
+ - Same as <ja>@Header</ja> except skips the value if it's null/empty.
+ <li>{@link org.apache.juneau.remoteable.Body @Body}
+ - The HTTP request body.
<br>The argument can be any of the following types:
<ul>
- <li>Any serializable POJO - Converted to text/bytes using the {@link org.apache.juneau.serializer.Serializer} registered with the <code>RestClient</code>.
- <li>{@link java.io.Reader} - Raw contents of reader will be serialized to remote resource.
- <li>{@link java.io.InputStream} - Raw contents of input stream will be serialized to remote resource.
- <li>{@link org.apache.http.HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
- <li>{@link org.apache.juneau.rest.client.NameValuePairs} - Converted to a URL-encoded FORM post.
+ <li>Any serializable POJO
+ - Converted to text/bytes using the {@link org.apache.juneau.serializer.Serializer} registered
+ with the <code>RestClient</code>.
+ <li>{@link java.io.Reader}
+ - Raw contents of reader will be serialized to remote resource.
+ <li>{@link java.io.InputStream}
+ - Raw contents of input stream will be serialized to remote resource.
+ <li>{@link org.apache.http.HttpEntity}
+ - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
+ <li>{@link org.apache.juneau.rest.client.NameValuePairs}
+ - Converted to a URL-encoded FORM post.
</ul>
</ul>
<p>
The return type of the Java method can be any of the following:
</p>
<ul class='spaced-list'>
- <li><jk>void</jk> - Don't parse any response.
- <br>Note that the method will still throw a runtime exception if an error HTTP status is returned.
- <li>Any parsable POJO - The body of the response will be converted to the POJO using the parser defined on the <code>RestClient</code>.
- <li><code>HttpResponse</code> - Returns the raw <code>HttpResponse</code> returned by the inner <code>HttpClient</code>.
- <li>{@link java.io.Reader} - Returns access to the raw reader of the response.
- <br>Note that if you don't want your response parsed as a POJO, you'll want to get the response reader directly.
- <li>{@link java.io.InputStream} - Returns access to the raw input stream of the response.
+ <li><jk>void</jk>
+ - Don't parse any response.
+ <br>
+ Note that the method will still throw a runtime exception if an error HTTP status is returned.
+ <li>Any parsable POJO
+ - The body of the response will be converted to the POJO using the parser defined on the
+ <code>RestClient</code>.
+ <li><code>HttpResponse</code>
+ - Returns the raw <code>HttpResponse</code> returned by the inner <code>HttpClient</code>.
+ <li>{@link java.io.Reader}
+ - Returns access to the raw reader of the response.
+ <br>
+ Note that if you don't want your response parsed as a POJO, you'll want to get the response reader
+ directly.
+ <li>{@link java.io.InputStream}
+ - Returns access to the raw input stream of the response.
</ul>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/remoteable/package-summary.html#TOC'>org.apache.juneau.remoteable</a> - Juneau Remoteable API Javadocs.
+ <li class='jp'><a class='doclink'
+ href='org/apache/juneau/remoteable/package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ - Juneau Remoteable API Javadocs.
</ul>
</div>
</div>
@@ -2734,15 +2948,16 @@
<b>WARNING - The microservice API is still in beta. It may be replaced with an OSGi-based architecture.</b>
</p>
<p>
- The <l>microservice-project.zip</l> file contains a standalone Eclipse project that can be used
- to quickly create REST microservices as standalone executable jars without the need of an application server.
+ The <l>microservice-project.zip</l> file contains a stand-alone Eclipse project that can be used
+ to quickly create REST microservices as stand-alone executable jars without the need of an application server.
They start almost instantly and are started through a simple java command:
</p>
<p>
<code class='snippet'>java -jar microservice.jar</code>
</p>
<p>
- When you execute this command, you can point your browser to <l>http://localhost:10000</l> to bring up the REST interface:
+ When you execute this command, you can point your browser to <l>http://localhost:10000</l> to bring up the
+ REST interface:
</p>
<img class='bordered' src="doc-files/Microservices.1.png">
<p>
@@ -2751,7 +2966,9 @@
</p>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink' href='org/apache/juneau/microservice/package-summary.html#TOC'>org.apache.juneau.microservice</a> - Juneau Microservice API Javadocs.
+ <li class='jp'><a class='doclink'
+ href='org/apache/juneau/microservice/package-summary.html#TOC'>org.apache.juneau.microservice</a>
+ - Juneau Microservice API Javadocs.
</ul>
</div>
@@ -2761,11 +2978,11 @@
<div class='topic'>
<p>
The <l>microservice-samples-project.zip</l> file is a zipped eclipse project that includes everything you
- need to start the Samples REST microservice in an Eclipse workspace.
+ need to start the Samples REST microservice in an Eclipse workspace.
</p>
<p>
This project is packaged as a Juneau Microservice project that allows REST resources to be started
- using embedded Jetty.
+ using embedded Jetty.
</p>
<!-- ======================================================================================================== -->
@@ -2776,12 +2993,17 @@
Follow these instructions to create the Samples project in Eclipse:
</p>
<ol class='spaced-list'>
- <li>Download the latest microservice-samples-project .zip file (e.g. <l>microservice-samples-project-5.2.zip</l>).
- <li>In your Eclipse workspace, go to <b>File->Import->General->Existing Projects into Workspace</b> and click <b>Next</b>.<br><br>
+ <li>Download the latest microservice-samples-project .zip file (e.g.
+ <l>microservice-samples-project-5.2.zip</l>).
+ <li>In your Eclipse workspace, go to <b>File->Import->General->Existing Projects into Workspace</b>
+ and click <b>Next</b>.
+ <br><br>
<img class='bordered' src="doc-files/Samples.Installing.1.png">
- <li>Select the .zip file and click <b>Finish</b>.<br><br>
+ <li>Select the .zip file and click <b>Finish</b>.
+ <br><br>
<img class='bordered' src="doc-files/Samples.Installing.2.png">
- <li>In your workspace, you can now see the following project:<br><br>
+ <li>In your workspace, you can now see the following project:
+ <br><br>
<img class='bordered' src="doc-files/Samples.Installing.3.png">
</ol>
<p>
@@ -2789,7 +3011,9 @@
</p>
<ul class='spaced-list'>
<li><l>META-INF/MANIFEST.MF</l> - The manifest file. <br>
- This defines the entry point, classpath, top-level REST resources, and location of external configuration file. <br><br>
+ This defines the entry point, classpath, top-level REST resources, and location of external
+ configuration file.
+ <br><br>
<p class='bcode'>
<mk>Manifest-Version</mk>: <mv>1.0</mv>
<mk>Main-Class</mk>: <mv>org.apache.juneau.microservice.RestMicroservice</mv>
@@ -2813,14 +3037,21 @@
lib/slf4j-api-1.6.4.jar
lib/slf4j-log4j12-1.6.4.jar</mv>
</p>
- <li><l>RestMicroservice.java</l> - The application class.
- <br>This is a specialized microservice in Juneau for exposing REST servlets.
- <br>Allows REST servlets to be registered in the manifest or configuration file.
- <li><l>RootResources.java</l> - The top-level REST resource.
- <br>This class serves as a "router" page to child resources:<br>
- <li><l>examples.cfg</l> - The external configuration file.
- <br>A deceptively simple yet powerful INI-style configuration file:
- <br><br>
+ <li><l>RestMicroservice.java</l>
+ - The application class.
+ <br>
+ This is a specialized microservice in Juneau for exposing REST servlets.
+ <br>
+ Allows REST servlets to be registered in the manifest or configuration file.
+ <li><l>RootResources.java</l>
+ - The top-level REST resource.
+ <br>
+ This class serves as a "router" page to child resources:
+ <li><l>examples.cfg</l>
+ - The external configuration file.
+ <br>
+ A deceptively simple yet powerful IN
<TRUNCATED>
[18/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
index 37f4dbf..b555049 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
@@ -17,12 +17,14 @@ import java.net.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-input-element"><input></a> element.
+ * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-input-element"><input></a>
+ * element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -34,6 +36,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-accept">accept</a> attribute.
* Hint for expected file type in file upload controls.
+ *
* @param accept The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -45,6 +48,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-alt">alt</a> attribute.
* Replacement text for use when images are not available.
+ *
* @param alt The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -55,7 +59,8 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autocomplete">autocomplete</a> attribute.
- * Hint for form autofill feature.
+ * Hint for form auto-fill feature.
+ *
* @param autocomplete The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -67,6 +72,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus">autofocus</a> attribute.
* Automatically focus the form control when the page is loaded.
+ *
* @param autofocus The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -78,6 +84,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-checked">checked</a> attribute.
* Whether the command or control is checked.
+ *
* @param checked The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -90,6 +97,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-dirname">dirname</a> attribute.
* Name of form field to use for sending the element's directionality in form submission.
+ *
* @param dirname The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -101,6 +109,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled">disabled</a> attribute.
* Whether the form control is disabled.
+ *
* @param disabled The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -113,6 +122,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
* Associates the control with a form element.
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -124,6 +134,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formaction">formaction</a> attribute.
* URL to use for form submission.
+ *
* @param formaction The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -135,6 +146,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formenctype">formenctype</a> attribute.
* Form data set encoding type to use for form submission.
+ *
* @param formenctype The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -146,6 +158,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formmethod">formmethod</a> attribute.
* HTTP method to use for form submission.
+ *
* @param formmethod The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -155,8 +168,10 @@ public class Input extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formnovalidate">formnovalidate</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formnovalidate">formnovalidate</a>
+ * attribute.
* Bypass form control validation for form submission.
+ *
* @param formnovalidate The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -168,6 +183,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formtarget">formtarget</a> attribute.
* Browsing context for form submission.
+ *
* @param formtarget The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -177,8 +193,10 @@ public class Input extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
+ * attribute.
* Vertical dimension.
+ *
* @param height The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -189,8 +207,10 @@ public class Input extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-input-inputmode">inputmode</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-input-inputmode">inputmode</a>
+ * attribute.
* Hint for selecting an input modality.
+ *
* @param inputmode The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -201,7 +221,8 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-list">list</a> attribute.
- * List of autocomplete options.
+ * List of auto-complete options.
+ *
* @param list The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -213,6 +234,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-max">max</a> attribute.
* Maximum value.
+ *
* @param max The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -225,6 +247,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-maxlength">maxlength</a> attribute.
* Maximum length of value.
+ *
* @param maxlength The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -237,6 +260,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-min">min</a> attribute.
* Minimum value.
+ *
* @param min The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -249,6 +273,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-minlength">minlength</a> attribute.
* Minimum length of value.
+ *
* @param minlength The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -261,6 +286,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-multiple">multiple</a> attribute.
* Whether to allow multiple values.
+ *
* @param multiple The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -273,6 +299,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
* Name of form control to use for form submission and in the form.elements API.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -284,6 +311,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-pattern">pattern</a> attribute.
* Pattern to be matched by the form control's value.
+ *
* @param pattern The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -295,6 +323,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-placeholder">placeholder</a> attribute.
* User-visible label to be placed within the form control.
+ *
* @param placeholder The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -306,6 +335,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-readonly">readonly</a> attribute.
* Whether to allow the value to be edited by the user.
+ *
* @param readonly The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -319,6 +349,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-readonly">readonly</a> attribute.
* Whether to allow the value to be edited by the user.
+ *
* @param readonly If <jk>true</jk>, adds <code>readonly="readonly"</code>.
* @return This object (for method chaining).
*/
@@ -331,6 +362,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-readonly">required</a> attribute.
* Whether the control is required for form submission.
+ *
* @param required The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -343,6 +375,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-size">size</a> attribute.
* Size of the control.
+ *
* @param size The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -355,6 +388,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-src">src</a> attribute.
* Address of the resource.
+ *
* @param src The new value for this attribute.
* Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
@@ -367,6 +401,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-step">step</a> attribute.
* Granularity to be matched by the form control's value.
+ *
* @param step The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -378,6 +413,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-type">type</a> attribute.
* Type of form control.
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -389,6 +425,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-value">value</a> attribute.
* Value of the form control.
+ *
* @param value The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -401,6 +438,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
* Horizontal dimension.
+ *
* @param width The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
index 1f177c2..d891ac4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#the-ins-element"><ins></a> element.
+ * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#the-ins-element"><ins></a>
+ * element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Ins extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#attr-mod-cite">cite</a> attribute.
* Link to the source of the quotation or more information about the edit.
+ *
* @param cite The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -43,6 +46,7 @@ public class Ins extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#attr-mod-datetime">datetime</a> attribute.
* Date and (optionally) time of the change.
+ *
* @param datetime The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
index 17f3625..51b13ea 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-kbd-element"><kbd></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-kbd-element"><kbd></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
index dc1a23f..416d332 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-keygen-element"><keygen></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-keygen-element"><keygen></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus">autofocus</a> attribute.
* Automatically focus the form control when the page is loaded.
+ *
* @param autofocus The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -44,6 +47,7 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-keygen-challenge">challenge</a> attribute.
* String to package with the generated and signed public key.
+ *
* @param challenge The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -55,6 +59,7 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled">disabled</a> attribute.
* Whether the form control is disabled.
+ *
* @param disabled The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -67,6 +72,7 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
* Associates the control with a form element.
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -78,6 +84,7 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-keygen-keytype">keytype</a> attribute.
* The type of cryptographic key to generate.
+ *
* @param keytype The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -89,6 +96,7 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
* Name of form control to use for form submission and in the form.elements API.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
index 97da792..1fa3d8b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-label-element"><label></a> element.
+ * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-label-element"><label></a>
+ * element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Label extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-label-for">for</a> attribute.
* Associate the label with form control.
+ *
* @param _for The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -43,6 +46,7 @@ public class Label extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
* Associates the control with a form element.
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
index 920b8a4..a641249 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-legend-element"><legend></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-legend-element"><legend></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
index 56c481e..88a417e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-li-element"><li></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-li-element"><li></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
index c06c501..df31c52 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#the-link-element"><link></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/document-metadata.html#the-link-element"><link></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -34,8 +36,10 @@ import org.apache.juneau.annotation.*;
public class Link extends HtmlElementVoid {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-crossorigin">crossorigin</a> attribute.
- * How the element handles crossorigin requests.
+ * <a class="doclink"
+ * href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-crossorigin">crossorigin</a> attribute.
+ * How the element handles cross-origin requests.
+ *
* @param crossorigin The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -63,8 +67,10 @@ public class Link extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-hreflang">hreflang</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-hreflang">hreflang</a>
+ * attribute.
* Language of the linked resource.
+ *
* @param hreflang The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -76,6 +82,7 @@ public class Link extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-media">media</a> attribute.
* Applicable media.
+ *
* @param media The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -87,6 +94,7 @@ public class Link extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-rel">rel</a> attribute.
* Relationship between the document containing the hyperlink and the destination resource.
+ *
* @param rel The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -98,6 +106,7 @@ public class Link extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-link-sizes">sizes</a> attribute.
* Sizes of the icons (for rel="icon").
+ *
* @param sizes The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -109,6 +118,7 @@ public class Link extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-type">type</a> attribute.
* Hint for the type of the referenced resource.
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
index dc2bfd7..3002466 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-main-element"><main></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-main-element"><main></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
index 4d80143..1f81c9a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-map-element"><map></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-map-element"><map></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Map extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-map-name">name</a> attribute.
* Name of image map to reference from the usemap attribute.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
index 9b7f786..26fb6a6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-mark-element"><mark></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-mark-element"><mark></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
index 73d915b..92bc56c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#the-meta-element"><meta></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/document-metadata.html#the-meta-element"><meta></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -30,8 +32,10 @@ import org.apache.juneau.annotation.*;
public class Meta extends HtmlElementVoid {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-meta-charset">charset</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-meta-charset">charset</a>
+ * attribute.
* Character encoding declaration.
+ *
* @param charset The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -41,8 +45,10 @@ public class Meta extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-meta-content">content</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-meta-content">content</a>
+ * attribute.
* Value of the element.
+ *
* @param content The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -52,8 +58,10 @@ public class Meta extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-meta-http-equiv">http-equiv</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-meta-http-equiv">http-equiv</a>
+ * attribute.
* Pragma directive.
+ *
* @param httpequiv The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -65,6 +73,7 @@ public class Meta extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-meta-name">name</a> attribute.
* Metadata name.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
index af4a5b2..5cdd84f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-meter-element"><meter></a> element.
+ * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-meter-element"><meter></a>
+ * element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-high">high</a> attribute.
* Low limit of high range.
+ *
* @param high The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -44,6 +47,7 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-low">low</a> attribute.
* High limit of low range.
+ *
* @param low The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -56,6 +60,7 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-max">max</a> attribute.
* Upper bound of range.
+ *
* @param max The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -68,6 +73,7 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-min">min</a> attribute.
* Lower bound of range.
+ *
* @param min The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -80,6 +86,7 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-optimum">optimum</a> attribute.
* Optimum value in gauge.
+ *
* @param optimum The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -92,6 +99,7 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-value">value</a> attribute.
* Current value of the element.
+ *
* @param value The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Nav.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Nav.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Nav.java
index e573d5e..1d9ac5b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Nav.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Nav.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-nav-element"><nav></a> element.
+ * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-nav-element"><nav></a>
+ * element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
index fec9b64..37097d0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#the-noscript-element"><noscript></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/scripting-1.html#the-noscript-element"><noscript></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
index 3a22bea..a63a076 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-object-element"><object></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-object-element"><object></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-object-data">data</a> attribute.
* Address of the resource.
+ *
* @param data The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -43,6 +46,7 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
* Associates the control with a form element.
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -52,8 +56,10 @@ public class Object2 extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
+ * attribute.
* Vertical dimension.
+ *
* @param height The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -66,6 +72,7 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-object-name">name</a> attribute.
* Name of nested browsing context.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -77,6 +84,7 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-object-type">type</a> attribute.
* Type of embedded resource.
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -86,8 +94,10 @@ public class Object2 extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-object-typemustmatch">typemustmatch</a> attribute.
+ * <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-object-typemustmatch">typemustmatch</a> attribute.
* Whether the type attribute and the Content-Type value need to match for the resource to be used.
+ *
* @param typemustmatch The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -98,8 +108,10 @@ public class Object2 extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-hyperlink-usemap">usemap</a> attribute.
+ * <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-hyperlink-usemap">usemap</a> attribute.
* Name of image map to use.
+ *
* @param usemap The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -111,6 +123,7 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
* Horizontal dimension.
+ *
* @param width The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
index 50d55f6..8e1be54 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-ol-element"><ol></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-ol-element"><ol></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -30,8 +32,10 @@ import org.apache.juneau.annotation.*;
public class Ol extends HtmlElementContainer {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-ol-reversed">reversed</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-ol-reversed">reversed</a>
+ * attribute.
* Number the list backwards..
+ *
* @param reversed The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -44,6 +48,7 @@ public class Ol extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-ol-start">start</a> attribute.
* Ordinal value of the first item.
+ *
* @param start The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -55,7 +60,8 @@ public class Ol extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-ol-type">type</a> attribute.
- * Kind of list marker..
+ * Kind of list marker.
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
index 0297805..a93e065 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-optgroup-element"><optgroup></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-optgroup-element"><optgroup></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Optgroup extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-optgroup-disabled">disabled</a> attribute.
* Whether the form control is disabled.
+ *
* @param disabled The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -44,6 +47,7 @@ public class Optgroup extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-optgroup-label">label</a> attribute.
* User-visible label.
+ *
* @param label The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
index a97bd18..237b55e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-option-element"><option></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-option-element"><option></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Option extends HtmlElementText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-option-disabled">disabled</a> attribute.
* Whether the form control is disabled.
+ *
* @param disabled The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -44,6 +47,7 @@ public class Option extends HtmlElementText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-option-label">label</a> attribute.
* User-visible label.
+ *
* @param label The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -55,6 +59,7 @@ public class Option extends HtmlElementText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-option-selected">selected</a> attribute.
* Whether the option is selected by default.
+ *
* @param selected The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -67,6 +72,7 @@ public class Option extends HtmlElementText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-option-value">value</a> attribute.
* Value to be used for form submission.
+ *
* @param value The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
index 500b6f0..5d99cc8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-output-element"><output></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-output-element"><output></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Output extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-output-for">for</a> attribute.
* Specifies controls from which the output was calculated.
+ *
* @param _for The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -43,6 +46,7 @@ public class Output extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
* Associates the control with a form element.
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -54,6 +58,7 @@ public class Output extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
* Name of form control to use for form submission and in the form.elements API.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
index 49b23f9..f53dc21 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-p-element"><p></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-p-element"><p></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
index 71d429b..4444e7c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-param-element"><param></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-param-element"><param></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Param extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-param-name">name</a> attribute.
* Name of parameter.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -41,8 +44,10 @@ public class Param extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-param-value">value</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-param-value">value</a>
+ * attribute.
* Value of parameter.
+ *
* @param value The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
index d321104..f40c248 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
@@ -20,12 +20,14 @@ import org.apache.juneau.annotation.*;
import org.apache.juneau.xml.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-pre-element"><pre></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/grouping-content.html#the-pre-element"><pre></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
index 057a640..17ff965 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-progress-element"><progress></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-progress-element"><progress></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Progress extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-progress-max">max</a> attribute.
* Upper bound of range.
+ *
* @param max The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -44,6 +47,7 @@ public class Progress extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-progress-value">value</a> attribute.
* Current value of the element.
+ *
* @param value The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
index ac5a39d..7e3727f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-q-element"><q></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-q-element"><q></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Q extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#attr-q-cite">cite</a> attribute.
* Link to the source of the quotation or more information about the edit.
+ *
* @param cite The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
index 9062df6..fc3c9e5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rb-element"><rb></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rb-element"><rb></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
index fb491e1..71173ce 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rp-element"><rp></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rp-element"><rp></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
index d7abc6f..303869a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rt-element"><rt></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rt-element"><rt></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
index ae3523e..5093666 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rtc-element"><rtc></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rtc-element"><rtc></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
index d2d8b6c..aeebe73 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-ruby-element"><ruby></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-ruby-element"><ruby></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
index d95240a..d1a4036 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-s-element"><s></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-s-element"><s></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
index 6c3083d..484fa50 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-samp-element"><samp></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-samp-element"><samp></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
index 872545b..952ae54 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#the-script-element"><script></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/scripting-1.html#the-script-element"><script></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -36,6 +38,7 @@ public class Script extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-async">async</a> attribute.
* Execute script asynchronously.
+ *
* @param async The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -48,6 +51,7 @@ public class Script extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-charset">charset</a> attribute.
* Character encoding of the external script resource.
+ *
* @param charset The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -57,8 +61,10 @@ public class Script extends HtmlElementRawText {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-crossorigin">crossorigin</a> attribute.
- * How the element handles crossorigin requests.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-crossorigin">crossorigin</a>
+ * attribute.
+ * How the element handles cross-origin requests.
+ *
* @param crossorigin The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -70,6 +76,7 @@ public class Script extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-defer">defer</a> attribute.
* Defer script execution.
+ *
* @param defer The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -100,6 +107,7 @@ public class Script extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-type">type</a> attribute.
* Type of embedded resource.
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
index cf9bef9..081575c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-section-element"><section></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/sections.html#the-section-element"><section></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
index eb2a523..0acb95b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-select-element"><select></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/forms.html#the-select-element"><select></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -32,6 +34,7 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus">autofocus</a> attribute.
* Automatically focus the form control when the page is loaded.
+ *
* @param autofocus The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -44,6 +47,7 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled">disabled</a> attribute.
* Whether the form control is disabled.
+ *
* @param disabled The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -56,6 +60,7 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
* Associates the control with a form element.
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -67,6 +72,7 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-select-multiple">multiple</a> attribute.
* Whether to allow multiple values.
+ *
* @param multiple The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -79,6 +85,7 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
* Name of form control to use for form submission and in the form.elements API.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -90,6 +97,7 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-select-required">required</a> attribute.
* Whether the control is required for form submission.
+ *
* @param required The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -102,6 +110,7 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-select-size">size</a> attribute.
* Size of the control.
+ *
* @param size The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
index 57d1569..0fe437f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-small-element"><small></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-small-element"><small></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
[19/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
index 8150bec..9273bd3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
@@ -17,7 +17,8 @@ package org.apache.juneau.dto.html5;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -27,6 +28,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link A} element.
+ *
* @return The new element.
*/
public static final A a() {
@@ -34,7 +36,9 @@ public class HtmlBuilder {
}
/**
- * Creates an {@link A} element with the specified {@link A#href(Object)} attribute and {@link A#children(Object[])} nodes.
+ * Creates an {@link A} element with the specified {@link A#href(Object)} attribute and {@link A#children(Object[])}
+ * nodes.
+ *
* @param href The {@link A#href(Object)} attribute.
* @param children The {@link A#children(Object[])} nodes.
* @return The new element.
@@ -45,6 +49,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Abbr} element.
+ *
* @return The new element.
*/
public static final Abbr abbr() {
@@ -52,7 +57,9 @@ public class HtmlBuilder {
}
/**
- * Creates an {@link Abbr} element with the specified {@link Abbr#title(String)} attribute and {@link Abbr#children(Object[])} nodes.
+ * Creates an {@link Abbr} element with the specified {@link Abbr#title(String)} attribute and
+ * {@link Abbr#children(Object[])} nodes.
+ *
* @param title The {@link Abbr#title(String)} attribute.
* @param children The {@link Abbr#children(Object[])} nodes.
* @return The new element.
@@ -63,6 +70,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Address} element.
+ *
* @return The new element.
*/
public static final Address address() {
@@ -71,6 +79,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Address} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -80,6 +89,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Area} element.
+ *
* @return The new element.
*/
public static final Area area() {
@@ -87,7 +97,9 @@ public class HtmlBuilder {
}
/**
- * Creates an {@link Area} element with the specified {@link Area#shape(String)}, {@link Area#coords(String)}, and {@link Area#href(Object)} attributes.
+ * Creates an {@link Area} element with the specified {@link Area#shape(String)}, {@link Area#coords(String)},
+ * and {@link Area#href(Object)} attributes.
+ *
* @param shape The {@link Area#shape(String)} attribute.
* @param coords The {@link Area#coords(String)} attribute.
* @param href The {@link Area#href(Object)} attribute.
@@ -99,6 +111,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Article} element.
+ *
* @return The new element.
*/
public static final Article article() {
@@ -107,6 +120,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Article} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -116,6 +130,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Aside} element.
+ *
* @return The new element.
*/
public static final Aside aside() {
@@ -124,6 +139,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Aside} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -133,6 +149,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Audio} element.
+ *
* @return The new element.
*/
public static final Audio audio() {
@@ -141,6 +158,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Audio} element with the specified {@link Audio#src(Object)} attribute.
+ *
* @param src The {@link Audio#src(Object)} attribute.
* @return The new element.
*/
@@ -150,6 +168,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link B} element.
+ *
* @return The new element.
*/
public static final B b() {
@@ -158,6 +177,7 @@ public class HtmlBuilder {
/**
* Creates a {@link B} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -167,6 +187,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Base} element.
+ *
* @return The new element.
*/
public static final Base base() {
@@ -175,6 +196,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Base} element with the specified {@link Base#href(Object)} attribute.
+ *
* @param href The {@link Base#href(Object)} attribute.
* @return The new element.
*/
@@ -184,6 +206,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Bdi} element.
+ *
* @return The new element.
*/
public static final Bdi bdi() {
@@ -192,6 +215,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Bdi} element with the specified {@link Bdi#text(Object)} node.
+ *
* @param text The {@link Bdi#text(Object)} node.
* @return The new element.
*/
@@ -201,6 +225,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Bdo} element.
+ *
* @return The new element.
*/
public static final Bdo bdo() {
@@ -209,6 +234,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Bdo} element with the specified {@link Bdo#dir(String)} attribute and child nodes.
+ *
* @param dir The {@link Bdo#dir(String)} attribute.
* @param children The child nodes.
* @return The new element.
@@ -219,6 +245,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Blockquote} element.
+ *
* @return The new element.
*/
public static final Blockquote blockquote() {
@@ -227,6 +254,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Blockquote} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -236,6 +264,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Body} element.
+ *
* @return The new element.
*/
public static final Body body() {
@@ -244,6 +273,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Body} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -253,6 +283,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Br} element.
+ *
* @return The new element.
*/
public static final Br br() {
@@ -261,6 +292,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Button} element.
+ *
* @return The new element.
*/
public static final Button button() {
@@ -269,6 +301,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Button} element with the specified {@link Button#type(String)} attribute.
+ *
* @param type The {@link Button#type(String)} attribute.
* @return The new element.
*/
@@ -277,7 +310,9 @@ public class HtmlBuilder {
}
/**
- * Creates a {@link Button} element with the specified {@link Button#type(String)} attribute and {@link Button#children(Object[])} nodes.
+ * Creates a {@link Button} element with the specified {@link Button#type(String)} attribute and
+ * {@link Button#children(Object[])} nodes.
+ *
* @param type The {@link Button#type(String)} attribute.
* @param children The {@link Button#children(Object[])} nodes.
* @return The new element.
@@ -295,7 +330,9 @@ public class HtmlBuilder {
}
/**
- * Creates a {@link Canvas} element with the specified {@link Canvas#width(Object)} and {@link Canvas#height(Object)} attributes.
+ * Creates a {@link Canvas} element with the specified {@link Canvas#width(Object)} and
+ * {@link Canvas#height(Object)} attributes.
+ *
* @param width The {@link Canvas#width(Object)} attribute.
* @param height The {@link Canvas#height(Object)} attribute.
* @return The new element.
@@ -306,6 +343,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Caption} element.
+ *
* @return The new element.
*/
public static final Caption caption() {
@@ -314,6 +352,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Caption} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -323,6 +362,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Cite} element.
+ *
* @return The new element.
*/
public static final Cite cite() {
@@ -331,6 +371,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Cite} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -340,6 +381,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Code} element.
+ *
* @return The new element.
*/
public static final Code code() {
@@ -348,6 +390,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Code} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -357,7 +400,9 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Col} element.
+ *
* @return The new element.
+ *
*/
public static final Col col() {
return new Col();
@@ -365,6 +410,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Col} element with the specified {@link Col#span(Object)} attribute.
+ *
* @param span The {@link Col#span(Object)} attribute.
* @return The new element.
*/
@@ -374,6 +420,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Colgroup} element.
+ *
* @return The new element.
*/
public static final Colgroup colgroup() {
@@ -382,6 +429,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Colgroup} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -391,6 +439,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Data} element.
+ *
* @return The new element.
*/
public static final Data data() {
@@ -399,6 +448,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Data} element with the specified {@link Data#value(Object)} attribute and child node.
+ *
* @param value The {@link Data#value(Object)} attribute.
* @param child The child node.
* @return The new element.
@@ -409,6 +459,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Datalist} element.
+ *
* @return The new element.
*/
public static final Datalist datalist() {
@@ -417,6 +468,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Datalist} element with the specified {@link Datalist#id(String)} attribute and child nodes.
+ *
* @param id The {@link Datalist#id(String)} attribute.
* @param children The child nodes.
* @return The new element.
@@ -427,6 +479,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Dd} element.
+ *
* @return The new element.
*/
public static final Dd dd() {
@@ -435,6 +488,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Dd} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -444,6 +498,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Del} element.
+ *
* @return The new element.
*/
public static final Del del() {
@@ -452,6 +507,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Del} element with the specified {@link Del#children(Object[])} node.
+ *
* @param children The {@link Del#children(Object[])} node.
* @return The new element.
*/
@@ -461,6 +517,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Dfn} element.
+ *
* @return The new element.
*/
public static final Dfn dfn() {
@@ -469,6 +526,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Dfn} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -478,6 +536,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Div} element.
+ *
* @return The new element.
*/
public static final Div div() {
@@ -486,6 +545,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Div} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -495,6 +555,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Dl} element.
+ *
* @return The new element.
*/
public static final Dl dl() {
@@ -503,6 +564,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Dl} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -512,6 +574,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Dt} element.
+ *
* @return The new element.
*/
public static final Dt dt() {
@@ -520,6 +583,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Dt} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -529,6 +593,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Em} element.
+ *
* @return The new element.
*/
public static final Em em() {
@@ -537,6 +602,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Em} element with the specified {@link Em#children(Object[])} nodes.
+ *
* @param children The {@link Em#children(Object[])} nodes.
* @return The new element.
*/
@@ -546,6 +612,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Embed} element.
+ *
* @return The new element.
*/
public static final Embed embed() {
@@ -554,6 +621,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Embed} element with the specified {@link Embed#src(Object)} attribute.
+ *
* @param src The {@link Embed#src(Object)} attribute.
* @return The new element.
*/
@@ -563,6 +631,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Fieldset} element.
+ *
* @return The new element.
*/
public static final Fieldset fieldset() {
@@ -571,6 +640,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Fieldset} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -580,6 +650,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Figcaption} element.
+ *
* @return The new element.
*/
public static final Figcaption figcaption() {
@@ -588,6 +659,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Figcaption} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -597,6 +669,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Figure} element.
+ *
* @return The new element.
*/
public static final Figure figure() {
@@ -605,6 +678,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Figure} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -614,6 +688,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Footer} element.
+ *
* @return The new element.
*/
public static final Footer footer() {
@@ -622,6 +697,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Footer} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -631,6 +707,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Form} element.
+ *
* @return The new element.
*/
public static final Form form() {
@@ -639,6 +716,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Form} element with the specified {@link Form#action(String)} attribute.
+ *
* @param action The {@link Form#action(String)} attribute.
* @return The new element.
*/
@@ -648,6 +726,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Form} element with the specified {@link Form#action(String)} attribute and child nodes.
+ *
* @param action The {@link Form#action(String)} attribute.
* @param children The child nodes.
* @return The new element.
@@ -658,6 +737,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link H1} element.
+ *
* @return The new element.
*/
public static final H1 h1() {
@@ -666,6 +746,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H1} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -675,6 +756,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link H2} element.
+ *
* @return The new element.
*/
public static final H2 h2() {
@@ -683,6 +765,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H2} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -692,6 +775,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link H3} element.
+ *
* @return The new element.
*/
public static final H3 h3() {
@@ -700,6 +784,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H3} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -709,6 +794,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link H4} element.
+ *
* @return The new element.
*/
public static final H4 h4() {
@@ -717,6 +803,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H4} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -726,6 +813,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link H5} element.
+ *
* @return The new element.
*/
public static final H5 h5() {
@@ -734,6 +822,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H5} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -751,6 +840,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H6} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -760,6 +850,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Head} element.
+ *
* @return The new element.
*/
public static final Head head() {
@@ -768,6 +859,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Head} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -777,6 +869,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Header} element.
+ *
* @return The new element.
*/
public static final Header header() {
@@ -785,6 +878,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Header} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -794,6 +888,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Hr} element.
+ *
* @return The new element.
*/
public static final Hr hr() {
@@ -802,6 +897,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Html} element.
+ *
* @return The new element.
*/
public static final Html html() {
@@ -810,6 +906,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Html} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -819,6 +916,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link I} element.
+ *
* @return The new element.
*/
public static final I i() {
@@ -827,6 +925,7 @@ public class HtmlBuilder {
/**
* Creates an {@link I} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -836,6 +935,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Iframe} element.
+ *
* @return The new element.
*/
public static final Iframe iframe() {
@@ -844,6 +944,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Iframe} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -853,6 +954,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Img} element.
+ *
* @return The new element.
*/
public static final Img img() {
@@ -861,6 +963,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Img} element with the specified {@link Img#src(Object)} attribute.
+ *
* @param src The {@link Img#src(Object)} attribute.
* @return The new element.
*/
@@ -870,6 +973,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Input} element.
+ *
* @return The new element.
*/
public static final Input input() {
@@ -878,6 +982,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Input} element with the specified {@link Input#type(String)} attribute.
+ *
* @param type The {@link Input#type(String)} attribute.
* @return The new element.
*/
@@ -887,6 +992,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Ins} element.
+ *
* @return The new element.
*/
public static final Ins ins() {
@@ -895,6 +1001,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Ins} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -904,6 +1011,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Kbd} element.
+ *
* @return The new element.
*/
public static final Kbd kbd() {
@@ -912,6 +1020,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Kbd} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -921,6 +1030,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Keygen} element.
+ *
* @return The new element.
*/
public static final Keygen keygen() {
@@ -929,6 +1039,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Label} element.
+ *
* @return The new element.
*/
public static final Label label() {
@@ -937,6 +1048,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Label} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -946,6 +1058,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Legend} element.
+ *
* @return The new element.
*/
public static final Legend legend() {
@@ -954,6 +1067,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Legend} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -963,6 +1077,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Li} element.
+ *
* @return The new element.
*/
public static final Li li() {
@@ -971,6 +1086,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Li} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -980,6 +1096,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Link} element.
+ *
* @return The new element.
*/
public static final Link link() {
@@ -988,6 +1105,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Link} element with the specified {@link Link#href(Object)} attribute.
+ *
* @param href The {@link Link#href(Object)} attribute.
* @return The new element.
*/
@@ -997,6 +1115,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Main} element.
+ *
* @return The new element.
*/
public static final Main main() {
@@ -1005,6 +1124,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Main} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1014,6 +1134,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Map} element.
+ *
* @return The new element.
*/
public static final Map map() {
@@ -1022,6 +1143,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Map} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1031,6 +1153,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Mark} element.
+ *
* @return The new element.
*/
public static final Mark mark() {
@@ -1039,6 +1162,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Mark} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1048,6 +1172,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Meta} element.
+ *
* @return The new element.
*/
public static final Meta meta() {
@@ -1056,6 +1181,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Meter} element.
+ *
* @return The new element.
*/
public static final Meter meter() {
@@ -1064,6 +1190,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Meter} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1073,6 +1200,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Nav} element.
+ *
* @return The new element.
*/
public static final Nav nav() {
@@ -1081,6 +1209,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Nav} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1090,6 +1219,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Noscript} element.
+ *
* @return The new element.
*/
public static final Noscript noscript() {
@@ -1098,6 +1228,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Noscript} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1107,6 +1238,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Object2} element.
+ *
* @return The new element.
*/
public static final Object2 object() {
@@ -1115,6 +1247,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Object2} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1124,6 +1257,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Ol} element.
+ *
* @return The new element.
*/
public static final Ol ol() {
@@ -1132,6 +1266,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Ol} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1141,6 +1276,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Optgroup} element.
+ *
* @return The new element.
*/
public static final Optgroup optgroup() {
@@ -1149,6 +1285,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Optgroup} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1158,6 +1295,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Option} element.
+ *
* @return The new element.
*/
public static final Option option() {
@@ -1166,6 +1304,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Option} element with the specified {@link Option#value(Object)} attribute.
+ *
* @param value The {@link Option#value(Object)} attribute.
* @return The new element.
*/
@@ -1174,7 +1313,9 @@ public class HtmlBuilder {
}
/**
- * Creates an {@link Option} element with the specified {@link Option#value(Object)} attribute and {@link Option#text(Object)} node.
+ * Creates an {@link Option} element with the specified {@link Option#value(Object)} attribute and
+ * {@link Option#text(Object)} node.
+ *
* @param value The {@link Option#value(Object)} attribute.
* @param text The {@link Option#text(Object)} node.
* @return The new element.
@@ -1185,6 +1326,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Output} element.
+ *
* @return The new element.
*/
public static final Output output() {
@@ -1193,6 +1335,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Output} element with the specified {@link Output#name(String)} attribute.
+ *
* @param name The {@link Output#name(String)} attribute.
* @return The new element.
*/
@@ -1202,6 +1345,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link P} element.
+ *
* @return The new element.
*/
public static final P p() {
@@ -1210,6 +1354,7 @@ public class HtmlBuilder {
/**
* Creates a {@link P} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1219,6 +1364,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Param} element.
+ *
* @return The new element.
*/
public static final Param param() {
@@ -1226,7 +1372,9 @@ public class HtmlBuilder {
}
/**
- * Creates a {@link Param} element with the specified {@link Param#name(String)} and {@link Param#value(Object)} attributes.
+ * Creates a {@link Param} element with the specified {@link Param#name(String)} and {@link Param#value(Object)}
+ * attributes.
+ *
* @param name The {@link Param#name(String)} attribute.
* @param value The {@link Param#value(Object)} attribute.
* @return The new element.
@@ -1237,6 +1385,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Pre} element.
+ *
* @return The new element.
*/
public static final Pre pre() {
@@ -1245,6 +1394,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Pre} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1254,6 +1404,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Progress} element.
+ *
* @return The new element.
*/
public static final Progress progress() {
@@ -1262,6 +1413,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Progress} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1271,6 +1423,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Q} element.
+ *
* @return The new element.
*/
public static final Q q() {
@@ -1279,6 +1432,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Q} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1288,6 +1442,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Rb} element.
+ *
* @return The new element.
*/
public static final Rb rb() {
@@ -1296,6 +1451,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Rb} element with the specified {@link Rb#children(Object[])} nodes.
+ *
* @param children The {@link Rb#children(Object[])} nodes.
* @return The new element.
*/
@@ -1305,6 +1461,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Rp} element.
+ *
* @return The new element.
*/
public static final Rp rp() {
@@ -1313,6 +1470,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Rp} element with the specified {@link Rp#children(Object[])} nodes.
+ *
* @param children The {@link Rp#children(Object[])} nodes.
* @return The new element.
*/
@@ -1322,6 +1480,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Rt} element.
+ *
* @return The new element.
*/
public static final Rt rt() {
@@ -1330,6 +1489,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Rt} element with the specified {@link Rt#children(Object[])} nodes.
+ *
* @param children The {@link Rt#children(Object[])} nodes.
* @return The new element.
*/
@@ -1339,6 +1499,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Rtc} element.
+ *
* @return The new element.
*/
public static final Rtc rtc() {
@@ -1347,6 +1508,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Rtc} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1356,6 +1518,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Ruby} element.
+ *
* @return The new element.
*/
public static final Ruby ruby() {
@@ -1364,6 +1527,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Ruby} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1373,6 +1537,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link S} element.
+ *
* @return The new element.
*/
public static final S s() {
@@ -1381,6 +1546,7 @@ public class HtmlBuilder {
/**
* Creates an {@link S} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1390,6 +1556,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Samp} element.
+ *
* @return The new element.
*/
public static final Samp samp() {
@@ -1398,6 +1565,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Samp} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1407,6 +1575,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Script} element.
+ *
* @return The new element.
*/
public static final Script script() {
@@ -1414,7 +1583,9 @@ public class HtmlBuilder {
}
/**
- * Creates a {@link Script} element with the specified {@link Script#type(String)} attribute and {@link Script#text(Object)} node.
+ * Creates a {@link Script} element with the specified {@link Script#type(String)} attribute and
+ * {@link Script#text(Object)} node.
+ *
* @param type The {@link Script#type(String)} attribute.
* @param text The child text node.
* @return The new element.
@@ -1425,6 +1596,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Section} element.
+ *
* @return The new element.
*/
public static final Section section() {
@@ -1433,6 +1605,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Section} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1442,6 +1615,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Select} element.
+ *
* @return The new element.
*/
public static final Select select() {
@@ -1450,6 +1624,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Select} element with the specified {@link Select#name(String)} attribute and child nodes.
+ *
* @param name The {@link Select#name(String)} attribute.
* @param children The child nodes.
* @return The new element.
@@ -1460,6 +1635,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Small} element.
+ *
* @return The new element.
*/
public static final Small small() {
@@ -1468,6 +1644,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Small} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1477,6 +1654,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Source} element.
+ *
* @return The new element.
*/
public static final Source source() {
@@ -1484,7 +1662,9 @@ public class HtmlBuilder {
}
/**
- * Creates a {@link Source} element with the specified {@link Source#src(Object)} and {@link Source#type(String)} attributes.
+ * Creates a {@link Source} element with the specified {@link Source#src(Object)} and {@link Source#type(String)}
+ * attributes.
+ *
* @param src The {@link Source#src(Object)} attribute.
* @param type The {@link Source#type(String)} attribute.
* @return The new element.
@@ -1495,6 +1675,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Span} element.
+ *
* @return The new element.
*/
public static final Span span() {
@@ -1503,6 +1684,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Span} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1512,6 +1694,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Strong} element.
+ *
* @return The new element.
*/
public static final Strong strong() {
@@ -1520,6 +1703,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Strong} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1529,6 +1713,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Style} element.
+ *
* @return The new element.
*/
public static final Style style() {
@@ -1537,6 +1722,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Style} element with the specified {@link Style#text(Object)} node.
+ *
* @param text The {@link Style#text(Object)} node.
* @return The new element.
*/
@@ -1546,6 +1732,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Sub} element.
+ *
* @return The new element.
*/
public static final Sub sub() {
@@ -1554,6 +1741,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Sub} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1563,6 +1751,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Sup} element.
+ *
* @return The new element.
*/
public static final Sup sup() {
@@ -1571,6 +1760,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Sup} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1580,6 +1770,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Table} element.
+ *
* @return The new element.
*/
public static final Table table() {
@@ -1588,6 +1779,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Table} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1597,6 +1789,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Tbody} element.
+ *
* @return The new element.
*/
public static final Tbody tbody() {
@@ -1605,6 +1798,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Tbody} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1614,6 +1808,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Td} element.
+ *
* @return The new element.
*/
public static final Td td() {
@@ -1622,6 +1817,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Td} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1631,6 +1827,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Template} element.
+ *
* @return The new element.
*/
public static final Template template() {
@@ -1639,6 +1836,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Template} element with the specified {@link Template#id(String)} attribute and child nodes.
+ *
* @param id The {@link Template#id(String)} attribute.
* @param children The child nodes.
* @return The new element.
@@ -1649,6 +1847,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Textarea} element.
+ *
* @return The new element.
*/
public static final Textarea textarea() {
@@ -1656,7 +1855,9 @@ public class HtmlBuilder {
}
/**
- * Creates a {@link Textarea} element with the specified {@link Textarea#name(String)} attribute and {@link Textarea#text(Object)} node.
+ * Creates a {@link Textarea} element with the specified {@link Textarea#name(String)} attribute and
+ * {@link Textarea#text(Object)} node.
+ *
* @param name The {@link Textarea#name(String)} attribute.
* @param text The {@link Textarea#text(Object)} node.
* @return The new element.
@@ -1667,6 +1868,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Tfoot} element.
+ *
* @return The new element.
*/
public static final Tfoot tfoot() {
@@ -1675,6 +1877,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Tfoot} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1684,6 +1887,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Th} element.
+ *
* @return The new element.
*/
public static final Th th() {
@@ -1692,6 +1896,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Th} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1701,6 +1906,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Thead} element.
+ *
* @return The new element.
*/
public static final Thead thead() {
@@ -1709,6 +1915,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Thead} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1718,6 +1925,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Time} element.
+ *
* @return The new element.
*/
public static final Time time() {
@@ -1726,6 +1934,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Time} element with the specified {@link Time#children(Object[])} nodes.
+ *
* @param children The {@link Time#children(Object[])} nodes.
* @return The new element.
*/
@@ -1735,6 +1944,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Title} element.
+ *
* @return The new element.
*/
public static final Title title() {
@@ -1743,6 +1953,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Title} element with the specified {@link Title#text(Object)} node.
+ *
* @param text The {@link Title#text(Object)} node.
* @return The new element.
*/
@@ -1752,6 +1963,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Tr} element.
+ *
* @return The new element.
*/
public static final Tr tr() {
@@ -1760,6 +1972,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Tr} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1769,6 +1982,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Track} element.
+ *
* @return The new element.
*/
public static final Track track() {
@@ -1776,7 +1990,9 @@ public class HtmlBuilder {
}
/**
- * Creates a {@link Track} element with the specified {@link Track#src(Object)} and {@link Track#kind(String)} attributes.
+ * Creates a {@link Track} element with the specified {@link Track#src(Object)} and {@link Track#kind(String)}
+ * attributes.
+ *
* @param src The {@link Track#src(Object)} attribute.
* @param kind The {@link Track#kind(String)} attribute.
* @return The new element.
@@ -1787,6 +2003,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link U} element.
+ *
* @return The new element.
*/
public static final U u() {
@@ -1795,6 +2012,7 @@ public class HtmlBuilder {
/**
* Creates a {@link U} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1804,6 +2022,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Ul} element.
+ *
* @return The new element.
*/
public static final Ul ul() {
@@ -1812,6 +2031,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Ul} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1821,6 +2041,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Var} element.
+ *
* @return The new element.
*/
public static final Var var() {
@@ -1829,6 +2050,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Var} element with the specified child nodes.
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1838,6 +2060,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Video} element.
+ *
* @return The new element.
*/
public static final Video video() {
@@ -1846,6 +2069,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Video} element with the specified {@link Video#src(Object)} attribute.
+ *
* @param src The {@link Video#src(Object)} attribute.
* @return The new element.
*/
@@ -1855,6 +2079,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Wbr} element.
+ *
* @return The new element.
*/
public static final Wbr wbr() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
index 831db27..9c63665 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
@@ -33,7 +33,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -46,6 +47,7 @@ public abstract class HtmlElement {
/**
* The attributes of this element.
+ *
* @return The attributes of this element.
*/
@Xml(format=ATTRS)
@@ -56,6 +58,7 @@ public abstract class HtmlElement {
/**
* Sets the attributes for this element.
+ *
* @param attrs The new attributes for this element.
* @return This object (for method chaining).
*/
@@ -72,9 +75,9 @@ public abstract class HtmlElement {
/**
* Adds an arbitrary attribute to this element.
+ *
* @param key The attribute name.
* @param val The attribute value.
- *
* @return This object (for method chaining).
*/
public HtmlElement attr(String key, Object val) {
@@ -122,7 +125,7 @@ public abstract class HtmlElement {
* Returns the attribute with the specified name converted to the specified class type.
*
* @param type The class type to convert this class to.
- * See {@link ObjectUtils} for a list of supported conversion types.
+ * See {@link ObjectUtils} for a list of supported conversion types.
* @param key The attribute name.
* @return The attribute value, or <jk>null</jk> if the named attribute does not exist.
*/
@@ -131,7 +134,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#the-accesskey-attribute">accesskey</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#the-accesskey-attribute">accesskey</a>
+ * attribute.
+ *
* @param accesskey The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -142,6 +147,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#classes">class</a> attribute.
+ *
* @param _class The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -151,7 +157,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#attr-contenteditable">contenteditable</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#attr-contenteditable">contenteditable</a>
+ * attribute.
+ *
* @param contenteditable The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -163,6 +171,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#the-dir-attribute">dir</a> attribute.
+ *
* @param dir The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -173,6 +182,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#the-hidden-attribute">hidden</a> attribute.
+ *
* @param hidden The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -184,6 +194,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#the-id-attribute">id</a> attribute.
+ *
* @param id The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -194,6 +205,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#attr-lang">lang</a> attribute.
+ *
* @param lang The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -204,6 +216,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onabort">onabort</a> attribute.
+ *
* @param onabort The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -214,6 +227,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onblur">onblur</a> attribute.
+ *
* @param onblur The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -224,6 +238,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oncancel">oncancel</a> attribute.
+ *
* @param oncancel The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -234,6 +249,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oncanplay">oncanplay</a> attribute.
+ *
* @param oncanplay The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -243,7 +259,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oncanplaythrough">oncanplaythrough</a> attribute.
+ * <a class="doclink"
+ * href="https://www.w3.org/TR/html5/webappapis.html#handler-oncanplaythrough">oncanplaythrough</a> attribute.
+ *
* @param oncanplaythrough The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -254,6 +272,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onchange">onchange</a> attribute.
+ *
* @param onchange The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -264,6 +283,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onclick">onclick</a> attribute.
+ *
* @param onclick The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -273,7 +293,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oncuechange">oncuechange</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oncuechange">oncuechange</a>
+ * attribute.
+ *
* @param oncuechange The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -284,6 +306,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-ondblclick">ondblclick</a> attribute.
+ *
* @param ondblclick The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -293,7 +316,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-ondurationchange">ondurationchange</a> attribute.
+ * <a class="doclink"
+ * href="https://www.w3.org/TR/html5/webappapis.html#handler-ondurationchange">ondurationchange</a> attribute.
+ *
* @param ondurationchange The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -304,6 +329,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onemptied">onemptied</a> attribute.
+ *
* @param onemptied The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -314,6 +340,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onended">onended</a> attribute.
+ *
* @param onended The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -324,6 +351,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onerror">onerror</a> attribute.
+ *
* @param onerror The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -334,6 +362,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onfocus">onfocus</a> attribute.
+ *
* @param onfocus The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -344,6 +373,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oninput">oninput</a> attribute.
+ *
* @param oninput The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -354,6 +384,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oninvalid">oninvalid</a> attribute.
+ *
* @param oninvalid The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -364,6 +395,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onkeydown">onkeydown</a> attribute.
+ *
* @param onkeydown The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -374,6 +406,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onkeypress">onkeypress</a> attribute.
+ *
* @param onkeypress The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -384,6 +417,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onkeyup">onkeyup</a> attribute.
+ *
* @param onkeyup The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -394,6 +428,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onload">onload</a> attribute.
+ *
* @param onload The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -403,7 +438,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onloadeddata">onloadeddata</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onloadeddata">onloadeddata</a>
+ * attribute.
+ *
* @param onloadeddata The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -413,7 +450,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onloadedmetadata">onloadedmetadata</a> attribute.
+ * <a class="doclink"
+ * href="https://www.w3.org/TR/html5/webappapis.html#handler-onloadedmetadata">onloadedmetadata</a> attribute.
+ *
* @param onloadedmetadata The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -423,7 +462,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onloadstart">onloadstart</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onloadstart">onloadstart</a>
+ * attribute.
+ *
* @param onloadstart The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -433,7 +474,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmousedown">onmousedown</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmousedown">onmousedown</a>
+ * attribute.
+ *
* @param onmousedown The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -453,7 +496,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmouseleave">onmouseleave</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmouseleave">onmouseleave</a>
+ * attribute.
+ *
* @param onmouseleave The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -463,7 +508,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmousemove">onmousemove</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmousemove">onmousemove</a>
+ * attribute.
+ *
* @param onmousemove The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -474,6 +521,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmouseout">onmouseout</a> attribute.
+ *
* @param onmouseout The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -483,7 +531,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmouseover">onmouseover</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmouseover">onmouseover</a>
+ * attribute.
+ *
* @param onmouseover The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -494,6 +544,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmouseup">onmouseup</a> attribute.
+ *
* @param onmouseup The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -503,7 +554,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmousewheel">onmousewheel</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmousewheel">onmousewheel</a>
+ * attribute.
+ *
* @param onmousewheel The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -514,6 +567,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onpause">onpause</a> attribute.
+ *
* @param onpause The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -524,6 +578,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onplay">onplay</a> attribute.
+ *
* @param onplay The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -534,6 +589,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onplaying">onplaying</a> attribute.
+ *
* @param onplaying The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -544,6 +600,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onprogress">onprogress</a> attribute.
+ *
* @param onprogress The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -553,7 +610,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onratechange">onratechange</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onratechange">onratechange</a>
+ * attribute.
+ *
* @param onratechange The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -564,6 +623,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onreset">onreset</a> attribute.
+ *
* @param onreset The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -574,6 +634,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onresize">onresize</a> attribute.
+ *
* @param onresize The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -584,6 +645,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onscroll">onscroll</a> attribute.
+ *
* @param onscroll The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -594,6 +656,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onseeked">onseeked</a> attribute.
+ *
* @param onseeked The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -604,6 +667,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onseeking">onseeking</a> attribute.
+ *
* @param onseeking The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -614,6 +678,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onselect">onselect</a> attribute.
+ *
* @param onselect The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -624,6 +689,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onshow">onshow</a> attribute.
+ *
* @param onshow The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -634,6 +700,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onstalled">onstalled</a> attribute.
+ *
* @param onstalled The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -644,6 +711,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onsubmit">onsubmit</a> attribute.
+ *
* @param onsubmit The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -654,6 +722,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onsuspend">onsuspend</a> attribute.
+ *
* @param onsuspend The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -663,7 +732,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-ontimeupdate">ontimeupdate</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-ontimeupdate">ontimeupdate</a>
+ * attribute.
+ *
* @param ontimeupdate The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -674,6 +745,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-ontoggle">ontoggle</a> attribute.
+ *
* @param ontoggle The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -683,7 +755,9 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onvolumechange">onvolumechange</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onvolumechange">onvolumechange</a>
+ * attribute.
+ *
* @param onvolumechange The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -694,6 +768,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onwaiting">onwaiting</a> attribute.
+ *
* @param onwaiting The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -704,6 +779,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#attr-spellcheck">spellcheck</a> attribute.
+ *
* @param spellcheck The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -715,6 +791,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#the-style-attribute">style</a> attribute.
+ *
* @param style The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -725,6 +802,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#attr-tabindex">tabindex</a> attribute.
+ *
* @param tabindex The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -736,6 +814,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#attr-title">title</a> attribute.
+ *
* @param title The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -746,6 +825,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#attr-translate">translate</a> attribute.
+ *
* @param translate The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
index 9651ad5..5de9b4c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
@@ -26,7 +26,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -38,6 +39,7 @@ public class HtmlElementContainer extends HtmlElement {
/**
* The children of this element.
+ *
* @return The children of this element.
*/
@Xml(format=ELEMENTS)
@@ -48,6 +50,7 @@ public class HtmlElementContainer extends HtmlElement {
/**
* Sets the children for this container.
+ *
* @param children The new children for this container.
* @return This object (for method chaining).
*/
@@ -103,11 +106,15 @@ public class HtmlElementContainer extends HtmlElement {
* @throws InvalidDataConversionException If node is not the expected type.
*/
public <T> T getChild(Class<T> type, int index) {
- return (children == null || children.size() <= index || index < 0 ? null : ObjectUtils.convertToType(children.get(index), type));
+ return (children == null || children.size() <= index || index < 0
+ ? null
+ : ObjectUtils.convertToType(children.get(index), type)
+ );
}
/**
* Adds one or more child elements to this element.
+ *
* @param children The children to add as child elements.
* @return This object (for method chaining).
*/
@@ -124,6 +131,7 @@ public class HtmlElementContainer extends HtmlElement {
/**
* Adds a child element to this element.
+ *
* @param child The child to add as a child element.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
index c45a768..fd5e9a6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
@@ -26,7 +26,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -38,6 +39,7 @@ public class HtmlElementMixed extends HtmlElement {
/**
* The children of this element.
+ *
* @return The children of this element.
*/
@Xml(format=MIXED)
@@ -104,11 +106,16 @@ public class HtmlElementMixed extends HtmlElement {
* @throws InvalidDataConversionException If node is not the expected type.
*/
public <T> T getChild(Class<T> type, int index) {
- return (children == null || children.size() <= index || index < 0 ? null : ObjectUtils.convertToType(children.get(index), type));
+ return (
+ children == null || children.size() <= index || index < 0
+ ? null
+ : ObjectUtils.convertToType(children.get(index), type)
+ );
}
/**
* Adds one or more child elements to this element.
+ *
* @param children The children to add as child elements.
* Can be a mixture of strings and {@link HtmlElement} objects.
* @return This object (for method chaining).
@@ -126,6 +133,7 @@ public class HtmlElementMixed extends HtmlElement {
/**
* Adds a child element to this element.
+ *
* @param child The child to add as a child element.
* Can be a string or {@link HtmlElement}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
index 95bbafa..3e2cfda 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
@@ -16,11 +16,13 @@ import org.apache.juneau.annotation.*;
import org.apache.juneau.xml.annotation.*;
/**
- * A subclass of HTML elements that contain <a href="https://www.w3.org/TR/html51/syntax.html#raw-text">raw text</a> only.
+ * A subclass of HTML elements that contain <a href="https://www.w3.org/TR/html51/syntax.html#raw-text">raw text</a>
+ * only.
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
index aff8252..1b5bc19 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
@@ -20,7 +20,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
index bca592d..7629401 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
@@ -23,7 +23,8 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
index a639988..8c66e26 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
@@ -15,12 +15,14 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-i-element"><i></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-i-element"><i></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
index 70757a4..d7126f1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
@@ -19,12 +19,14 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-iframe-element"><iframe></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-iframe-element"><iframe></a> element.
* <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -34,8 +36,10 @@ import org.apache.juneau.annotation.*;
public class Iframe extends HtmlElementMixed {
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
+ * attribute.
* Vertical dimension.
+ *
* @param height The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -48,6 +52,7 @@ public class Iframe extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-iframe-name">name</a> attribute.
* Name of nested browsing context.
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -57,8 +62,10 @@ public class Iframe extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-iframe-sandbox">sandbox</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-iframe-sandbox">sandbox</a>
+ * attribute.
* Security rules for nested content.
+ *
* @param sandbox The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -86,8 +93,10 @@ public class Iframe extends HtmlElementMixed {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-iframe-srcdoc">srcdoc</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-iframe-srcdoc">srcdoc</a>
+ * attribute.
* A document to render in the iframe.
+ *
* @param srcdoc The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -99,6 +108,7 @@ public class Iframe extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
* Horizontal dimension.
+ *
* @param width The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
index ab8ea60..4038de4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
@@ -19,11 +19,13 @@ import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-img-element"><img></a> element.
+ * DTO for an HTML <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-img-element"><img></a> element.
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * (org.apache.juneau.dto)</a>
* <ul>
* <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
@@ -35,6 +37,7 @@ public class Img extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-img-alt">alt</a> attribute.
* Replacement text for use when images are not available.
+ *
* @param alt The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -44,8 +47,10 @@ public class Img extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-img-crossorigin">crossorigin</a> attribute.
- * How the element handles crossorigin requests.
+ * <a class="doclink"
+ * href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-img-crossorigin">crossorigin</a> attribute.
+ * How the element handles cross-origin requests.
+ *
* @param crossorigin The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -55,8 +60,10 @@ public class Img extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
+ * attribute.
* Vertical dimension.
+ *
* @param height The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -69,6 +76,7 @@ public class Img extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-img-ismap">ismap</a> attribute.
* Whether the image is a server-side image map.
+ *
* @param ismap The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -97,8 +105,10 @@ public class Img extends HtmlElementVoid {
}
/**
- * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-hyperlink-usemap">usemap</a> attribute.
+ * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-hyperlink-usemap">usemap</a>
+ * attribute.
* Name of image map to use.
+ *
* @param usemap The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -110,6 +120,7 @@ public class Img extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
* Horizontal dimension.
+ *
* @param width The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
[23/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
Clean up javadocs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-juneau/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-juneau/commit/5c4762ee
Tree: http://git-wip-us.apache.org/repos/asf/incubator-juneau/tree/5c4762ee
Diff: http://git-wip-us.apache.org/repos/asf/incubator-juneau/diff/5c4762ee
Branch: refs/heads/master
Commit: 5c4762eed631aa3989cdbe0447a99675b2465d73
Parents: 542fb48
Author: JamesBognar <ja...@apache.org>
Authored: Sun Jun 25 20:41:01 2017 -0400
Committer: JamesBognar <ja...@apache.org>
Committed: Sun Jun 25 20:41:01 2017 -0400
----------------------------------------------------------------------
.../java/org/apache/juneau/jena/package.html | 459 -------
.../java/org/apache/juneau/BeanContext.java | 139 ++-
.../org/apache/juneau/BeanDictionaryList.java | 6 +-
.../main/java/org/apache/juneau/BeanMap.java | 21 +-
.../java/org/apache/juneau/BeanMapEntry.java | 3 +-
.../main/java/org/apache/juneau/BeanMeta.java | 19 +-
.../org/apache/juneau/BeanPropertyMeta.java | 7 +-
.../java/org/apache/juneau/BeanRegistry.java | 5 +-
.../java/org/apache/juneau/BeanSession.java | 284 +++--
.../main/java/org/apache/juneau/ClassMeta.java | 71 +-
.../main/java/org/apache/juneau/Context.java | 3 +-
.../org/apache/juneau/CoreObjectBuilder.java | 16 +-
.../juneau/InvalidDataConversionException.java | 9 +-
.../main/java/org/apache/juneau/ObjectList.java | 6 +-
.../main/java/org/apache/juneau/ObjectMap.java | 26 +-
.../java/org/apache/juneau/PropertyStore.java | 242 ++--
.../main/java/org/apache/juneau/Session.java | 2 +-
.../main/java/org/apache/juneau/UriContext.java | 85 +-
.../java/org/apache/juneau/UriResolver.java | 3 +-
.../java/org/apache/juneau/annotation/Bean.java | 34 +-
.../juneau/annotation/BeanConstructor.java | 9 +-
.../apache/juneau/annotation/BeanIgnore.java | 4 +-
.../apache/juneau/annotation/BeanProperty.java | 56 +-
.../org/apache/juneau/annotation/Consumes.java | 10 +-
.../apache/juneau/annotation/NameProperty.java | 6 +-
.../juneau/annotation/ParentProperty.java | 5 +-
.../java/org/apache/juneau/annotation/Pojo.java | 2 +-
.../org/apache/juneau/annotation/Produces.java | 22 +-
.../java/org/apache/juneau/annotation/URI.java | 14 +-
.../java/org/apache/juneau/csv/CsvParser.java | 1 +
.../org/apache/juneau/csv/CsvParserBuilder.java | 1 +
.../org/apache/juneau/csv/CsvParserContext.java | 6 +-
.../org/apache/juneau/csv/CsvSerializer.java | 1 +
.../apache/juneau/csv/CsvSerializerBuilder.java | 1 +
.../apache/juneau/csv/CsvSerializerContext.java | 6 +-
.../apache/juneau/csv/CsvSerializerSession.java | 13 +-
.../main/java/org/apache/juneau/dto/Link.java | 3 +-
.../org/apache/juneau/dto/atom/AtomBuilder.java | 27 +-
.../org/apache/juneau/dto/atom/Category.java | 5 +-
.../java/org/apache/juneau/dto/atom/Common.java | 3 +-
.../org/apache/juneau/dto/atom/CommonEntry.java | 5 +-
.../org/apache/juneau/dto/atom/Content.java | 3 +-
.../java/org/apache/juneau/dto/atom/Entry.java | 3 +-
.../java/org/apache/juneau/dto/atom/Feed.java | 3 +-
.../org/apache/juneau/dto/atom/Generator.java | 3 +-
.../java/org/apache/juneau/dto/atom/Icon.java | 3 +-
.../java/org/apache/juneau/dto/atom/Id.java | 3 +-
.../java/org/apache/juneau/dto/atom/Link.java | 5 +-
.../java/org/apache/juneau/dto/atom/Logo.java | 5 +-
.../java/org/apache/juneau/dto/atom/Person.java | 3 +-
.../java/org/apache/juneau/dto/atom/Source.java | 3 +-
.../java/org/apache/juneau/dto/atom/Text.java | 3 +-
.../java/org/apache/juneau/dto/atom/Utils.java | 3 +-
.../org/apache/juneau/dto/atom/package.html | 15 +-
.../org/apache/juneau/dto/cognos/Column.java | 3 +-
.../org/apache/juneau/dto/cognos/DataSet.java | 8 +-
.../java/org/apache/juneau/dto/html5/A.java | 10 +-
.../java/org/apache/juneau/dto/html5/Abbr.java | 6 +-
.../org/apache/juneau/dto/html5/Address.java | 6 +-
.../java/org/apache/juneau/dto/html5/Area.java | 17 +-
.../org/apache/juneau/dto/html5/Article.java | 6 +-
.../java/org/apache/juneau/dto/html5/Aside.java | 6 +-
.../java/org/apache/juneau/dto/html5/Audio.java | 33 +-
.../java/org/apache/juneau/dto/html5/B.java | 6 +-
.../java/org/apache/juneau/dto/html5/Base.java | 10 +-
.../java/org/apache/juneau/dto/html5/Bdi.java | 6 +-
.../java/org/apache/juneau/dto/html5/Bdo.java | 6 +-
.../org/apache/juneau/dto/html5/Blockquote.java | 12 +-
.../java/org/apache/juneau/dto/html5/Body.java | 36 +-
.../java/org/apache/juneau/dto/html5/Br.java | 6 +-
.../org/apache/juneau/dto/html5/Button.java | 20 +-
.../org/apache/juneau/dto/html5/Canvas.java | 8 +-
.../org/apache/juneau/dto/html5/Caption.java | 6 +-
.../java/org/apache/juneau/dto/html5/Cite.java | 6 +-
.../java/org/apache/juneau/dto/html5/Code.java | 6 +-
.../java/org/apache/juneau/dto/html5/Col.java | 7 +-
.../org/apache/juneau/dto/html5/Colgroup.java | 6 +-
.../java/org/apache/juneau/dto/html5/Data.java | 10 +-
.../org/apache/juneau/dto/html5/Datalist.java | 6 +-
.../java/org/apache/juneau/dto/html5/Dd.java | 6 +-
.../java/org/apache/juneau/dto/html5/Del.java | 8 +-
.../java/org/apache/juneau/dto/html5/Dfn.java | 6 +-
.../java/org/apache/juneau/dto/html5/Div.java | 6 +-
.../java/org/apache/juneau/dto/html5/Dl.java | 6 +-
.../java/org/apache/juneau/dto/html5/Dt.java | 6 +-
.../java/org/apache/juneau/dto/html5/Em.java | 6 +-
.../java/org/apache/juneau/dto/html5/Embed.java | 12 +-
.../org/apache/juneau/dto/html5/Fieldset.java | 9 +-
.../org/apache/juneau/dto/html5/Figcaption.java | 6 +-
.../org/apache/juneau/dto/html5/Figure.java | 6 +-
.../org/apache/juneau/dto/html5/Footer.java | 3 +-
.../java/org/apache/juneau/dto/html5/Form.java | 19 +-
.../java/org/apache/juneau/dto/html5/H1.java | 6 +-
.../java/org/apache/juneau/dto/html5/H2.java | 6 +-
.../java/org/apache/juneau/dto/html5/H3.java | 6 +-
.../java/org/apache/juneau/dto/html5/H4.java | 6 +-
.../java/org/apache/juneau/dto/html5/H5.java | 6 +-
.../java/org/apache/juneau/dto/html5/H6.java | 6 +-
.../java/org/apache/juneau/dto/html5/Head.java | 6 +-
.../org/apache/juneau/dto/html5/Header.java | 6 +-
.../java/org/apache/juneau/dto/html5/Hr.java | 6 +-
.../java/org/apache/juneau/dto/html5/Html.java | 7 +-
.../juneau/dto/html5/HtmlBeanDictionary.java | 3 +-
.../apache/juneau/dto/html5/HtmlBuilder.java | 249 +++-
.../apache/juneau/dto/html5/HtmlElement.java | 118 +-
.../juneau/dto/html5/HtmlElementContainer.java | 12 +-
.../juneau/dto/html5/HtmlElementMixed.java | 12 +-
.../juneau/dto/html5/HtmlElementRawText.java | 6 +-
.../juneau/dto/html5/HtmlElementText.java | 3 +-
.../juneau/dto/html5/HtmlElementVoid.java | 3 +-
.../java/org/apache/juneau/dto/html5/I.java | 6 +-
.../org/apache/juneau/dto/html5/Iframe.java | 20 +-
.../java/org/apache/juneau/dto/html5/Img.java | 23 +-
.../java/org/apache/juneau/dto/html5/Input.java | 52 +-
.../java/org/apache/juneau/dto/html5/Ins.java | 8 +-
.../java/org/apache/juneau/dto/html5/Kbd.java | 6 +-
.../org/apache/juneau/dto/html5/Keygen.java | 12 +-
.../java/org/apache/juneau/dto/html5/Label.java | 8 +-
.../org/apache/juneau/dto/html5/Legend.java | 6 +-
.../java/org/apache/juneau/dto/html5/Li.java | 6 +-
.../java/org/apache/juneau/dto/html5/Link.java | 20 +-
.../java/org/apache/juneau/dto/html5/Main.java | 6 +-
.../java/org/apache/juneau/dto/html5/Map.java | 7 +-
.../java/org/apache/juneau/dto/html5/Mark.java | 6 +-
.../java/org/apache/juneau/dto/html5/Meta.java | 19 +-
.../java/org/apache/juneau/dto/html5/Meter.java | 12 +-
.../java/org/apache/juneau/dto/html5/Nav.java | 6 +-
.../org/apache/juneau/dto/html5/Noscript.java | 6 +-
.../org/apache/juneau/dto/html5/Object2.java | 23 +-
.../java/org/apache/juneau/dto/html5/Ol.java | 14 +-
.../org/apache/juneau/dto/html5/Optgroup.java | 8 +-
.../org/apache/juneau/dto/html5/Option.java | 10 +-
.../org/apache/juneau/dto/html5/Output.java | 9 +-
.../java/org/apache/juneau/dto/html5/P.java | 6 +-
.../java/org/apache/juneau/dto/html5/Param.java | 11 +-
.../java/org/apache/juneau/dto/html5/Pre.java | 6 +-
.../org/apache/juneau/dto/html5/Progress.java | 8 +-
.../java/org/apache/juneau/dto/html5/Q.java | 7 +-
.../java/org/apache/juneau/dto/html5/Rb.java | 6 +-
.../java/org/apache/juneau/dto/html5/Rp.java | 6 +-
.../java/org/apache/juneau/dto/html5/Rt.java | 6 +-
.../java/org/apache/juneau/dto/html5/Rtc.java | 6 +-
.../java/org/apache/juneau/dto/html5/Ruby.java | 6 +-
.../java/org/apache/juneau/dto/html5/S.java | 6 +-
.../java/org/apache/juneau/dto/html5/Samp.java | 6 +-
.../org/apache/juneau/dto/html5/Script.java | 16 +-
.../org/apache/juneau/dto/html5/Section.java | 6 +-
.../org/apache/juneau/dto/html5/Select.java | 13 +-
.../java/org/apache/juneau/dto/html5/Small.java | 6 +-
.../org/apache/juneau/dto/html5/Source.java | 7 +-
.../java/org/apache/juneau/dto/html5/Span.java | 6 +-
.../org/apache/juneau/dto/html5/Strong.java | 6 +-
.../java/org/apache/juneau/dto/html5/Style.java | 8 +-
.../java/org/apache/juneau/dto/html5/Sub.java | 6 +-
.../java/org/apache/juneau/dto/html5/Sup.java | 6 +-
.../java/org/apache/juneau/dto/html5/Table.java | 8 +-
.../java/org/apache/juneau/dto/html5/Tbody.java | 6 +-
.../java/org/apache/juneau/dto/html5/Td.java | 9 +-
.../org/apache/juneau/dto/html5/Template.java | 6 +-
.../org/apache/juneau/dto/html5/Textarea.java | 28 +-
.../java/org/apache/juneau/dto/html5/Tfoot.java | 6 +-
.../java/org/apache/juneau/dto/html5/Th.java | 12 +-
.../java/org/apache/juneau/dto/html5/Thead.java | 6 +-
.../java/org/apache/juneau/dto/html5/Time.java | 10 +-
.../java/org/apache/juneau/dto/html5/Title.java | 6 +-
.../java/org/apache/juneau/dto/html5/Tr.java | 6 +-
.../java/org/apache/juneau/dto/html5/Track.java | 16 +-
.../java/org/apache/juneau/dto/html5/U.java | 6 +-
.../java/org/apache/juneau/dto/html5/Ul.java | 6 +-
.../java/org/apache/juneau/dto/html5/Var.java | 6 +-
.../java/org/apache/juneau/dto/html5/Video.java | 42 +-
.../java/org/apache/juneau/dto/html5/Wbr.java | 6 +-
.../org/apache/juneau/dto/html5/package.html | 41 +-
.../apache/juneau/dto/jsonschema/JsonType.java | 6 +-
.../juneau/dto/jsonschema/JsonTypeArray.java | 6 +-
.../apache/juneau/dto/jsonschema/Schema.java | 111 +-
.../juneau/dto/jsonschema/SchemaArray.java | 9 +-
.../apache/juneau/dto/jsonschema/SchemaMap.java | 11 +-
.../juneau/dto/jsonschema/SchemaProperty.java | 6 +-
.../jsonschema/SchemaPropertySimpleArray.java | 6 +-
.../apache/juneau/dto/jsonschema/SchemaRef.java | 6 +-
.../apache/juneau/dto/jsonschema/package.html | 37 +-
.../org/apache/juneau/dto/swagger/Contact.java | 3 +-
.../dto/swagger/ExternalDocumentation.java | 6 +-
.../apache/juneau/dto/swagger/HeaderInfo.java | 113 +-
.../org/apache/juneau/dto/swagger/Info.java | 12 +-
.../org/apache/juneau/dto/swagger/Items.java | 116 +-
.../org/apache/juneau/dto/swagger/License.java | 3 +-
.../apache/juneau/dto/swagger/Operation.java | 87 +-
.../juneau/dto/swagger/ParameterInfo.java | 202 ++-
.../apache/juneau/dto/swagger/ResponseInfo.java | 15 +-
.../apache/juneau/dto/swagger/SchemaInfo.java | 39 +-
.../juneau/dto/swagger/SecurityScheme.java | 16 +-
.../org/apache/juneau/dto/swagger/Swagger.java | 85 +-
.../juneau/dto/swagger/SwaggerBuilder.java | 64 +-
.../juneau/dto/swagger/SwaggerElement.java | 3 +-
.../java/org/apache/juneau/dto/swagger/Tag.java | 18 +-
.../java/org/apache/juneau/dto/swagger/Xml.java | 38 +-
.../org/apache/juneau/dto/swagger/package.html | 7 +-
.../org/apache/juneau/encoders/Encoder.java | 2 +-
.../apache/juneau/encoders/EncoderGroup.java | 4 +-
.../juneau/encoders/EncoderGroupBuilder.java | 1 +
.../juneau/html/HtmlBeanPropertyMeta.java | 12 +-
.../org/apache/juneau/html/HtmlClassMeta.java | 3 +-
.../apache/juneau/html/HtmlDocSerializer.java | 9 +-
.../juneau/html/HtmlDocSerializerContext.java | 42 +-
.../juneau/html/HtmlDocSerializerSession.java | 38 +-
.../org/apache/juneau/html/HtmlDocTemplate.java | 34 +-
.../juneau/html/HtmlDocTemplateBasic.java | 3 +-
.../java/org/apache/juneau/html/HtmlLink.java | 3 +-
.../java/org/apache/juneau/html/HtmlParser.java | 58 +-
.../apache/juneau/html/HtmlParserContext.java | 6 +-
.../apache/juneau/html/HtmlParserSession.java | 3 +-
.../juneau/html/HtmlSchemaDocSerializer.java | 7 +-
.../org/apache/juneau/html/HtmlSerializer.java | 41 +-
.../juneau/html/HtmlSerializerBuilder.java | 12 +-
.../juneau/html/HtmlSerializerContext.java | 29 +-
.../juneau/html/HtmlSerializerSession.java | 12 +-
.../juneau/html/HtmlStrippedDocSerializer.java | 3 +-
.../java/org/apache/juneau/html/HtmlWriter.java | 3 +-
.../apache/juneau/html/SimpleHtmlWriter.java | 3 +-
.../java/org/apache/juneau/html/package.html | 3 +-
.../java/org/apache/juneau/http/Accept.java | 19 +-
.../org/apache/juneau/http/AcceptCharset.java | 3 +-
.../org/apache/juneau/http/AcceptEncoding.java | 6 +-
.../org/apache/juneau/http/AcceptLanguage.java | 3 +-
.../org/apache/juneau/http/AcceptRanges.java | 3 +-
.../main/java/org/apache/juneau/http/Age.java | 3 +-
.../main/java/org/apache/juneau/http/Allow.java | 3 +-
.../org/apache/juneau/http/Authorization.java | 3 +-
.../org/apache/juneau/http/CacheControl.java | 3 +-
.../java/org/apache/juneau/http/Connection.java | 6 +-
.../java/org/apache/juneau/http/Constants.java | 3 +-
.../org/apache/juneau/http/ContentEncoding.java | 3 +-
.../apache/juneau/http/ContentEncodingEnum.java | 3 +-
.../org/apache/juneau/http/ContentLanguage.java | 3 +-
.../org/apache/juneau/http/ContentLength.java | 3 +-
.../org/apache/juneau/http/ContentLocation.java | 3 +-
.../org/apache/juneau/http/ContentRange.java | 3 +-
.../org/apache/juneau/http/ContentType.java | 9 +-
.../main/java/org/apache/juneau/http/Date.java | 3 +-
.../main/java/org/apache/juneau/http/ETag.java | 3 +-
.../org/apache/juneau/http/EntityValidator.java | 6 +-
.../java/org/apache/juneau/http/Expect.java | 3 +-
.../java/org/apache/juneau/http/Expires.java | 3 +-
.../main/java/org/apache/juneau/http/From.java | 3 +-
.../java/org/apache/juneau/http/HeaderDate.java | 5 +-
.../juneau/http/HeaderEntityValidator.java | 5 +-
.../juneau/http/HeaderEntityValidatorArray.java | 5 +-
.../java/org/apache/juneau/http/HeaderEnum.java | 4 +-
.../org/apache/juneau/http/HeaderInteger.java | 4 +-
.../apache/juneau/http/HeaderRangeArray.java | 4 +-
.../org/apache/juneau/http/HeaderString.java | 4 +-
.../apache/juneau/http/HeaderStringArray.java | 4 +-
.../java/org/apache/juneau/http/HeaderUri.java | 5 +-
.../main/java/org/apache/juneau/http/Host.java | 3 +-
.../java/org/apache/juneau/http/HttpMethod.java | 3 +-
.../java/org/apache/juneau/http/IfMatch.java | 3 +-
.../org/apache/juneau/http/IfModifiedSince.java | 3 +-
.../org/apache/juneau/http/IfNoneMatch.java | 3 +-
.../java/org/apache/juneau/http/IfRange.java | 5 +-
.../apache/juneau/http/IfUnmodifiedSince.java | 3 +-
.../org/apache/juneau/http/LastModified.java | 3 +-
.../java/org/apache/juneau/http/Location.java | 3 +-
.../org/apache/juneau/http/MaxForwards.java | 3 +-
.../java/org/apache/juneau/http/MediaType.java | 7 +-
.../org/apache/juneau/http/MediaTypeRange.java | 35 +-
.../java/org/apache/juneau/http/Pragma.java | 3 +-
.../apache/juneau/http/ProxyAuthenticate.java | 3 +-
.../apache/juneau/http/ProxyAuthorization.java | 3 +-
.../main/java/org/apache/juneau/http/Range.java | 7 +-
.../java/org/apache/juneau/http/Referer.java | 3 +-
.../java/org/apache/juneau/http/RetryAfter.java | 5 +-
.../java/org/apache/juneau/http/Server.java | 5 +-
.../org/apache/juneau/http/StringRange.java | 26 +-
.../main/java/org/apache/juneau/http/TE.java | 6 +-
.../java/org/apache/juneau/http/Trailer.java | 3 +-
.../apache/juneau/http/TransferEncoding.java | 3 +-
.../java/org/apache/juneau/http/Upgrade.java | 3 +-
.../java/org/apache/juneau/http/UserAgent.java | 5 +-
.../main/java/org/apache/juneau/http/Vary.java | 6 +-
.../main/java/org/apache/juneau/http/Via.java | 3 +-
.../java/org/apache/juneau/http/Warning.java | 3 +-
.../org/apache/juneau/http/WwwAuthenticate.java | 3 +-
.../java/org/apache/juneau/ini/ConfigFile.java | 187 +--
.../apache/juneau/ini/ConfigFileBuilder.java | 27 +-
.../org/apache/juneau/ini/ConfigFileFormat.java | 1 +
.../org/apache/juneau/ini/ConfigFileImpl.java | 15 +-
.../apache/juneau/ini/ConfigFileWrapped.java | 3 +-
.../java/org/apache/juneau/ini/Section.java | 3 +
.../java/org/apache/juneau/ini/XorEncoder.java | 3 +-
.../java/org/apache/juneau/ini/package.html | 82 +-
.../org/apache/juneau/internal/ArrayUtils.java | 32 +-
.../apache/juneau/internal/ByteArrayCache.java | 4 +-
.../org/apache/juneau/internal/ClassUtils.java | 39 +-
.../org/apache/juneau/internal/DateUtils.java | 22 +-
.../apache/juneau/internal/DelegateBeanMap.java | 8 +-
.../apache/juneau/internal/DelegateList.java | 4 +-
.../org/apache/juneau/internal/DelegateMap.java | 3 +-
.../org/apache/juneau/internal/FileUtils.java | 7 +-
.../org/apache/juneau/internal/IOUtils.java | 7 +-
.../apache/juneau/internal/JuneauLogger.java | 12 +-
.../org/apache/juneau/internal/MultiSet.java | 3 +-
.../java/org/apache/juneau/internal/Pair.java | 3 +
.../apache/juneau/internal/ReflectionUtils.java | 11 +-
.../org/apache/juneau/internal/SimpleMap.java | 4 +-
.../juneau/internal/StringBuilderWriter.java | 3 +-
.../org/apache/juneau/internal/StringUtils.java | 31 +-
.../apache/juneau/internal/TeeOutputStream.java | 12 +-
.../org/apache/juneau/internal/TeeWriter.java | 12 +-
.../java/org/apache/juneau/internal/Utils.java | 10 +-
.../org/apache/juneau/internal/Version.java | 14 +-
.../org/apache/juneau/internal/WrappedMap.java | 1 +
.../java/org/apache/juneau/jso/JsoParser.java | 1 +
.../org/apache/juneau/jso/JsoParserBuilder.java | 1 +
.../org/apache/juneau/jso/JsoSerializer.java | 1 +
.../apache/juneau/jso/JsoSerializerBuilder.java | 1 +
.../org/apache/juneau/json/JsonClassMeta.java | 3 +-
.../java/org/apache/juneau/json/JsonParser.java | 85 +-
.../apache/juneau/json/JsonParserBuilder.java | 1 +
.../apache/juneau/json/JsonParserContext.java | 6 +-
.../apache/juneau/json/JsonParserSession.java | 3 +-
.../juneau/json/JsonSchemaSerializer.java | 11 +-
.../json/JsonSchemaSerializerBuilder.java | 1 +
.../org/apache/juneau/json/JsonSerializer.java | 39 +-
.../juneau/json/JsonSerializerBuilder.java | 5 +-
.../juneau/json/JsonSerializerContext.java | 20 +-
.../juneau/json/JsonSerializerSession.java | 16 +-
.../java/org/apache/juneau/json/JsonWriter.java | 6 +-
.../java/org/apache/juneau/json/package.html | 603 ++-------
.../juneau/msgpack/MsgPackInputStream.java | 33 +-
.../juneau/msgpack/MsgPackOutputStream.java | 27 +-
.../apache/juneau/msgpack/MsgPackParser.java | 22 +-
.../juneau/msgpack/MsgPackParserBuilder.java | 1 +
.../juneau/msgpack/MsgPackParserContext.java | 6 +-
.../juneau/msgpack/MsgPackParserSession.java | 3 +-
.../juneau/msgpack/MsgPackSerializer.java | 20 +-
.../msgpack/MsgPackSerializerBuilder.java | 1 +
.../msgpack/MsgPackSerializerContext.java | 16 +-
.../msgpack/MsgPackSerializerSession.java | 13 +-
.../main/java/org/apache/juneau/package.html | 65 +-
.../apache/juneau/parser/InputStreamParser.java | 1 +
.../java/org/apache/juneau/parser/Parser.java | 248 ++--
.../org/apache/juneau/parser/ParserBuilder.java | 4 +-
.../org/apache/juneau/parser/ParserContext.java | 3 +-
.../org/apache/juneau/parser/ParserGroup.java | 4 +-
.../juneau/parser/ParserGroupBuilder.java | 1 +
.../apache/juneau/parser/ParserListener.java | 19 +-
.../org/apache/juneau/parser/ParserReader.java | 12 +-
.../org/apache/juneau/parser/ParserSession.java | 51 +-
.../org/apache/juneau/parser/ReaderParser.java | 1 +
.../java/org/apache/juneau/parser/package.html | 22 +-
.../juneau/plaintext/PlainTextParser.java | 9 +-
.../plaintext/PlainTextParserBuilder.java | 1 +
.../juneau/plaintext/PlainTextSerializer.java | 4 +-
.../plaintext/PlainTextSerializerBuilder.java | 1 +
.../java/org/apache/juneau/remoteable/Body.java | 11 +-
.../org/apache/juneau/remoteable/FormData.java | 23 +-
.../apache/juneau/remoteable/FormDataIfNE.java | 7 +-
.../org/apache/juneau/remoteable/Header.java | 22 +-
.../apache/juneau/remoteable/HeaderIfNE.java | 7 +-
.../java/org/apache/juneau/remoteable/Path.java | 15 +-
.../org/apache/juneau/remoteable/Query.java | 21 +-
.../org/apache/juneau/remoteable/QueryIfNE.java | 7 +-
.../apache/juneau/remoteable/RemoteMethod.java | 22 +-
.../juneau/remoteable/RemoteMethodArg.java | 9 +-
.../apache/juneau/remoteable/Remoteable.java | 12 +-
.../juneau/remoteable/RemoteableMeta.java | 3 +-
.../juneau/remoteable/RemoteableMethodMeta.java | 25 +-
.../apache/juneau/remoteable/RequestBean.java | 5 +-
.../serializer/OutputStreamSerializer.java | 5 +-
.../apache/juneau/serializer/Serializer.java | 113 +-
.../juneau/serializer/SerializerBuilder.java | 14 +-
.../juneau/serializer/SerializerContext.java | 8 +-
.../juneau/serializer/SerializerGroup.java | 9 +-
.../serializer/SerializerGroupBuilder.java | 5 +-
.../juneau/serializer/SerializerListener.java | 4 +-
.../juneau/serializer/SerializerSession.java | 89 +-
.../juneau/serializer/SerializerWriter.java | 19 +-
.../juneau/serializer/WriterSerializer.java | 3 +-
.../org/apache/juneau/serializer/package.html | 34 +-
.../apache/juneau/soap/SoapXmlSerializer.java | 1 +
.../juneau/soap/SoapXmlSerializerBuilder.java | 1 +
.../juneau/soap/SoapXmlSerializerContext.java | 7 +-
.../org/apache/juneau/svl/DefaultingVar.java | 4 +-
.../java/org/apache/juneau/svl/SimpleVar.java | 7 +-
.../java/org/apache/juneau/svl/StreamedVar.java | 4 +-
.../main/java/org/apache/juneau/svl/Var.java | 16 +-
.../java/org/apache/juneau/svl/VarResolver.java | 45 +-
.../apache/juneau/svl/VarResolverBuilder.java | 8 +-
.../apache/juneau/svl/VarResolverContext.java | 1 +
.../apache/juneau/svl/VarResolverSession.java | 18 +-
.../java/org/apache/juneau/svl/package.html | 109 +-
.../org/apache/juneau/svl/vars/ArgsVar.java | 5 +-
.../apache/juneau/svl/vars/ConfigFileVar.java | 5 +-
.../java/org/apache/juneau/svl/vars/IfVar.java | 7 +-
.../apache/juneau/svl/vars/ManifestFileVar.java | 5 +-
.../org/apache/juneau/svl/vars/SwitchVar.java | 3 +-
.../transform/AnnotationBeanFilterBuilder.java | 3 +-
.../org/apache/juneau/transform/BeanFilter.java | 22 +-
.../juneau/transform/BeanFilterBuilder.java | 11 +-
.../transform/InterfaceBeanFilterBuilder.java | 8 +-
.../org/apache/juneau/transform/PojoSwap.java | 75 +-
.../apache/juneau/transform/SurrogateSwap.java | 29 +-
.../org/apache/juneau/transform/package.html | 121 +-
.../juneau/transforms/BeanStringSwap.java | 6 +-
.../apache/juneau/transforms/CalendarSwap.java | 14 +-
.../org/apache/juneau/transforms/DateSwap.java | 10 +-
.../apache/juneau/transforms/ReaderSwap.java | 10 +-
.../juneau/transforms/StringFormatSwap.java | 1 +
.../org/apache/juneau/transforms/package.html | 3 +-
.../java/org/apache/juneau/uon/UonParser.java | 47 +-
.../org/apache/juneau/uon/UonParserBuilder.java | 5 +-
.../org/apache/juneau/uon/UonParserContext.java | 10 +-
.../org/apache/juneau/uon/UonParserSession.java | 22 +-
.../org/apache/juneau/uon/UonSerializer.java | 21 +-
.../apache/juneau/uon/UonSerializerBuilder.java | 5 +-
.../apache/juneau/uon/UonSerializerContext.java | 40 +-
.../apache/juneau/uon/UonSerializerSession.java | 14 +-
.../java/org/apache/juneau/uon/UonUtils.java | 3 +-
.../java/org/apache/juneau/uon/UonWriter.java | 5 +-
.../java/org/apache/juneau/uon/package.html | 654 +++-------
.../urlencoding/annotation/UrlEncoding.java | 6 +-
.../org/apache/juneau/urlencoding/package.html | 662 +++-------
.../main/java/org/apache/juneau/utils/AMap.java | 3 +-
.../main/java/org/apache/juneau/utils/Args.java | 8 +-
.../java/org/apache/juneau/utils/IOPipe.java | 2 +-
.../org/apache/juneau/utils/ManifestFile.java | 4 +-
.../org/apache/juneau/utils/MessageBundle.java | 28 +-
.../org/apache/juneau/utils/MetadataMap.java | 3 +-
.../org/apache/juneau/utils/ObjectUtils.java | 250 ++--
.../apache/juneau/utils/PojoIntrospector.java | 51 +-
.../java/org/apache/juneau/utils/PojoQuery.java | 70 +-
.../java/org/apache/juneau/utils/PojoRest.java | 57 +-
.../apache/juneau/utils/PojoRestException.java | 9 +-
.../org/apache/juneau/utils/ProcBuilder.java | 4 +-
.../org/apache/juneau/utils/SearchArgs.java | 17 +-
.../org/apache/juneau/utils/StringObject.java | 2 +
.../org/apache/juneau/utils/ZipFileList.java | 9 +-
.../java/org/apache/juneau/xml/Namespace.java | 8 +-
.../org/apache/juneau/xml/NamespaceFactory.java | 6 +-
.../java/org/apache/juneau/xml/XmlBeanMeta.java | 6 +-
.../apache/juneau/xml/XmlBeanPropertyMeta.java | 12 +-
.../org/apache/juneau/xml/XmlClassMeta.java | 9 +-
.../org/apache/juneau/xml/XmlDocSerializer.java | 6 +-
.../java/org/apache/juneau/xml/XmlParser.java | 17 +-
.../org/apache/juneau/xml/XmlParserBuilder.java | 13 +-
.../org/apache/juneau/xml/XmlParserContext.java | 12 +-
.../org/apache/juneau/xml/XmlParserSession.java | 21 +-
.../juneau/xml/XmlSchemaDocSerializer.java | 5 +-
.../apache/juneau/xml/XmlSchemaSerializer.java | 5 +-
.../juneau/xml/XmlSchemaSerializerBuilder.java | 1 +
.../org/apache/juneau/xml/XmlSerializer.java | 30 +-
.../apache/juneau/xml/XmlSerializerBuilder.java | 22 +-
.../apache/juneau/xml/XmlSerializerContext.java | 30 +-
.../apache/juneau/xml/XmlSerializerSession.java | 16 +-
.../java/org/apache/juneau/xml/XmlUtils.java | 25 +-
.../java/org/apache/juneau/xml/XmlWriter.java | 10 +-
.../org/apache/juneau/xml/annotation/Xml.java | 9 +-
.../apache/juneau/xml/annotation/XmlFormat.java | 10 +-
.../apache/juneau/xml/annotation/XmlSchema.java | 16 +-
.../java/org/apache/juneau/xml/package.html | 874 +++++--------
juneau-core/src/main/javadoc/overview.html | 1157 ++++++++++++------
.../eclipse-preferences/user-dictionary.txt | 342 ++++++
464 files changed, 6850 insertions(+), 5683 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core-rdf/src/main/java/org/apache/juneau/jena/package.html
----------------------------------------------------------------------
diff --git a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/package.html b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/package.html
index c81d3fd..2808bd4 100644
--- a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/package.html
+++ b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/package.html
@@ -79,17 +79,6 @@
<li><p><a class='doclink' href='#ParserConfigurableProperties'>Configurable properties</a></p>
<li><p><a class='doclink' href='#ParserOtherNotes'>Other notes</a></p>
</ol>
- <li><p><a class='doclink' href='#RestApiSupport'>REST API support</a></p>
- <ol>
- <li><p><a class='doclink' href='#RestServerSupport'>REST server support</a></p>
- <ol>
- <li><p><a class='doclink' href='#RestServletJenaDefault'>Using RestServletJenaDefault</a></p>
- <li><p><a class='doclink' href='#RestServlet'>Using RestServlet with annotations</a></p>
- <li><p><a class='doclink' href='#DefaultJenaProvider'>Using JAX-RS DefaultJenaProvider</a></p>
- <li><p><a class='doclink' href='#BaseProvider'>Using JAX-RS BaseProvider with annotations</a></p>
- </ol>
- <li><p><a class='doclink' href='#RestClientSupport'>REST client support</a></p>
- </ol>
</ol>
@@ -1005,454 +994,6 @@
</div>
-
-<!-- ======================================================================================================== -->
-<a id="RestApiSupport"></a>
-<h2 class='topic' onclick='toggle(this)'>4 - REST API support</h2>
-<div class='topic'>
- <p>
- Juneau provides fully-integrated support for RDF serialization/parsing in the REST server and client APIs.
- </p>
- <p>
- The next two sections describe these in detail.
- </p>
-
- <!-- ======================================================================================================== -->
- <a id="RestServerSupport"></a>
- <h3 class='topic' onclick='toggle(this)'>4.1 - REST server support</h3>
- <div class='topic'>
- <p>
- There are four general ways of defining REST interfaces with support for RDF media types.<br>
- Two using the built-in Juneau Server API, and two using the JAX-RS integration component.
- </p>
- <ul class='spaced-list'>
- <li>Create a servlet that subclasses from {@link org.apache.juneau.rest.jena.RestServletJenaDefault}.<br>
- This includes serialization and parsing for all Jena supported types, including all supported flavors of RDF.
- <li>Create a servlet that subclasses from {@link org.apache.juneau.rest.RestServlet} and specify the
- RDF serializers and parsers using the {@link org.apache.juneau.rest.annotation.RestResource#serializers()} and
- {@link org.apache.juneau.rest.annotation.RestResource#parsers()} on the entire servlet class, or
- the {@link org.apache.juneau.rest.annotation.RestMethod#serializers()} and {@link org.apache.juneau.rest.annotation.RestMethod#parsers()}
- annotations on individual methods within the class.
- <li>Register {@link org.apache.juneau.rest.jaxrs.rdf.DefaultJenaProvider} with JAX-RS to provide support RDF support for all JAX-RS resource.<br>
- This includes serialization and parsing for all Juneau supported types (JSON, XML, HTML...), including all supported flavors of RDF.
- <li>Create and register a subclass of {@link org.apache.juneau.rest.jaxrs.BaseProvider} and specify the serializers and parsers to use on JAX-RS resources.
- </ul>
- <p>
- In general, the Juneau REST server API is much more configurable and easier to use than JAX-RS, but beware that the author may be slightly biased in this statement.
- </p>
-
- <!-- ======================================================================================================== -->
- <a id="RestServletJenaDefault"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.1 - Using RestServletJenaDefault</h4>
- <div class='topic'>
- <p>
- The quickest way to implement a REST resource with RDF support is to create a subclass of {@link org.apache.juneau.rest.jena.RestServletJenaDefault}.<br>
- This class provides support for all the RDF flavors in addition to JSON, XML, HTML, and URL-Encoding.
- </p>
- <p>
- The reason why RDF support was not added to {@link org.apache.juneau.rest.RestServletDefault} directly was to keep the Jena prerequisites
- out of the <code>org.apache.juneau.rest</code> package.
- </p>
- <p>
- The <code>AddressBookResource</code> example shown in the first chapter uses the <code>RestServletJenaDefault</code> class.<br>
- The start of the class definition is shown below:
- </p>
- <p class='bcode'>
- <jc>// Proof-of-concept resource that shows off the capabilities of working with POJO resources.
- // Consists of an in-memory address book repository.</jc>
- <ja>@RestResource</ja>(
- messages=<js>"nls/AddressBookResource"</js>,
- title=<js>"$L{title}"</js>,
- description=<js>"$L{description}"</js>,
- htmldoc=<ja>@HtmlDoc</ja>(
- links=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js>
- ),
- properties={
- <ja>@Property</ja>(name=RdfProperties.<jsf>RDF_rdfxml_tab</jsf>, value=<js>"3"</js>),
- <ja>@Property</ja>(name=RdfSerializerContext.<jsf>RDF_addRootProperty</jsf>, value=<js>"true"</js>),
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>),
- <ja>@Property</ja>(name=HtmlSerializerContext.<jsf>HTML_uriAnchorText</jsf>, value=<jsf>TO_STRING</jsf>)
- },
- encoders=GzipEncoder.<jk>class</jk>
- )
- <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
- </p>
- <p>
- Notice how serializer and parser properties can be specified using the <code>@RestResource.properties()</code> annotation.<br>
- The <jsf>RDF_rdfxml_tab</jsf> and <jsf>RDF_addRootProperty</jsf> are properties on the RDF serializers.<br>
- The <jsf>SERIALIZER_quoteChar</jsf> property is common to all serializers.<br>
- The remaining properties are specific to the HTML serializer.
- </p>
- <p>
- The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the <code>messages</code> annotation.
- These variables are replaced at runtime based on the HTTP request locale.
- Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.
- See {@link org.apache.juneau.rest.RestContext#getVarResolver()} for more information.
- </p>
- <p>
- This document won't go into all the details of the Juneau <code>RestServlet</code> class.<br>
- Refer to the <a class='doclink' href='../rest/package-summary.html#TOC'>org.apache.juneau.rest</a> documentation for more information on the REST servlet class in general.
- </p>
- <p>
- The rest of the code in the resource class consists of REST methods that simply accept and return POJOs.<br>
- The framework takes care of all content negotiation, serialization/parsing, and error handling.<br>
- Below are 3 of those methods to give you a general idea of the concept:
- </p>
- <p class='bcode'>
- <jc>// GET person request handler</jc>
- <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/people/{id}/*"</js>, rc={200,404})
- <jk>public</jk> Person getPerson(RestRequest req, RestResponse res, <ja>@Path</ja> <jk>int</jk> id) throws Exception {
- res.setPageTitle(req.getPathInfo());
- <jk>return</jk> findPerson(id);
- }
-
- <jc>// POST person handler</jc>
- <ja>@RestMethod</ja>(name=<js>"POST"</js>, path=<js>"/people"</js>, guards=AdminGuard.<jk>class</jk>, rc={307,404})
- <jk>public void</jk> createPerson(RestResponse res, <ja>@Body</ja> CreatePerson cp) <jk>throws</jk> Exception {
- Person p = addressBook.createPerson(cp);
- res.sendRedirect(p.<jf>uri</jf>);
- }
-
- <jc>// DELETE person handler</jc>
- <ja>@RestMethod</ja>(name=<js>"DELETE"</js>, path=<js>"/people/{id}"</js>, guards=AdminGuard.<jk>class</jk>, rc={200,404})
- <jk>public</jk> String deletePerson(RestResponse res, <ja>@Path</ja> <jk>int</jk> id) <jk>throws</jk> Exception {
- Person p = findPerson(id);
- addressBook.remove(p);
- <jk>return</jk> <js>"DELETE successful"</js>;
- }
- </p>
- <p>
- The resource class can be registered with the web application like any other servlet, or can be
- defined as a child of another resource through the {@link org.apache.juneau.rest.annotation.RestResource#children()} annotation.
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="RestServlet"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.2 - Using RestServlet with annotations</h4>
- <div class='topic'>
- <p>
- For fine-tuned control of media types, the {@link org.apache.juneau.rest.RestServlet} class
- can be subclassed directly.<br>
- The serializers/parsers can be specified through annotations at the class and/or method levels.
- </p>
- <p>
- An equivalent <code>AddressBookResource</code> class could be defined to only support RDF/XML using
- the following definition:
- </p>
- <p class='bcode'>
- <ja>@RestResource</ja>(
- serializers={RdfSerializer.XmlAbbrev.<jk>class</jk>},
- parsers={RdfParser.Xml.<jk>class</jk>},
- properties={
- <ja>@Property</ja>(name=RdfProperties.<jsf>RDF_rdfxml_tab</jsf>, value=<js>"3"</js>),
- <ja>@Property</ja>(name=RdfSerializerContext.<jsf>RDF_addRootProperty</jsf>, value=<js>"true"</js>),
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServlet {
- </p>
- <p>
- Likewise, serializers and parsers can be specified/augmented/overridden at the method level like so:
- </p>
- <p class='bcode'>
- <jc>// GET person request handler</jc>
- <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/people/{id}/*"</js>, rc={200,404},
- serializers={RdfSerializer.XmlAbbrev.<jk>class</jk>},
- parsers={RdfParser.Xml.<jk>class</jk>},
- properties={
- <ja>@Property</ja>(name=RdfProperties.<jsf>RDF_rdfxml_tab</jsf>, value=<js>"3"</js>),
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public</jk> Person getPerson(RestRequest req, RestResponse res, <ja>@Path</ja> <jk>int</jk> id) throws Exception {
- res.setPageTitle(req.getPathInfo());
- <jk>return</jk> findPerson(id);
- }
- </p>
- <p>
- The {@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit()} and
- {@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit()} control how various artifacts
- are inherited from the parent class.<br>
- Refer to <a class='doclink' href='../rest/package-summary.html#TOC'>org.apache.juneau.rest</a> for additional information on using these annotations.
- </p>
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="DefaultJenaProvider"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.3 - Using JAX-RS DefaultJenaProvider</h4>
- <div class='topic'>
- <p>
- RDF media type support in JAX-RS can be achieved by using the {@link org.apache.juneau.rest.jaxrs.rdf.DefaultJenaProvider} class.<br>
- It implements the JAX-RS <code>MessageBodyReader</code> and <code>MessageBodyWriter</code> interfaces for all Juneau supported media types.
- </p>
- <p>
- The <code>DefaultJenaProvider</code> class definition is shown below:
- </p>
- <p class='bcode'>
- <ja>@Provider</ja>
- <ja>@Produces</ja>(
- <js>"application/json,text/json,"</js>+ <jc>// JsonSerializer</jc>
- <js>"application/json+simple,text/json+simple,"</js>+ <jc>// JsonSerializer.Simple</jc>
- <js>"application/json+schema,text/json+schema,"</js>+ <jc>// JsonSchemaSerializer</jc>
- <js>"text/xml,"</js>+ <jc>// XmlDocSerializer</jc>
- <js>"text/xml+simple,"</js>+ <jc>// XmlDocSerializer.Simple</jc>
- <js>"text/xml+schema,"</js>+ <jc>// XmlSchemaDocSerializer</jc>
- <js>"text/html,"</js>+ <jc>// HtmlDocSerializer</jc>
- <js>"application/x-www-form-urlencoded,"</js>+ <jc>// UrlEncodingSerializer</jc>
- <js>"text/xml+soap,"</js>+ <jc>// SoapXmlSerializer</jc>
- <js>"text/xml+rdf,"</js>+ <jc>// RdfSerializer.Xml</jc>
- <js>"text/xml+rdf+abbrev,"</js>+ <jc>// RdfSerializer.XmlAbbrev</jc>
- <js>"text/n-triple,"</js>+ <jc>// RdfSerializer.NTriple</jc>
- <js>"text/turtle,"</js>+ <jc>// RdfSerializer.Turtle</jc>
- <js>"text/n3,"</js>+ <jc>// RdfSerializer.N3</jc>
- <js>"application/x-java-serialized-object"</js> <jc>// JavaSerializedObjectSerializer</jc>
- )
- <ja>@Consumes</ja>(
- <js>"application/json,text/json,"</js>+ <jc>// JsonParser</jc>
- <js>"text/xml,"</js>+ <jc>// XmlParser</jc>
- <js>"text/html,"</js>+ <jc>// HtmlParser</jc>
- <js>"application/x-www-form-urlencoded,"</js>+ <jc>// UrlEncodingParser</jc>
- <js>"text/xml+rdf,"</js>+ <jc>// RdfParser.Xml</jc>
- <js>"text/n-triple,"</js>+ <jc>// RdfParser.NTriple</jc>
- <js>"text/turtle,"</js>+ <jc>// RdfParser.Turtle</jc>
- <js>"text/n3,"</js>+ <jc>// RdfParser.N3</jc>
- <js>"application/x-java-serialized-object"</js> <jc>// JavaSerializedObjectParser</jc>
- )
- <ja>@JuneauProvider</ja>(
- serializers={
- JsonSerializer.<jk>class</jk>,
- JsonSerializer.Simple.<jk>class</jk>,
- JsonSchemaSerializer.<jk>class</jk>,
- XmlDocSerializer.<jk>class</jk>,
- XmlDocSerializer.Simple.<jk>class</jk>,
- XmlSchemaDocSerializer.<jk>class</jk>,
- HtmlDocSerializer.<jk>class</jk>,
- UrlEncodingSerializer.<jk>class</jk>,
- SoapXmlSerializer.<jk>class</jk>,
- RdfSerializer.Xml.<jk>class</jk>,
- RdfSerializer.XmlAbbrev.<jk>class</jk>,
- RdfSerializer.NTriple.<jk>class</jk>,
- RdfSerializer.Turtle.<jk>class</jk>,
- RdfSerializer.N3.<jk>class</jk>,
- JavaSerializedObjectSerializer.<jk>class</jk>
- },
- parsers={
- JsonParser.<jk>class</jk>,
- XmlParser.<jk>class</jk>,
- HtmlParser.<jk>class</jk>,
- UrlEncodingParser.<jk>class</jk>,
- RdfParser.Xml.<jk>class</jk>,
- RdfParser.NTriple.<jk>class</jk>,
- RdfParser.Turtle.<jk>class</jk>,
- RdfParser.N3.<jk>class</jk>,
- JavaSerializedObjectParser.<jk>class</jk>,
- }
- )
- <jk>public final class</jk> DefaultJenaProvider <jk>extends</jk> BaseProvider {}
- </p>
- <p>
- That's the entire class. It consists of only annotations to hook up media types to Juneau serializers and parsers.<br>
- The <ja>@Provider</ja>, <ja>@Produces</ja>, and <ja>@Consumes</ja> annotations are standard JAX-RS annotations, and the <ja>@JuneauProvider</ja> annotation is from Juneau.
- </p>
- <p>
- To enable the provider, you need to make the JAX-RS environment aware of it.<br>
- In Wink, this is accomplished by adding an entry to a config file.
- </p>
- <p class='bcode'>
- <xt><web-app</xt> <xa>version</xa>=<xs>"2.3"</xs><xt>></xt>
- <xt><servlet></xt>
- <xt><servlet-name></xt>WinkService<xt></servlet-name></xt>
- <xt><servlet-class></xt>org.apache.wink.server.internal.servlet.RestServlet<xt></servlet-class></xt>
- <xt><init-param></xt>
- <xt><param-name></xt>applicationConfigLocation<xt></param-name></xt>
- <xt><param-value></xt>/WEB-INF/wink.cfg<xt></param-value></xt>
- <xt></init-param></xt>
- <xt></servlet></xt>
- </p>
- <p>
- Simply include a reference to the provider in the configuration file.
- <p class='bcode'>
- org.apache.juneau.rest.jaxrs.DefaultJenaProvider
- </p>
- <p>
- Properties can be specified on providers through the {@link org.apache.juneau.rest.jaxrs.JuneauProvider#properties()} annotation.
- </p>
- <p>
- Properties can also be specified at the method level by using the {@link org.apache.juneau.rest.annotation.RestMethod#properties} annotation, like so:
- </p>
- <p class='bcode'>
- <ja>@GET</ja>
- <ja>@Produces</ja>(<js>"*/*"</js>)
- <ja>@RestMethod</ja>( <jc>/* Override some properties */</jc>
- properties={
- <ja>@Property</ja>(name=RdfProperties.<jsf>RDF_rdfxml_tab</jsf>, value=<js>"3"</js>),
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public</jk> Message getMessage() {
- <jk>return</jk> message;
- }
- </p>
- <h6 class='topic'>Limitations</h6>
- <p>
- In general, the Juneau REST API is considerably more flexible than the JAX-RS API, since you can specify and override
- serializers, parsers, properties, transforms, converters, guards, etc... at both the class and method levels.<br>
- Therefore, the JAX-RS API has the following limitations that the Juneau Server API does not:
- </p>
- <ul class='spaced-list'>
- <li>The ability to specify different media type providers at the class and method levels.<br>
- For example, you may want to use <code>RdfSerializer.Xml</code> with one set of properties on
- one class, and another instance with different properties on another class.<br>
- There is currently no way to define this at the class level.<br>
- You can override properties at the method level, but this can be cumbersome since it would have to be
- done for all methods in the resource.
- <li>The Juneau Server API allows you to manipulate properties programatically through the {@link org.apache.juneau.rest.RestResponse#setProperty(String,Object)}
- method, and through the {@link org.apache.juneau.rest.annotation.Properties} annotation.<br>
- There is no equivalent in JAX-RS.
- </ul>
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="BaseProvider"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.4 - Using JAX-RS BaseProvider with annotations</h4>
- <div class='topic'>
- <p>
- To provide support for only RDF media types, you can define your own provider class, like so:
- </p>
- <p class='bcode'>
- <ja>@Provider</ja>
- <ja>@Produces</ja>(
- <js>"text/xml+rdf,"</js>+ <jc>// RdfSerializer.Xml</jc>
- <js>"text/xml+rdf+abbrev,"</js>+ <jc>// RdfSerializer.XmlAbbrev</jc>
- <js>"text/n-triple,"</js>+ <jc>// RdfSerializer.NTriple</jc>
- <js>"text/turtle,"</js>+ <jc>// RdfSerializer.Turtle</jc>
- <js>"text/n3"</js>+ <jc>// RdfSerializer.N3</jc>
- )
- <ja>@Consumes</ja>(
- <js>"text/xml+rdf,"</js>+ <jc>// RdfParser.Xml</jc>
- <js>"text/n-triple,"</js>+ <jc>// RdfParser.NTriple</jc>
- <js>"text/turtle,"</js>+ <jc>// RdfParser.Turtle</jc>
- <js>"text/n3"</js> <jc>// RdfParser.N3</jc>
- )
- <ja>@JuneauProvider</ja>(
- serializers={
- RdfSerializer.Xml.<jk>class</jk>,
- RdfSerializer.XmlAbbrev.<jk>class</jk>,
- RdfSerializer.NTriple.<jk>class</jk>,
- RdfSerializer.Turtle.<jk>class</jk>,
- RdfSerializer.N3.<jk>class</jk>,
- },
- parsers={
- RdfParser.Xml.<jk>class</jk>,
- RdfParser.NTriple.<jk>class</jk>,
- RdfParser.Turtle.<jk>class</jk>,
- RdfParser.N3.<jk>class</jk>,
- },
- properties={
- <ja>@Property</ja>(name=RdfProperties.<jsf>RDF_rdfxml_tab</jsf>, value=<js>"3"</js>),
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_quoteChar</jsf>, value=<js>"'"</js>)
- }
- )
- <jk>public final class</jk> MyRdfProvider <jk>extends</jk> BaseProvider {}
- </p>
- <p>
- Then register it with Wink the same way as <code>DefaultJenaProvider</code>.
- </p>
- </div>
-
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="RestClientSupport"></a>
- <h3 class='topic' onclick='toggle(this)'>4.2 - REST client support</h3>
- <div class='topic'>
- <p>
- The {@link org.apache.juneau.rest.client.RestClient} class provides an easy-to-use REST client interface with
- pluggable media type handling using any of the Juneau serializers and parsers.
- </p>
- <p>
- Defining a client to support RDF media types on HTTP requests and responses can be done in one line of code:
- </p>
- <p class='bcode'>
- <jc>// Create a client to handle RDF/XML requests and responses.</jc>
- RestClient client = <jk>new</jk> RestClientBuilder(RdfSerializer.XmlAbbrev.<jk>class</jk>, RdfParser.Xml.<jk>class</jk>).build();
- </p>
- <p>
- The client handles all content negotiation based on the registered serializers and parsers.
- </p>
- <p>
- The following code is pulled from the main method of the <code>ClientTest</code> class in the sample web application, and
- is run against the <code>AddressBookResource</code> class running within the sample app.
- It shows how the client can be used to interact with the REST API while completely hiding the negotiated content type and working with nothing more than beans.
- </p>
- <p class='bcode'>
- String root = <js>"http://localhost:9080/sample/addressBook"</js>;
-
- <jc>// Get the current contents of the address book</jc>
- AddressBook ab = client.doGet(root).getResponse(AddressBook.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Number of entries = "</js> + ab.size());
-
- <jc>// Delete the existing entries</jc>
- <jk>for</jk> (Person p : ab) {
- String r = client.doDelete(p.<jf>uri</jf>).getResponse(String.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Deleted person "</js> + p.<jf>name</jf> + <js>", response = "</js> + r);
- }
-
- <jc>// Make sure they're gone</jc>
- ab = client.doGet(root).getResponse(AddressBook.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Number of entries = "</js> + ab.size());
-
- <jc>// Add 1st person again</jc>
- CreatePerson cp = <jk>new</jk> CreatePerson(
- <js>"Barack Obama"</js>,
- <jsm>toCalendar</jsm>(<js>"Aug 4, 1961"</js>),
- <jk>new</jk> CreateAddress(<js>"1600 Pennsylvania Ave"</js>, <js>"Washington"</js>, <js>"DC"</js>, 20500, <jk>true</jk>),
- <jk>new</jk> CreateAddress(<js>"5046 S Greenwood Ave"</js>, <js>"Chicago"</js>, <js>"IL"</js>, 60615, <jk>false</jk>)
- );
- Person p = client.doPost(root + <js>"/people"</js>, cp).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created person "</js> + p.<jf>name</jf> + <js>", uri = "</js> + p.<jf>uri</jf>);
-
- <jc>// Add 2nd person again, but add addresses separately</jc>
- cp = <jk>new</jk> CreatePerson(
- <js>"George Walker Bush"</js>,
- toCalendar(<js>"Jul 6, 1946"</js>)
- );
- p = client.doPost(root + <js>"/people"</js>, cp).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created person "</js> + p.<jf>name</jf> + <js>", uri = "</js> + p.<jf>uri</jf>);
-
- <jc>// Add addresses to 2nd person</jc>
- CreateAddress ca = <jk>new</jk> CreateAddress(<js>"43 Prairie Chapel Rd"</js>, <js>"Crawford"</js>, <js>"TX"</js>, 76638, <jk>true</jk>);
- Address a = client.doPost(p.<jf>uri</jf> + <js>"/addresses"</js>, ca).getResponse(Address.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created address "</js> + a.<jf>uri</jf>);
-
- ca = <jk>new</jk> CreateAddress(<js>"1600 Pennsylvania Ave"</js>, <js>"Washington"</js>, <js>"DC"</js>, 20500, <jk>false</jk>);
- a = client.doPost(p.<jf>uri</jf> + "/addresses"</js>, ca).getResponse(Address.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created address "</js> + a.<jf>uri</jf>);
-
- <jc>// Find 1st person, and change name</jc>
- Person[] pp = client.doGet(root + <js>"?q={name:\"'Barack+Obama'\"}"</js>).getResponse(Person[].<jk>class</jk>);
- String r = client.doPut(pp[0].<jf>uri</jf> + <js>"/name"</js>, <js>"Barack Hussein Obama"</js>).getResponse(String.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Changed name, response = "</js> + r);
- p = client.doGet(pp[0].<jf>uri</jf>).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"New name = "</js> + p.<jf>name</jf>);
- </p>
- <p>
- The code above produces the following output.
- </p>
- <p class='bcode'>
- Number of entries = 2
- Deleted person Barack Obama, response = DELETE successful
- Deleted person George Walker Bush, response = DELETE successful
- Number of entries = 0
- Created person Barack Obama, uri = http://localhost:9080/sample/addressBook/people/3
- Created person George Walker Bush, uri = http://localhost:9080/sample/addressBook/people/4
- Created address http://localhost:9080/sample/addressBook/addresses/7
- Created address http://localhost:9080/sample/addressBook/addresses/8
- Changed name, response = PUT successful
- New name = Barack Hussein Obama
- </p>
- </div>
-</div>
<p align="center"><i><b>*** fín ***</b></i></p>
</body>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/BeanContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanContext.java b/juneau-core/src/main/java/org/apache/juneau/BeanContext.java
index b289ea7..5696b49 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanContext.java
@@ -36,10 +36,10 @@ import org.apache.juneau.transform.*;
* This class servers multiple purposes:
* <ul class='spaced-list'>
* <li>Provides the ability to wrap beans inside {@link Map} interfaces.
- * <li>Serves as a repository for metadata on POJOs, such as associated {@link BeanFilter beanFilters}, {@link PropertyNamer property namers}, etc...
- * which are used to tailor how POJOs are serialized and parsed.
+ * <li>Serves as a repository for metadata on POJOs, such as associated {@link BeanFilter beanFilters},
+ * {@link PropertyNamer property namers}, etc... which are used to tailor how POJOs are serialized and parsed.
* <li>Serves as a common utility class for all {@link Serializer Serializers} and {@link Parser Parsers}
- * for serializing and parsing Java beans.
+ * for serializing and parsing Java beans.
* </ul>
* <p>
* All serializer and parser contexts extend from this context.
@@ -48,35 +48,39 @@ import org.apache.juneau.transform.*;
* Bean contexts are created through the {@link PropertyStore#getContext(Class)} method.
* These context objects are read-only, reusable, and thread-safe.
* The {@link PropertyStore} class will typically cache copies of <code>Context</code> objects based on
- * the current settings on the factory.
+ * the current settings on the factory.
* <p>
* Each bean context maintains a cache of {@link ClassMeta} objects that describe information about classes encountered.
* These <code>ClassMeta</code> objects are time-consuming to construct.
* Therefore, instances of {@link BeanContext} that share the same <js>"BeanContext.*"</js> property values share
- * the same cache. This allows for efficient reuse of <code>ClassMeta</code> objects so that the information about
- * classes only needs to be calculated once.
+ * the same cache. This allows for efficient reuse of <code>ClassMeta</code> objects so that the information about
+ * classes only needs to be calculated once.
* Because of this, many of the properties defined on the {@link BeanContext} class cannot be overridden on the session.
*
* <h5 class='topic'>Bean Sessions</h5>
* <p>
* Whereas <code>BeanContext</code> objects are permanent, unchangeable, cached, and thread-safe,
- * {@link BeanSession} objects are ephemeral and not thread-safe.
+ * {@link BeanSession} objects are ephemeral and not thread-safe.
* They are meant to be used as quickly-constructed scratchpads for creating bean maps.
* {@link BeanMap} objects can only be created through the session.
*
* <h5 class='topic'>BeanContext configuration properties</h5>
- * <code>BeanContexts</code> have several configuration properties that can be used to tweak behavior on how beans are handled.
- * These are denoted as the static <jsf>BEAN_*</jsf> fields on this class.
+ * <code>BeanContexts</code> have several configuration properties that can be used to tweak behavior on how beans are
+ * handled. These are denoted as the static <jsf>BEAN_*</jsf> fields on this class.
* <p>
- * Some settings (e.g. {@link BeanContext#BEAN_beansRequireDefaultConstructor}) are used to differentiate between bean and non-bean classes.
+ * Some settings (e.g. {@link BeanContext#BEAN_beansRequireDefaultConstructor}) are used to differentiate between bean
+ * and non-bean classes.
* Attempting to create a bean map around one of these objects will throw a {@link BeanRuntimeException}.
- * The purpose for this behavior is so that the serializers can identify these non-bean classes and convert them to plain strings using the {@link Object#toString()} method.
+ * The purpose for this behavior is so that the serializers can identify these non-bean classes and convert them to
+ * plain strings using the {@link Object#toString()} method.
* <p>
- * Some settings (e.g. {@link BeanContext#BEAN_beanFieldVisibility}) are used to determine what kinds of properties are detected on beans.
+ * Some settings (e.g. {@link BeanContext#BEAN_beanFieldVisibility}) are used to determine what kinds of properties are
+ * detected on beans.
* <p>
* Some settings (e.g. {@link BeanContext#BEAN_beanMapPutReturnsOldValue}) change the runtime behavior of bean maps.
* <p>
- * Settings are specified using the {@link PropertyStore#setProperty(String, Object)} method and related convenience methods.
+ * Settings are specified using the {@link PropertyStore#setProperty(String, Object)} method and related convenience
+ * methods.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -96,12 +100,14 @@ import org.apache.juneau.transform.*;
* <h5 class='topic'>Bean Maps</h5>
* <p>
* {@link BeanMap BeanMaps} are wrappers around Java beans that allow properties to be retrieved and
- * set using the common {@link Map#put(Object,Object)} and {@link Map#get(Object)} methods.<br>
- * <br>
+ * set using the common {@link Map#put(Object,Object)} and {@link Map#get(Object)} methods.
+ * <p>
* Bean maps are created in two ways...
* <ol>
- * <li> {@link BeanSession#toBeanMap(Object) BeanSession.toBeanMap()} - Wraps an existing bean inside a {@code Map} wrapper.
- * <li> {@link BeanSession#newBeanMap(Class) BeanSession.newBeanMap()} - Create a new bean instance wrapped in a {@code Map} wrapper.
+ * <li>{@link BeanSession#toBeanMap(Object) BeanSession.toBeanMap()} - Wraps an existing bean inside a {@code Map}
+ * wrapper.
+ * <li>{@link BeanSession#newBeanMap(Class) BeanSession.newBeanMap()} - Create a new bean instance wrapped in a
+ * {@code Map} wrapper.
* </ol>
*
* <h5 class='section'>Example:</h5>
@@ -131,8 +137,8 @@ import org.apache.juneau.transform.*;
*
* <h5 class='topic'>Bean Annotations</h5>
* <p>
- * This package contains annotations that can be applied to
- * class definitions to override what properties are detected on a bean.
+ * This package contains annotations that can be applied to class definitions to override what properties are detected
+ * on a bean.
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Bean class definition where only property 'name' is detected.</jc>
@@ -149,16 +155,17 @@ import org.apache.juneau.transform.*;
* <h5 class='topic'>Beans with read-only properties</h5>
* <p>
* Bean maps can also be defined on top of beans with read-only properties by adding a
- * {@link BeanConstructor @BeanConstructor} annotation to one of the constructors on the
- * bean class. This will allow read-only properties to be set through constructor arguments.
+ * {@link BeanConstructor @BeanConstructor} annotation to one of the constructors on the
+ * bean class. This will allow read-only properties to be set through constructor arguments.
* <p>
- * When the <code>@BeanConstructor</code> annotation is present, bean instantiation is delayed until the call to {@link BeanMap#getBean()}.
+ * When the <code>@BeanConstructor</code> annotation is present, bean instantiation is delayed until the call to
+ * {@link BeanMap#getBean()}.
* Until then, bean property values are stored in a local cache until <code>getBean()</code> is called.
- * Because of this additional caching step, parsing into read-only beans tends to be slower and use
- * more memory than parsing into beans with writable properties.
+ * Because of this additional caching step, parsing into read-only beans tends to be slower and use more memory than
+ * parsing into beans with writable properties.
* <p>
* Attempting to call {@link BeanMap#put(String,Object)} on a read-only property after calling {@link BeanMap#getBean()}
- * will result in a {@link BeanRuntimeException} being thrown.
+ * will result in a {@link BeanRuntimeException} being thrown.
* Multiple calls to {@link BeanMap#getBean()} will return the same bean instance.
* <p>
* Beans can be defined with a combination of read-only and read-write properties.
@@ -167,26 +174,28 @@ import org.apache.juneau.transform.*;
*
* <h5 class='topic'>BeanFilters and PojoSwaps</h5>
* <p>
- * {@link BeanFilter BeanFilters} and {@link PojoSwap PojoSwaps} are used to tailor how beans and POJOs are handled.<br>
+ * {@link BeanFilter BeanFilters} and {@link PojoSwap PojoSwaps} are used to tailor how beans and POJOs are handled.
* <ol class='spaced-list'>
* <li>{@link BeanFilter} - Allows you to tailor handling of bean classes.
* This class can be considered a programmatic equivalent to the {@link Bean} annotation when
* annotating classes are not possible (e.g. you don't have access to the source).
- * This includes specifying which properties are visible and the ability to programmatically override the execution of properties.
+ * This includes specifying which properties are visible and the ability to programmatically override the
+ * execution of properties.
* <li>{@link PojoSwap} - Allows you to swap out non-serializable objects with serializable replacements.
* </ol>
* <p>
- * See <a class='doclink' href='transform/package-summary.html#TOC'>org.apache.juneau.transform</a> for more information.
+ * See <a class='doclink' href='transform/package-summary.html#TOC'>org.apache.juneau.transform</a> for more
+ * information.
*
* <h5 class='topic'>ClassMetas</h5>
* <p>
- * The {@link ClassMeta} class is a wrapper around {@link Class} object that provides cached information
- * about that class (e.g. whether it's a {@link Map} or {@link Collection} or bean).
+ * The {@link ClassMeta} class is a wrapper around {@link Class} object that provides cached information about that
+ * class (e.g. whether it's a {@link Map} or {@link Collection} or bean).
* <p>
- * As a general rule, it's best to reuse bean contexts (and therefore serializers and parsers too)
- * whenever possible since it takes some time to populate the internal {@code ClassMeta} object cache.
- * By reusing bean contexts, the class type metadata only needs to be calculated once which significantly
- * improves performance.
+ * As a general rule, it's best to reuse bean contexts (and therefore serializers and parsers too) whenever possible
+ * since it takes some time to populate the internal {@code ClassMeta} object cache.
+ * By reusing bean contexts, the class type metadata only needs to be calculated once which significantly improves
+ * performance.
* <p>
* See {@link ClassMeta} for more information.
*/
@@ -257,7 +266,8 @@ public class BeanContext extends Context {
public static final String BEAN_beansRequireSomeProperties = "BeanContext.beansRequireSomeProperties";
/**
- * <b>Configuration property:</b> {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property value.
+ * <b>Configuration property:</b> {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
+ * value.
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMapPutReturnsOldValue"</js>
@@ -266,7 +276,8 @@ public class BeanContext extends Context {
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
* <p>
- * If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property values.
+ * If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
+ * values.
* <p>
* Disabled by default because it introduces a slight performance penalty.
*/
@@ -360,8 +371,8 @@ public class BeanContext extends Context {
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
* <p>
- * If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an {@link InvocationHandler}
- * if there is no other way of instantiating them.
+ * If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an
+ * {@link InvocationHandler} if there is no other way of instantiating them.
*/
public static final String BEAN_useInterfaceProxies = "BeanContext.useInterfaceProxies";
@@ -454,7 +465,7 @@ public class BeanContext extends Context {
* Otherwise, the natural order of the bean properties is used which is dependent on the
* JVM vendor.
* On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.
- * On Oracle JVMs, the bean properties are not ordered (which follows the offical JVM specs).
+ * On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).
* <p>
* This property is disabled by default so that IBM JVM users don't have to use {@link Bean @Bean} annotations
* to force bean properties to be in a particular order and can just alter the order of the fields/methods
@@ -623,11 +634,11 @@ public class BeanContext extends Context {
* Specifies to only include the specified list of properties for the specified bean classes.
* <p>
* The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property
- * names.
+ * names.
* The key <js>"*"</js> means all bean classes.
* <p>
- * For example, <code>{Bean1:<js>'foo,bar'</js>}</code> means only serialize the <code>foo</code> and <code>bar</code>
- * properties on the specified bean.
+ * For example, <code>{Bean1:<js>'foo,bar'</js>}</code> means only serialize the <code>foo</code> and
+ * <code>bar</code> properties on the specified bean.
* <p>
* Setting applies to specified class and all subclasses.
*/
@@ -654,8 +665,8 @@ public class BeanContext extends Context {
* names.
* The key <js>"*"</js> means all bean classes.
* <p>
- * For example, <code>{Bean1:<js>'foo,bar'</js>}</code> means don't serialize the <code>foo</code> and <code>bar</code>
- * properties on the specified bean.
+ * For example, <code>{Bean1:<js>'foo,bar'</js>}</code> means don't serialize the <code>foo</code> and
+ * <code>bar</code> properties on the specified bean.
* <p>
* Setting applies to specified class and all subclasses.
*/
@@ -679,8 +690,10 @@ public class BeanContext extends Context {
* This list can consist of the following class types:
* <ul>
* <li>Any bean class that specifies a value for {@link Bean#typeName() @Bean.typeName()}.
- * <li>Any subclass of {@link BeanDictionaryList} containing a collection of bean classes with type name annotations.
- * <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name annotations.
+ * <li>Any subclass of {@link BeanDictionaryList} containing a collection of bean classes with type name
+ * annotations.
+ * <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name
+ * annotations.
* </ul>
*/
public static final String BEAN_beanDictionary = "BeanContext.beanDictionary.list";
@@ -830,7 +843,8 @@ public class BeanContext extends Context {
// This map ensures that if the BeanContext properties in the ConfigFactory are the same,
// then we reuse the same Class->ClassMeta cache map.
// This significantly reduces the number of times we need to construct ClassMeta objects which can be expensive.
- private static final ConcurrentHashMap<Integer,Map<Class,ClassMeta>> cmCacheCache = new ConcurrentHashMap<Integer,Map<Class,ClassMeta>>();
+ private static final ConcurrentHashMap<Integer,Map<Class,ClassMeta>> cmCacheCache
+ = new ConcurrentHashMap<Integer,Map<Class,ClassMeta>>();
/** Default config. All default settings. */
public static final BeanContext DEFAULT = PropertyStore.create().getContext(BeanContext.class);
@@ -1100,7 +1114,7 @@ public class BeanContext extends Context {
* @param <T> The class type being wrapped.
* @param type The class to resolve.
* @return If the class is not an array, returns a cached {@link ClassMeta} object.
- * Otherwise, returns a new {@link ClassMeta} object every time.<br>
+ * Otherwise, returns a new {@link ClassMeta} object every time.
*/
public final <T> ClassMeta<T> getClassMeta(Class<T> type) {
return getClassMeta(type, true);
@@ -1113,7 +1127,7 @@ public class BeanContext extends Context {
* @param type The class to resolve.
* @param waitForInit If <jk>true</jk>, wait for the ClassMeta constructor to finish before returning.
* @return If the class is not an array, returns a cached {@link ClassMeta} object.
- * Otherwise, returns a new {@link ClassMeta} object every time.<br>
+ * Otherwise, returns a new {@link ClassMeta} object every time.
*/
final <T> ClassMeta<T> getClassMeta(Class<T> type, boolean waitForInit) {
@@ -1157,17 +1171,23 @@ public class BeanContext extends Context {
* <li><code>getClassMeta(String.<jk>class</jk>);</code> - A normal type.
* <li><code>getClassMeta(List.<jk>class</jk>);</code> - A list containing objects.
* <li><code>getClassMeta(List.<jk>class</jk>, String.<jk>class</jk>);</code> - A list containing strings.
- * <li><code>getClassMeta(LinkedList.<jk>class</jk>, String.<jk>class</jk>);</code> - A linked-list containing strings.
- * <li><code>getClassMeta(LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);</code> - A linked-list containing linked-lists of strings.
+ * <li><code>getClassMeta(LinkedList.<jk>class</jk>, String.<jk>class</jk>);</code> - A linked-list containing
+ * strings.
+ * <li><code>getClassMeta(LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);</code> -
+ * A linked-list containing linked-lists of strings.
* <li><code>getClassMeta(Map.<jk>class</jk>);</code> - A map containing object keys/values.
- * <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);</code> - A map containing string keys/values.
- * <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);</code> - A map containing string keys and values of lists containing beans.
+ * <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);</code> - A map
+ * containing string keys/values.
+ * <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);</code> -
+ * A map containing string keys and values of lists containing beans.
* </ul>
*
* @param type The class to resolve.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* <br>Ignored if the main type is not a map or collection.
* @return The resolved class meta.
*/
@@ -1363,14 +1383,13 @@ public class BeanContext extends Context {
/**
- * Used for determining the class type on a method or field where a {@code @BeanProperty} annotation
- * may be present.
+ * Used for determining the class type on a method or field where a {@code @BeanProperty} annotation may be present.
*
* @param <T> The class type we're wrapping.
* @param p The property annotation on the type if there is one.
* @param t The type.
- * @param typeVarImpls Contains known resolved type parameters on the specified class so
- * that we can result {@code ParameterizedTypes} and {@code TypeVariables}.<br>
+ * @param typeVarImpls Contains known resolved type parameters on the specified class so that we can result
+ * {@code ParameterizedTypes} and {@code TypeVariables}.
* Can be <jk>null</jk> if the information is not known.
* @return The new {@code ClassMeta} object wrapped around the {@code Type} object.
*/
@@ -1422,7 +1441,7 @@ public class BeanContext extends Context {
/**
* Returns the {@link PojoSwap} associated with the specified class, or <jk>null</jk> if there is no
- * pojo swap associated with the class.
+ * POJO swap associated with the class.
*
* @param <T> The class associated with the swap.
* @param c The class associated with the swap.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryList.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryList.java b/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryList.java
index 901f2e3..de0c084 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryList.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryList.java
@@ -35,7 +35,8 @@ public class BeanDictionaryList extends ArrayList<Class<?>> {
* Constructor.
*
* @param c The list of bean classes to add to this dictionary.
- * Classes must either specify a {@link Bean#typeName()} value or be another subclass of <code>BeanDictionaryList</code>.
+ * Classes must either specify a {@link Bean#typeName()} value or be another subclass of
+ * <code>BeanDictionaryList</code>.
*/
public BeanDictionaryList(Class<?>...c) {
append(c);
@@ -45,7 +46,8 @@ public class BeanDictionaryList extends ArrayList<Class<?>> {
* Append one or more bean classes to this bean dictionary.
*
* @param c The list of bean classes to add to this dictionary.
- * Classes must either specify a {@link Bean#typeName()} value or be another subclass of <code>BeanDictionaryList</code>.
+ * Classes must either specify a {@link Bean#typeName()} value or be another subclass of
+ * <code>BeanDictionaryList</code>.
* @return This object (for method chaining).
*/
protected BeanDictionaryList append(Class<?>...c) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/BeanMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanMap.java b/juneau-core/src/main/java/org/apache/juneau/BeanMap.java
index 1bdacfa..5e2279c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanMap.java
@@ -28,16 +28,18 @@ import org.apache.juneau.xml.annotation.*;
*
* <h5 class='section'>Description:</h5>
* <p>
- * A wrapper that wraps Java bean instances inside of a {@link Map} interface that allows
- * properties on the wrapped object can be accessed using the {@link Map#get(Object) get()} and {@link Map#put(Object,Object) put()} methods.
+ * A wrapper that wraps Java bean instances inside of a {@link Map} interface that allows properties on the wrapped
+ * object can be accessed using the {@link Map#get(Object) get()} and {@link Map#put(Object,Object) put()} methods.
* <p>
* Use the {@link BeanContext} class to create instances of this class.
*
* <h6 class='topic'>Bean property order</h6>
* <p>
- * The order of the properties returned by the {@link Map#keySet() keySet()} and {@link Map#entrySet() entrySet()} methods are as follows:
+ * The order of the properties returned by the {@link Map#keySet() keySet()} and {@link Map#entrySet() entrySet()}
+ * methods are as follows:
* <ul class='spaced-list'>
- * <li>If {@link Bean @Bean} annotation is specified on class, then the order is the same as the list of properties in the annotation.
+ * <li>If {@link Bean @Bean} annotation is specified on class, then the order is the same as the list of properties
+ * in the annotation.
* <li>If {@link Bean @Bean} annotation is not specified on the class, then the order is the same as that returned
* by the {@link java.beans.BeanInfo} class (i.e. ordered by definition in the class).
* </ul>
@@ -46,9 +48,9 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>POJO swaps</h6>
* <p>
- * If {@link PojoSwap PojoSwaps} are defined on the class types of the properties of this bean or the bean properties themselves, the
- * {@link #get(Object)} and {@link #put(String, Object)} methods will automatically
- * transform the property value to and from the serialized form.
+ * If {@link PojoSwap PojoSwaps} are defined on the class types of the properties of this bean or the bean properties
+ * themselves, the {@link #get(Object)} and {@link #put(String, Object)} methods will automatically transform the
+ * property value to and from the serialized form.
*
* @param <T> Specifies the type of object that this map encapsulates.
*/
@@ -193,7 +195,8 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
*
* @param property The name of the property to set.
* @param value The value to set the property to.
- * @return If the bean context setting {@code beanMapPutReturnsOldValue} is <jk>true</jk>, then the old value of the property is returned.
+ * @return If the bean context setting {@code beanMapPutReturnsOldValue} is <jk>true</jk>, then the old value of the
+ * property is returned.
* Otherwise, this method always returns <jk>null</jk>.
* @throws RuntimeException if any of the following occur.
* <ul class='spaced-list'>
@@ -408,7 +411,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
*
* @return The class type of the wrapped bean.
*/
- @Override /* Delagate */
+ @Override /* Delegate */
public ClassMeta<T> getClassMeta() {
return this.meta.getClassMeta();
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/BeanMapEntry.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanMapEntry.java b/juneau-core/src/main/java/org/apache/juneau/BeanMapEntry.java
index ea5482a..076bdb6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanMapEntry.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanMapEntry.java
@@ -81,7 +81,8 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
/**
* Sets the value of this property.
* <p>
- * If the property is an array of type {@code X}, then the value can be a {@code Collection<X>} or {@code X[]} or {@code Object[]}.
+ * If the property is an array of type {@code X}, then the value can be a {@code Collection<X>} or {@code X[]} or
+ * {@code Object[]}.
* <p>
* If the property is a bean type {@code X}, then the value can either be an {@code X} or a {@code Map}.
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/BeanMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanMeta.java b/juneau-core/src/main/java/org/apache/juneau/BeanMeta.java
index a6b73a2..136406e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanMeta.java
@@ -40,7 +40,8 @@ import org.apache.juneau.utils.*;
* <p>
* The order of the properties are as follows:
* <ul class='spaced-list'>
- * <li>If {@link Bean @Bean} annotation is specified on class, then the order is the same as the list of properties in the annotation.
+ * <li>If {@link Bean @Bean} annotation is specified on class, then the order is the same as the list of properties
+ * in the annotation.
* <li>If {@link Bean @Bean} annotation is not specified on the class, then the order is based on the following.
* <ul>
* <li>Public fields (same order as {@code Class.getFields()}).
@@ -88,11 +89,11 @@ public class BeanMeta<T> {
private final MetadataMap extMeta; // Extended metadata
// Other fields
- final String typePropertyName; // "_type" property actual name.
- private final BeanPropertyMeta typeProperty; // "_type" mock bean property.
- final BeanPropertyMeta dynaProperty; // "extras" property.
- private final String dictionaryName; // The @Bean.typeName() annotation defined on this bean class.
- final String notABeanReason; // Readable string explaining why this class wasn't a bean.
+ final String typePropertyName; // "_type" property actual name.
+ private final BeanPropertyMeta typeProperty; // "_type" mock bean property.
+ final BeanPropertyMeta dynaProperty; // "extras" property.
+ private final String dictionaryName; // The @Bean.typeName() annotation defined on this bean class.
+ final String notABeanReason; // Readable string explaining why this class wasn't a bean.
final BeanRegistry beanRegistry;
final boolean sortProperties;
@@ -725,11 +726,11 @@ public class BeanMeta<T> {
/**
* Recursively determines the classes represented by parameterized types in the class hierarchy of
- * the specified type, and puts the results in the specified map.<br>
+ * the specified type, and puts the results in the specified map.
* <p>
* For example, given the following classes...
* <p class='bcode'>
- * public static class BeanA<T> {
+ * public static class BeanA<T> {
* public T x;
* }
* public static class BeanB extends BeanA<Integer>} {...}
@@ -744,7 +745,7 @@ public class BeanMeta<T> {
* public static class BeanB<T extends Number> extends BeanA<T>;
* public static class BeanC extends BeanB<Integer>;
* <p>
- * When called on {@code BeanC}, the variable will be detected as a {@code Number}, not an {@code Integer}.<br>
+ * When called on {@code BeanC}, the variable will be detected as a {@code Number}, not an {@code Integer}.
* If anyone can figure out a better way of doing this, please do so!
*
* @param t The type we're recursing.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMeta.java b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMeta.java
index edf7ab2..1933f82 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMeta.java
@@ -332,8 +332,9 @@ public class BeanPropertyMeta {
* Returns the {@link ClassMeta} of the class of this property.
* <p>
* If this property or the property type class has a {@link PojoSwap} associated with it, this
- * method returns the transformed class meta.
- * This matches the class type that is used by the {@link #get(BeanMap,String)} and {@link #set(BeanMap,String,Object)} methods.
+ * method returns the transformed class meta.
+ * This matches the class type that is used by the {@link #get(BeanMap,String)} and
+ * {@link #set(BeanMap,String,Object)} methods.
*
* @return The {@link ClassMeta} of the class of this property.
*/
@@ -504,7 +505,7 @@ public class BeanPropertyMeta {
BeanSession session = m.getBeanSession();
- // Comvert to raw form.
+ // Convert to raw form.
value = unswap(session, value);
if (m.bean == null) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java b/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
index c644ec0..83f9b42 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
@@ -30,8 +30,9 @@ import org.apache.juneau.internal.*;
* <p>
* The dictionary is used by the framework in the following ways:
* <ul>
- * <li>If a class type cannot be inferred through reflection during parsing, then a helper <js>"_type"</js> is added to the serialized output
- * using the name defined for that class in this dictionary. This helps determine the real class at parse time.
+ * <li>If a class type cannot be inferred through reflection during parsing, then a helper <js>"_type"</js> is added
+ * to the serialized output using the name defined for that class in this dictionary. This helps determine the
+ * real class at parse time.
* <li>The dictionary name is used as element names when serialized to XML.
* </ul>
*/
[13/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Allow.java b/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
index c7e0909..0776437 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
@@ -55,7 +55,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Allow extends HeaderStringArray {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java b/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
index 7c28582..10919c6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
@@ -61,7 +61,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Authorization extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java b/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
index e2ffa72..eec8b0a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
@@ -85,7 +85,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class CacheControl extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Connection.java b/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
index 2d3b4cb..d49bd96 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
@@ -64,7 +64,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Connection extends HeaderString {
@@ -88,6 +89,7 @@ public final class Connection extends HeaderString {
/**
* Returns <jk>true</jk> if the header value is <code>close</code>.
+ *
* @return <jk>true</jk> if the header value is <code>close</code>.
*/
public boolean isClose() {
@@ -96,6 +98,7 @@ public final class Connection extends HeaderString {
/**
* Returns <jk>true</jk> if the header value is <code>keep-alive</code>.
+ *
* @return <jk>true</jk> if the header value is <code>keep-alive</code>.
*/
public boolean isKeepAlive() {
@@ -104,6 +107,7 @@ public final class Connection extends HeaderString {
/**
* Returns <jk>true</jk> if the header value is <code>upgrade</code>.
+ *
* @return <jk>true</jk> if the header value is <code>upgrade</code>.
*/
public boolean isUpgrade() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/Constants.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Constants.java b/juneau-core/src/main/java/org/apache/juneau/http/Constants.java
index b1eef5d..fdb5f3a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Constants.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Constants.java
@@ -18,7 +18,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class Constants {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
index 2d93a89..05b5e02 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
@@ -57,7 +57,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class ContentEncoding extends HeaderEnum<ContentEncodingEnum> {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
index 89a04ec..111cd50 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
@@ -18,7 +18,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public enum ContentEncodingEnum {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
index 0e7b5be..db8974a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
@@ -61,7 +61,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class ContentLanguage extends HeaderStringArray {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
index 95aa0e0..a06cc5e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
@@ -50,7 +50,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class ContentLength extends HeaderInteger {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
index 6d8bcb9..5325bb0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
@@ -55,7 +55,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class ContentLocation extends HeaderUri {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
index 01005e5..19bc129 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
@@ -109,7 +109,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class ContentRange extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
index f3942ba..af0c33a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
@@ -43,7 +43,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class ContentType extends MediaType {
@@ -75,10 +76,12 @@ public class ContentType extends MediaType {
* <p>
* Note that fuzzy matching is allowed on the media types where the <code>Content-Types</code> header may
* contain additional subtype parts.
- * <br>For example, given a <code>Content-Type</code> value of <js>"text/json+activity"</js>,
+ * <br>
+ * For example, given a <code>Content-Type</code> value of <js>"text/json+activity"</js>,
* the media type <js>"text/json"</js> will match if <js>"text/json+activity"</js> or <js>"text/activity+json"</js>
* isn't found.
- * <br>The purpose for this is to allow parsers to match when artifacts such as <code>id</code> properties are present
+ * <br>
+ * The purpose for this is to allow parsers to match when artifacts such as <code>id</code> properties are present
* in the header.
*
* @param mediaTypes The media types to match against.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/Date.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Date.java b/juneau-core/src/main/java/org/apache/juneau/http/Date.java
index 26aadf2..a021a37 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Date.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Date.java
@@ -66,7 +66,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Date extends HeaderDate {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ETag.java b/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
index af08f10..d9c2dbb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
@@ -41,7 +41,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class ETag extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java b/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
index d54645b..fe10c90 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
@@ -24,7 +24,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class EntityValidator {
@@ -49,6 +50,7 @@ public class EntityValidator {
/**
* Returns the validator value stripped of quotes and weak tag.
+ *
* @return The validator value.
*/
public String asString() {
@@ -57,6 +59,7 @@ public class EntityValidator {
/**
* Returns <jk>true</jk> if the weak flag is present in the value.
+ *
* @return <jk>true</jk> if the weak flag is present in the value.
*/
public boolean isWeak() {
@@ -65,6 +68,7 @@ public class EntityValidator {
/**
* Returns <jk>true</jk> if the validator string value is <code>*</code>.
+ *
* @return <jk>true</jk> if the validator string value is <code>*</code>.
*/
public boolean isAny() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Expect.java b/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
index 74f4e16..c212c2c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
@@ -56,7 +56,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Expect extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Expires.java b/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
index ec3b947..acf5b62 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
@@ -63,7 +63,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Expires extends HeaderDate {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/From.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/From.java b/juneau-core/src/main/java/org/apache/juneau/http/From.java
index 37081ae..ecd2c69 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/From.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/From.java
@@ -55,7 +55,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class From extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
index 4fd2c79..84ca1f0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
@@ -25,7 +25,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class HeaderDate {
@@ -35,6 +36,7 @@ public class HeaderDate {
/**
* Constructor.
+ *
* @param raw The raw header value.
*/
protected HeaderDate(String raw) {
@@ -44,6 +46,7 @@ public class HeaderDate {
/**
* Returns this header value as a {@link java.util.Date}.
+ *
* @return This header value as a {@link java.util.Date}, or <jk>null</jk> if the header could not be parsed.
*/
public java.util.Date asDate() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
index 67432f9..230765c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
@@ -23,7 +23,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class HeaderEntityValidator {
@@ -32,6 +33,7 @@ public class HeaderEntityValidator {
/**
* Constructor.
+ *
* @param value The raw header value.
*/
protected HeaderEntityValidator(String value) {
@@ -40,6 +42,7 @@ public class HeaderEntityValidator {
/**
* Returns this header value as a {@link EntityValidator} object.
+ *
* @return this header value as a {@link EntityValidator} object.
*/
public EntityValidator asValidator() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
index 3571a97..e5e7a0b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
@@ -27,7 +27,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class HeaderEntityValidatorArray {
@@ -36,6 +37,7 @@ public class HeaderEntityValidatorArray {
/**
* Constructor.
+ *
* @param value The raw header value.
*/
protected HeaderEntityValidatorArray(String value) {
@@ -48,6 +50,7 @@ public class HeaderEntityValidatorArray {
/**
* Returns this header value as an array of {@link EntityValidator} objects.
+ *
* @return this header value as an array of {@link EntityValidator} objects.
*/
public EntityValidator[] asValidators() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
index e0dadb3..a206c03 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
@@ -24,7 +24,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class HeaderEnum<E extends Enum<E>> {
@@ -34,6 +35,7 @@ public class HeaderEnum<E extends Enum<E>> {
/**
* Constructor.
+ *
* @param value The raw header value.
* @param enumClass The enum class.
* @param def The default enum value if the value could not be parsed.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
index 76bd74b..7cd167e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
@@ -23,7 +23,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class HeaderInteger {
@@ -32,6 +33,7 @@ public class HeaderInteger {
/**
* Constructor.
+ *
* @param value The raw header value.
*/
protected HeaderInteger(String value) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
index 6e5757e..e7c6978 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
@@ -27,7 +27,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class HeaderRangeArray {
@@ -37,6 +38,7 @@ public class HeaderRangeArray {
/**
* Constructor.
+ *
* @param value The raw header value.
*/
protected HeaderRangeArray(String value) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
index 8e392b8..2efc800 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
@@ -25,7 +25,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class HeaderString {
@@ -34,6 +35,7 @@ public class HeaderString {
/**
* Constructor.
+ *
* @param value The raw header value.
*/
protected HeaderString(String value) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
index 78e15b8..7897aab 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
@@ -25,7 +25,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class HeaderStringArray {
@@ -34,6 +35,7 @@ public class HeaderStringArray {
/**
* Constructor.
+ *
* @param value The raw header value.
*/
protected HeaderStringArray(String value) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
index 264721b..df46496 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
@@ -27,7 +27,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public class HeaderUri{
@@ -36,6 +37,7 @@ public class HeaderUri{
/**
* Constructor.
+ *
* @param value The raw header value.
*/
protected HeaderUri(String value) {
@@ -44,6 +46,7 @@ public class HeaderUri{
/**
* Returns this header as a {@link URI}.
+ *
* @return This header as a {@link URI}.
*/
public URI asURI() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/Host.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Host.java b/juneau-core/src/main/java/org/apache/juneau/http/Host.java
index eed7318..3290732 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Host.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Host.java
@@ -58,7 +58,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Host extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java b/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
index 1ff778b..21f8845 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
@@ -20,7 +20,8 @@ import java.util.*;
* <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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public enum HttpMethod {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java b/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
index e41f5a2..667586c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
@@ -73,7 +73,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class IfMatch extends HeaderEntityValidatorArray {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java b/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
index 3d1b1f6..3dd007c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
@@ -75,7 +75,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class IfModifiedSince extends HeaderDate {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java b/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
index c89c199..4cbf3bd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
@@ -78,7 +78,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class IfNoneMatch extends HeaderEntityValidatorArray {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java b/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
index dacef7e..b22942d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
@@ -55,7 +55,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class IfRange extends HeaderString {
@@ -78,6 +79,7 @@ public final class IfRange extends HeaderString {
/**
* Returns this header value as a {@link java.util.Date} object.
+ *
* @return This header value as a {@link java.util.Date} object, or <jk>null</jk> if the value is not a date.
*/
public java.util.Date asDate() {
@@ -89,6 +91,7 @@ public final class IfRange extends HeaderString {
/**
* Returns this header value as an {@link EntityValidator} object.
+ *
* @return This header value as a {@link EntityValidator} object, or <jk>null</jk> if the value is not an entity
* validator.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java b/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
index 92c8247..30c6d8c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
@@ -49,7 +49,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class IfUnmodifiedSince extends HeaderDate {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 f8ceac7..1c4405d 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
@@ -57,7 +57,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class LastModified extends HeaderDate {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 0527d1e..5d37c25 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
@@ -46,7 +46,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Location extends HeaderUri {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 09d2bbf..2660354 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
@@ -48,7 +48,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class MaxForwards extends HeaderInteger {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 fc6452a..408c073 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
@@ -27,8 +27,9 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
-* </ul>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * </ul>
*/
@BeanIgnore
@SuppressWarnings("unchecked")
@@ -197,7 +198,7 @@ public class MediaType implements Comparable<MediaType> {
* <p>
* <ul>
* <li>Exact matches (e.g. <js>"text/json"<js>/</js>"text/json"</js>) should match
- * better than metacharacter matches (e.g. <js>"text/*"<js>/</js>"text/json"</js>)
+ * better than meta-character matches (e.g. <js>"text/*"<js>/</js>"text/json"</js>)
* <li>The comparison media type can have additional subtype tokens (e.g. <js>"text/json+foo"</js>)
* that will not prevent a match. The reverse is not true, e.g. the comparison media type
* must contain all subtype tokens found in the comparing media type.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 4ef6ff2..9ebf720 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
@@ -25,7 +25,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
@BeanIgnore
@@ -40,9 +41,11 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
/**
* Parses an <code>Accept</code> header value into an array of media ranges.
* <p>
- * The returned media ranges are sorted such that the most acceptable media is available at ordinal position <js>'0'</js>, and the least acceptable at position n-1.
+ * The returned media ranges are sorted such that the most acceptable media is available at ordinal position
+ * <js>'0'</js>, and the least acceptable at position n-1.
* <p>
- * The syntax expected to be found in the referenced <code>value</code> complies with the syntax described in RFC2616, Section 14.1, as described below:
+ * The syntax expected to be found in the referenced <code>value</code> complies with the syntax described in
+ * RFC2616, Section 14.1, as described below:
* <p class='bcode'>
* Accept = "Accept" ":"
* #( media-range [ accept-params ] )
@@ -55,9 +58,11 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
* accept-extension = ";" token [ "=" ( token | quoted-string ) ]
* </p>
*
- * @param value The value to parse. If <jk>null</jk> or empty, returns a single <code>MediaTypeRange</code> is returned that represents all types.
+ * @param value The value to parse. If <jk>null</jk> or empty, returns a single <code>MediaTypeRange</code> is
+ * returned that represents all types.
* @return The media ranges described by the string.
- * The ranges are sorted such that the most acceptable media is available at ordinal position <js>'0'</js>, and the least acceptable at position n-1.
+ * The ranges are sorted such that the most acceptable media is available at ordinal position <js>'0'</js>, and the
+ * least acceptable at position n-1.
*/
public static MediaTypeRange[] parse(String value) {
@@ -153,8 +158,8 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
* <p>
* The quality value is a float between <code>0.0</code> (unacceptable) and <code>1.0</code> (most acceptable).
* <p>
- * If 'q' value doesn't make sense for the context (e.g. this range was extracted from a <js>"content-*"</js> header, as opposed to <js>"accept-*"</js>
- * header, its value will always be <js>"1"</js>.
+ * If 'q' value doesn't make sense for the context (e.g. this range was extracted from a <js>"content-*"</js>
+ * header, as opposed to <js>"accept-*"</js> header, its value will always be <js>"1"</js>.
*
* @return The 'q' value for this type, never <jk>null</jk>.
*/
@@ -206,7 +211,8 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
}
/**
- * Returns <jk>true</jk> if the specified object is also a <code>MediaType</code>, and has the same qValue, type, parameters, and extensions.
+ * Returns <jk>true</jk> if the specified object is also a <code>MediaType</code>, and has the same qValue, type,
+ * parameters, and extensions.
*
* @return <jk>true</jk> if object is equivalent.
*/
@@ -239,11 +245,12 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
* Compares two MediaRanges for equality.
* <p>
* The values are first compared according to <code>qValue</code> values.
- * Should those values be equal, the <code>type</code> is then lexicographically compared (case-insensitive) in ascending order,
- * with the <js>"*"</js> type demoted last in that order.
+ * Should those values be equal, the <code>type</code> is then lexicographically compared (case-insensitive) in
+ * ascending order, with the <js>"*"</js> type demoted last in that order.
* <code>MediaRanges</code> with the same type but different sub-types are compared - a more specific subtype is
- * promoted over the 'wildcard' subtype.
- * <code>MediaRanges</code> with the same types but with extensions are promoted over those same types with no extensions.
+ * promoted over the 'wildcard' subtype.
+ * <code>MediaRanges</code> with the same types but with extensions are promoted over those same types with no
+ * extensions.
*
* @param o The range to compare to. Never <jk>null</jk>.
*/
@@ -262,8 +269,8 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
}
/**
- * Matches the specified media type against this range and returns a q-value
- * between 0 and 1 indicating the quality of the match.
+ * Matches the specified media type against this range and returns a q-value between 0 and 1 indicating the
+ * quality of the match.
*
* @param o The media type to match against.
* @return A float between 0 and 1. 1 is a perfect match. 0 is no match at all.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 7e13e69..26c8ce2 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
@@ -54,7 +54,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Pragma extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 a364798..13594cd 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
@@ -41,7 +41,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class ProxyAuthenticate extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 1033d8e..2b7287d 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
@@ -43,7 +43,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class ProxyAuthorization extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 8520063..1c7cb9b 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
@@ -88,8 +88,8 @@ package org.apache.juneau.http;
* </p>
* <p>
* HTTP retrieval requests using conditional or unconditional GET methods MAY request one or more sub-ranges of the
- * entity, instead of the entire entity, using the Range request header, which applies to the entity returned as the r
- * esult of the request:
+ * entity, instead of the entire entity, using the Range request header, which applies to the entity returned as the
+ * result of the request:
* <p class='bcode'>
* Range = "Range" ":" ranges-specifier
* </p>
@@ -119,7 +119,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Range extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 8066140..e5757a5 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
@@ -48,7 +48,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Referer extends HeaderUri {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 c0307b8..747c814 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
@@ -50,7 +50,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class RetryAfter extends HeaderString {
@@ -73,6 +74,7 @@ public final class RetryAfter extends HeaderString {
/**
* Returns this header value as a {@link java.util.Date} object.
+ *
* @return This header value as a {@link java.util.Date} object, or <jk>null</jk> if the value is not a date.
*/
public java.util.Date asDate() {
@@ -84,6 +86,7 @@ public final class RetryAfter extends HeaderString {
/**
* Returns this header value as an integer.
+ *
* @return This header value as a integer, or <code>-1</code> if the value is not an integer.
*/
public int asInt() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 e192bb7..d484976 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
@@ -27,7 +27,7 @@ package org.apache.juneau.http;
* The Server response-header field contains information about the software used by the origin server to handle the
* request.
* The field can contain multiple product tokens (section 3.8) and comments identifying the server and any significant
- * subproducts.
+ * sub-products.
* The product tokens are listed in order of their significance for identifying the application.
* <p class='bcode'>
* Server = "Server" ":" 1*( product | comment )
@@ -48,7 +48,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Server extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 4445909..e41213e 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
@@ -30,7 +30,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
@BeanIgnore
@@ -45,7 +46,8 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Parses a header such as an <code>Accept-Encoding</code> header value into an array of type ranges.
* <p>
- * The syntax expected to be found in the referenced <code>value</code> complies with the syntax described in RFC2616, Section 14.1, as described below:
+ * The syntax expected to be found in the referenced <code>value</code> complies with the syntax described in
+ * RFC2616, Section 14.1, as described below:
* <p class='bcode'>
* Accept-Encoding = "Accept-Encoding" ":"
* 1#( codings [ ";" "q" "=" qvalue ] )
@@ -61,9 +63,11 @@ public final class StringRange implements Comparable<StringRange> {
* Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0
* </p>
*
- * @param value The value to parse. If <jk>null</jk> or empty, returns a single <code>TypeRange</code> is returned that represents all types.
+ * @param value The value to parse. If <jk>null</jk> or empty, returns a single <code>TypeRange</code> is returned
+ * that represents all types.
* @return The type ranges described by the string.
- * <br>The ranges are sorted such that the most acceptable type is available at ordinal position <js>'0'</js>, and the least acceptable at position n-1.
+ * <br>The ranges are sorted such that the most acceptable type is available at ordinal position <js>'0'</js>, and
+ * the least acceptable at position n-1.
*/
public static StringRange[] parse(String value) {
@@ -159,8 +163,8 @@ public final class StringRange implements Comparable<StringRange> {
* <p>
* The quality value is a float between <code>0.0</code> (unacceptable) and <code>1.0</code> (most acceptable).
* <p>
- * If 'q' value doesn't make sense for the context (e.g. this range was extracted from a <js>"content-*"</js> header, as opposed to <js>"accept-*"</js>
- * header, its value will always be <js>"1"</js>.
+ * If 'q' value doesn't make sense for the context (e.g. this range was extracted from a <js>"content-*"</js>
+ * header, as opposed to <js>"accept-*"</js> header, its value will always be <js>"1"</js>.
*
* @return The 'q' value for this type, never <jk>null</jk>.
*/
@@ -212,7 +216,8 @@ public final class StringRange implements Comparable<StringRange> {
}
/**
- * Returns <jk>true</jk> if the specified object is also a <code>MediaType</code>, and has the same qValue, type, parameters, and extensions.
+ * Returns <jk>true</jk> if the specified object is also a <code>MediaType</code>, and has the same qValue, type,
+ * parameters, and extensions.
*
* @return <jk>true</jk> if object is equivalent.
*/
@@ -245,9 +250,10 @@ public final class StringRange implements Comparable<StringRange> {
* Compares two MediaRanges for equality.
* <p>
* The values are first compared according to <code>qValue</code> values.
- * Should those values be equal, the <code>type</code> is then lexicographically compared (case-insensitive) in ascending order,
- * with the <js>"*"</js> type demoted last in that order.
- * <code>TypeRanges</code> with the same types but with extensions are promoted over those same types with no extensions.
+ * Should those values be equal, the <code>type</code> is then lexicographically compared (case-insensitive) in
+ * ascending order, with the <js>"*"</js> type demoted last in that order.
+ * <code>TypeRanges</code> with the same types but with extensions are promoted over those same types with no
+ * extensions.
*
* @param o The range to compare to. Never <jk>null</jk>.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 358c395..7ed9855 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
@@ -40,7 +40,8 @@ import org.apache.juneau.internal.*;
* </p>
* The presence of the keyword "trailers" indicates that the client is willing to accept trailer fields in a chunked
* transfer-coding, as defined in section 3.6.1.
- * This keyword is reserved for use with transfer-coding values even though it does not itself represent a transfer-coding.
+ * This keyword is reserved for use with transfer-coding values even though it does not itself represent a
+ * transfer-coding.
* <p>
* Examples of its use are:
* <p class='bcode'>
@@ -75,7 +76,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class TE extends HeaderRangeArray {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 34741d5..da276f2 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
@@ -48,7 +48,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Trailer extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 9a47b07..dcbb896 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
@@ -47,7 +47,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class TransferEncoding extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 adf966c..0ccd015 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
@@ -67,7 +67,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Upgrade extends HeaderStringArray {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 35a4080..e8e4827 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
@@ -28,7 +28,7 @@ package org.apache.juneau.http;
* This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for
* the sake of tailoring responses to avoid particular user agent limitations.
* User agents SHOULD include this field with requests.
- * The field can contain multiple product tokens (section 3.8) and comments identifying the agent and any subproducts
+ * The field can contain multiple product tokens (section 3.8) and comments identifying the agent and any sub-products
* which form a significant part of the user agent.
* By convention, the product tokens are listed in order of their significance for identifying the application.
* <p class='bcode'>
@@ -43,7 +43,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class UserAgent extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 9229d67..fc4bc41 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
@@ -47,7 +47,8 @@ package org.apache.juneau.http;
* at the time of the response.
* <p>
* A Vary field value consisting of a list of field-names signals that the representation selected for the response is
- * based on a selection algorithm which considers ONLY the listed request-header field values in selecting the most appropriate representation.
+ * based on a selection algorithm which considers ONLY the listed request-header field values in selecting the most
+ * appropriate representation.
* A cache MAY assume that the same selection will be made for future requests with the same values for the listed
* field names, for the duration of time for which the response is fresh.
* <p>
@@ -61,7 +62,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Vary extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 06f97af..35e6131 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
@@ -98,7 +98,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Via extends HeaderStringArray {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 3828fbe..ae37a66 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
@@ -106,7 +106,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class Warning extends HeaderString {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 57481cc..08bfee7 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
@@ -39,7 +39,8 @@ 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'>Hypertext Transfer Protocol -- HTTP/1.1</a>
+ * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
public final class WwwAuthenticate extends HeaderString {
[06/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/uon/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/package.html b/juneau-core/src/main/java/org/apache/juneau/uon/package.html
index 0050e8a..3a3c76e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/package.html
@@ -75,17 +75,6 @@
<li><p><a class='doclink' href='#ParserConfigurableProperties'>Configurable properties</a></p>
<li><p><a class='doclink' href='#ParserOtherNotes'>Other notes</a></p>
</ol>
- <li><p><a class='doclink' href='#RestApiSupport'>REST API support</a></p>
- <ol>
- <li><p><a class='doclink' href='#RestServerSupport'>REST server support</a></p>
- <ol>
- <li><p><a class='doclink' href='#RestServletDefault'>Using RestServletDefault</a></p>
- <li><p><a class='doclink' href='#RestServlet'>Using RestServlet with annotations</a></p>
- <li><p><a class='doclink' href='#DefaultProvider'>Using JAX-RS DefaultProvider</a></p>
- <li><p><a class='doclink' href='#BaseProvider'>Using JAX-RS BaseProvider with annotations</a></p>
- </ol>
- <li><p><a class='doclink' href='#RestClientSupport'>REST client support</a></p>
- </ol>
</ol>
<!-- ======================================================================================================== -->
@@ -93,9 +82,14 @@
<h2 class='topic' onclick='toggle(this)'>1 - URL encoding support overview</h2>
<div class='topic'>
<p>
- Juneau supports converting arbitrary POJOs to and from URL-encoded strings using ultra-efficient serializers and parsers.<br>
- The serializer converts POJOs directly to URL-encoded strings without the need for intermediate DOM objects using a highly-efficient state machine.<br>
- Likewise, the parser creates POJOs directly from URL-encoded strings without the need for intermediate DOM objects.
+ Juneau supports converting arbitrary POJOs to and from URL-encoded strings using ultra-efficient serializers
+ and parsers.
+ <br>
+ The serializer converts POJOs directly to URL-encoded strings without the need for intermediate DOM objects
+ using a highly-efficient state machine.
+ <br>
+ Likewise, the parser creates POJOs directly from URL-encoded strings without the need for intermediate DOM
+ objects.
</p>
<p>
Juneau uses UON (URL-Encoded Object Notation) for representing POJOs.
@@ -105,15 +99,21 @@
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>, <code>Float</code>).
- <li>Java Collections Framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything on this list.
+ <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 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 <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 serializable forms.
+ <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
+ 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.
+ 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>
@@ -126,16 +126,19 @@
<h3 class='topic' onclick='toggle(this)'>1.1 - URL-encoding support overview - example</h3>
<div class='topic'>
<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> containing
- zero or more <code>Address</code> beans.
+ 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>
+ containing zero or more <code>Address</code> beans.
</p>
<p>
When you point a browser at <code>/sample/addressBook/people/1</code>, the POJO is rendered as HTML:
</p>
<img class='bordered' src="doc-files/Example_HTML.png">
<p>
- By appending <code>?Accept=application/x-www-form-urlencoded&plainText=true</code> to the URL, you can view the data as a URL-encoded string:
+ By appending <code>?Accept=application/x-www-form-urlencoded&plainText=true</code> to the URL, you can
+ view the data as a URL-encoded string:
</p>
<p class='bcode'>
<un>0</un>=(
@@ -204,8 +207,10 @@
Juneau supports two kinds of serialization:
</p>
<ul class='spaced-list'>
- <li>Construction of full URL query parameter strings (e.g. <code>&key=value</code> pairs) from beans and maps.
- <li>Construction of URL query parameter value strings (e.g. just the <code>value</code> portion of <code>&key=value</code> pairs) from any POJO.
+ <li>Construction of full URL query parameter strings (e.g. <code>&key=value</code> pairs) from beans
+ and maps.
+ <li>Construction of URL query parameter value strings (e.g. just the <code>value</code> portion of
+ <code>&key=value</code> pairs) from any POJO.
</ul>
<p>
Top-level beans and maps can serialized as key/value pairs as shown below:
@@ -215,8 +220,9 @@
http://localhost/sample?<ua>foo</ua>=<us>bar</us>&<ua>baz</ua>=<us>bing</us>
</p>
<p>
- Lower-level beans and maps are also serialized as key/value pairs, but are surrounded with a <js>"(...)"</js> construct to denote an object mapping,
- and uses a comma as the parameter delimiter instead of <js>"&"</js>.<br>
+ Lower-level beans and maps are also serialized as key/value pairs, but are surrounded with a
+ <js>"(...)"</js> construct to denote an object mapping, and uses a comma as the parameter delimiter instead
+ of <js>"&"</js>.
</p>
<h6 class='figure'>Example: A bean serialized as a query parameter value.</h6>
<p class='bcode'>
@@ -280,8 +286,10 @@
<p>
Refer to the <a href='doc-files/rfc_uon.txt'>UON specification</a> for a complete set of syntax rules.
<p>
- <code>PojoSwaps</code> can be used to convert non-serializable POJOs into serializable forms, such as converting
- <code>Calendar</code> object to ISO8601 strings, or <code><uk>byte</uk>[]</code> arrays to Base-64 encoded strings.<br>
+ <code>PojoSwaps</code> can be used to convert non-serializable POJOs into serializable forms, such as
+ converting <code>Calendar</code> object to ISO8601 strings, or <code><uk>byte</uk>[]</code> arrays to
+ Base-64 encoded strings.
+ <br>
These transforms can be associated at various levels:
</p>
<ul class='spaced-list'>
@@ -294,7 +302,8 @@
http://localhost/sample?<ua>a1=<us>'Sun,+03+Mar+1901+09:05:06+GMT'</us>
</p>
<p>
- For more information about transforms, refer to <a class='doclink' href='../transform/package-summary.html#TOC'>org.apache.juneau.transform</a>.
+ For more information about transforms, refer to <a class='doclink'
+ href='../transform/package-summary.html#TOC'>org.apache.juneau.transform</a>.
</p>
</div>
@@ -305,22 +314,29 @@
<h2 class='topic' onclick='toggle(this)'>2 - UrlEncodingSerializer and UonSerializer classes</h2>
<div class='topic'>
<p>
- {@link org.apache.juneau.urlencoding.UrlEncodingSerializer} and {@link org.apache.juneau.uon.UonSerializer} classes are used to convert POJOs to URL-encoded strings.<br>
+ {@link org.apache.juneau.urlencoding.UrlEncodingSerializer} and {@link org.apache.juneau.uon.UonSerializer}
+ classes are used to convert POJOs to URL-encoded strings.
+ <br>
The <code>UonSerializer</code> class converts parameter values to UON notation.
- The <code>UrlEncodingSerializer</code> class converts a POJO to key/value URL-Encoded pairs using <code>UonSerializer</code> to serialize the values.
+ The <code>UrlEncodingSerializer</code> class converts a POJO to key/value URL-Encoded pairs using
+ <code>UonSerializer</code> to serialize the values.
If you're trying to construct complete URL-Encoded entities, use <code>UrlEncodingSerializer</code>.
If you're constructing your own key/value pairs, use <code>UonSerializer</code>.
</p>
<p>
- The serializers include several configurable settings.<br>
+ The serializers include several configurable settings.
+ <br>
Static reusable instances of serializers are provided with commonly-used settings:
</p>
<ul class='spaced-list'>
<li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT} - All default settings, strict mode.
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT_READABLE} - Use whitespace and indentation for readability.
+ <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT_READABLE} - Use whitespace and
+ indentation for readability.
<li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT} - All default settings, strict mode.
- <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_READABLE} - Use whitespace and indentation for readability.
- <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_ENCODING} - Same as DEFAULT, but use URL-Encoding on special characters.
+ <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_READABLE} - Use whitespace and indentation for
+ readability.
+ <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_ENCODING} - Same as DEFAULT, but use URL-Encoding on
+ special characters.
</ul>
<p>
The general guidelines on which serializer to use is:
@@ -328,15 +344,17 @@
<ul class='spaced-list'>
<li>Use encoding serializers when you're using the results to construct a URI yourself, and therefore
need invalid URI characters to be encoded.
- <li>Use unencoding serializers when you're creating parameter values and passing them off to some other
+ <li>Use un-encoding serializers when you're creating parameter values and passing them off to some other
utility class that will itself encode invalid URI characters.
<li>Use the readable serializer for debugging purposes.
</ul>
<h6 class='topic'>Notes about examples</h6>
<p>
- The examples shown in this document will use default strict settings.<br>
- For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples.<br>
+ The examples shown in this document will use default strict 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.
</p>
<p>
@@ -395,7 +413,8 @@
<ua>id</ua>=<un>1</un>&<ua>name</ua>=<us>'John+Smith'</us>
</p>
<p>
- By default, the <code>UrlEncodingSerializer</code> class will URL-Encode special characters, and the <code>UonSerializer</code> will NOT URL-encode special characters.
+ By default, the <code>UrlEncodingSerializer</code> class will URL-Encode special characters, and the
+ <code>UonSerializer</code> will NOT URL-encode special characters.
</p>
@@ -404,21 +423,27 @@
<h3 class='topic' onclick='toggle(this)'>2.1 - @Bean and @BeanProperty annotations</h3>
<div class='topic'>
<p>
- 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>
+ 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:
</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 transforms at both the class and property level (to convert non-serializable POJOs to serializable forms).
+ <li>Associating transforms 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 transform 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>
+ 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 transforms, we can convert them to standardized string forms.
</p>
<p class='bcode'>
@@ -435,13 +460,15 @@
<jk>public</jk> Person() {}
<jc>// Normal constructor</jc>
- <jk>public</jk> Person(<jk>int</jk> id, String name, String uri, String addressBookUri, String birthDate) <jk>throws</jk> Exception {
+ <jk>public</jk> Person(<jk>int</jk> id, String name, String uri, String addressBookUri, String birthDate)
+ <jk>throws</jk> Exception {
<jk>this</jk>.<jf>id</jf> = id;
<jk>this</jk>.<jf>name</jf> = name;
<jk>this</jk>.<jf>uri</jf> = <jk>new</jk> URI(uri);
<jk>this</jk>.<jf>addressBookUri</jf> = <jk>new</jk> URI(addressBookUri);
<jk>this</jk>.<jf>birthDate</jf> = <jk>new</jk> GregorianCalendar();
- <jk>this</jk>.<jf>birthDate</jf>.setTime(DateFormat.<jsm>getDateInstance</jsm>(DateFormat.<jsf>MEDIUM</jsf>).parse(birthDate));
+ <jk>this</jk>.<jf>birthDate</jf>
+ .setTime(DateFormat.<jsm>getDateInstance</jsm>(DateFormat.<jsf>MEDIUM</jsf>).parse(birthDate));
}
}
</p>
@@ -450,23 +477,27 @@
</p>
<p class='bcode'>
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
</p>
<p>
Now when we rerun the sample code, we'll get the following:
</p>
<p class='bcode'>
- (<ua>id</ua>=<un>1</un>,<ua>name</ua>=<us>'John+Smith'</us>,<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>,<ua>addressBookUri</ua>=<us>http://sample/addressBook</us>,<ua>birthDate</ua>=<us>1946-08-12T00:00:00Z</us>)
+ (<ua>id</ua>=<un>1</un>,<ua>name</ua>=<us>'John+Smith'</us>,<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>,
+ <ua>addressBookUri</ua>=<us>http://sample/addressBook</us>,<ua>birthDate</ua>=<us>1946-08-12T00:00:00Z</us>)
</p>
<p>
Using <code>UrlEncodingSerializer</code> instead would create the following:
</p>
<p class='bcode'>
- <ua>id</ua>=<un>1</un>&<ua>name</ua>=<us>'John+Smith'</us>&<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>&<ua>addressBookUri</ua>=<us>http://sample/addressBook</us>&<ua>birthDate</ua>=<us>1946-08-12T00:00:00Z</us>
+ <ua>id</ua>=<un>1</un>&<ua>name</ua>=<us>'John+Smith'</us>&<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>
+ &<ua>addressBookUri</ua>=<us>http://sample/addressBook</us>&<ua>birthDate</ua>=<us>1946-08-12T00:00:00Z</us>
</p>
<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>
+ 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.
It converts bean property names to lowercase-dashed format.
</p>
@@ -478,7 +509,8 @@
</p>
<h6 class='figure'>Results</h6>
<p class='bcode'>
- (<ua>id</ua>=<un>1</us>,<ua>name</ua>=<us>'John+Smith'</us>,<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>,<ua>address-book-uri</ua>=<us>http://sample/addressBook</us>,<ua>birth-date</ua>=<us>1946-08-12T00:00:00Z</us>)
+ (<ua>id</ua>=<un>1</us>,<ua>name</ua>=<us>'John+Smith'</us>,<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>,
+ <ua>address-book-uri</ua>=<us>http://sample/addressBook</us>,<ua>birth-date</ua>=<us>1946-08-12T00:00:00Z</us>)
</p>
</div>
@@ -521,7 +553,8 @@
UonSerializer s = UonSerializer.<jsf>DEFAULT_READABLE</jsf>;
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
Address a = <jk>new</jk> Address();
a.<jf>uri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/address/1"</js>);
a.<jf>personUri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/person/1"</js>);
@@ -581,8 +614,9 @@
</p>
</div>
<p>
- Note how the top level <code>Person</code> bean is serialized using the standard <js>'&'</js> delimiter, whereas the lower-level <code>Address</code>
- bean is serialized using the <js>','</js> character to prevent the <code>addresses</code> field from being incompletely parsed.
+ Note how the top level <code>Person</code> bean is serialized using the standard <js>'&'</js> delimiter,
+ whereas the lower-level <code>Address</code> bean is serialized using the <js>','</js> character to prevent
+ the <code>addresses</code> field from being incompletely parsed.
</p>
@@ -592,15 +626,18 @@
<div class='topic'>
<p>
The URL-encoding 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>
+ 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).
+ be thrown (if {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_maxDepth} is not reached
+ first).
</p>
<p>
If you still want to use the URL-encoding 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 serialization when a duplicate is encountered.
+ {@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
+ serialization when a duplicate is encountered.
</p>
<p>
For example, let's make a POJO model out of the following classes:
@@ -623,7 +660,8 @@
</p>
<p class='bcode'>
<jc>// Clone an existing serializer and set property for detecting recursions.</jc>
- UrlEncodingSerializer s = UrlEncodingSerializer.<jsf>DEFAULT_READABLE</jsf>.builder().detectRecursions(<jk>true</jk>).build();
+ UrlEncodingSerializer s = UrlEncodingSerializer.<jsf>DEFAULT_READABLE</jsf>.builder()
+ .detectRecursions(<jk>true</jk>).build();
<jc>// Create a recursive loop.</jc>
A a = <jk>new</jk> A();
@@ -648,7 +686,7 @@
Without recursion detection enabled, this would cause a stack-overflow error.
</p>
<p>
- Recursion detection introduces a performance penalty of around 20%.<br>
+ Recursion detection introduces a performance penalty of around 20%.
For this reason the setting is disabled by default.
</p>
</div>
@@ -664,7 +702,8 @@
<ul class='spaced-list'>
<li>{@link org.apache.juneau.BeanContext} - Bean context properties.
<li>{@link org.apache.juneau.uon.UonSerializerContext} - UON serializer context properties.
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializerContext} - URL-Encoding serializer context properties.
+ <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializerContext} - URL-Encoding serializer context
+ properties.
</ul>
</div>
@@ -674,8 +713,11 @@
<h3 class='topic' onclick='toggle(this)'>2.5 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau serializers, the URL-encoding serializers are thread safe and maintain an internal cache of bean classes encountered.<br>
- For performance reasons, it's recommended that serializers be reused whenever possible instead of always creating new instances.
+ <li>Like all other Juneau serializers, the URL-encoding serializers are thread safe and maintain an
+ internal cache of bean classes encountered.
+ <br>
+ For performance reasons, it's recommended that serializers be reused whenever possible instead of
+ always creating new instances.
</ul>
</div>
</div>
@@ -686,30 +728,39 @@
<h2 class='topic' onclick='toggle(this)'>3 - UrlEncodingParser and UonParser classes</h2>
<div class='topic'>
<p>
- {@link org.apache.juneau.urlencoding.UrlEncodingParser} and {@link org.apache.juneau.uon.UonParser} classes are used to convert URL-encoded strings back into POJOs.<br>
+ {@link org.apache.juneau.urlencoding.UrlEncodingParser} and {@link org.apache.juneau.uon.UonParser} classes are
+ used to convert URL-encoded strings back into POJOs.
+ <br>
The <code>UonParser</code> class converts UON-encoded parameter values to POJOs.
- The <code>UrlEncodingParser</code> class converts entire URL-Encoded strings to POJOs using <code>UonSerializer</code> to serialize indivisual values.
+ The <code>UrlEncodingParser</code> class converts entire URL-Encoded strings to POJOs using
+ <code>UonSerializer</code> to serialize individual values.
If you're trying to parse an entire URL-Encoded string, use <code>UrlEncodingParser</code>.
- If you're trying to parse an individual value (such as that returned by <code>RestServlet.getQueryParameter(name)</code>), use <code>UonParser</code>.
+ If you're trying to parse an individual value (such as that returned by
+ <code>RestServlet.getQueryParameter(name)</code>), use <code>UonParser</code>.
</p>
<p>
The following static reusable instances of <code>UrlEncodingParser</code> are provided for convenience:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingParser#DEFAULT} - Default parser for entire URL-encoded strings, decode <code>%xx</code> sequences.
- <li>{@link org.apache.juneau.uon.UonParser#DEFAULT} - Default parser for URL-encoded parameter values, don't decode <code>%xx</code> sequences.
- <li>{@link org.apache.juneau.uon.UonParser#DEFAULT_DECODING} - Default parser for URL-encoded parameter values, decode <code>%xx</code> sequences.
+ <li>{@link org.apache.juneau.urlencoding.UrlEncodingParser#DEFAULT}
+ - Default parser for entire URL-encoded strings, decode <code>%xx</code> sequences.
+ <li>{@link org.apache.juneau.uon.UonParser#DEFAULT}
+ - Default parser for URL-encoded parameter values, don't decode <code>%xx</code> sequences.
+ <li>{@link org.apache.juneau.uon.UonParser#DEFAULT_DECODING}
+ - Default parser for URL-encoded parameter values, decode <code>%xx</code> sequences.
</ul>
<p>
- The general guildlines on which parser to use is:
+ The general guidelines on which parser to use is:
</p>
<ul class='spaced-list'>
- <li>Use the <code>DEFAULT</code> parser for parameter values that have already had <code>%xx</code> sequences decoded,
- such as when using <code>HttpServletRequest.getQueryParameter(name)</code>.
- <li>Use the <code>DEFAULT_ENCODED</code> parser if the input has not already had <code>%xx</code> sequences decoded.
+ <li>Use the <code>DEFAULT</code> parser for parameter values that have already had <code>%xx</code> sequences
+ decoded, such as when using <code>HttpServletRequest.getQueryParameter(name)</code>.
+ <li>Use the <code>DEFAULT_ENCODED</code> parser if the input has not already had <code>%xx</code> sequences
+ decoded.
</ul>
<p>
- Let's build upon the previous example and parse the generated URL-encoded string back into the original bean.<br>
+ Let's build upon the previous example and parse the generated URL-encoded string back into the original bean.
+ <br>
We start with the URL-encoded string that was generated.
</p>
<p class='bcode'>
@@ -717,7 +768,8 @@
UonSerializer s = UonSerializer.<jsf>DEFAULT_READABLE</jsf>;
<jc>// Create our bean.</jc>
- Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>, <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
+ Person p = <jk>new</jk> Person(1, <js>"John Smith"</js>, <js>"http://sample/addressBook/person/1"</js>,
+ <js>"http://sample/addressBook"</js>, <js>"Aug 12, 1946"</js>);
Address a = <jk>new</jk> Address();
a.<jf>uri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/address/1"</js>);
a.<jf>personUri</jf> = <jk>new</jk> URI(<js>"http://sample/addressBook/person/1"</js>);
@@ -797,22 +849,24 @@
<h3 class='topic' onclick='toggle(this)'>3.1 - Parsing into generic POJO models</h3>
<div class='topic'>
<p>
- The URL-encoding 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
- parse into a generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive
- objects.
+ The URL-encoding 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 parse into a
+ generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive objects.
</p>
<p>
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>, <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.
+ 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>, <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>
<p>
- When the map or list type is not specified, or is the abstract <code>Map</code>, <code>Collection</code>, or <code>List</code> types,
- the parser will use <code>ObjectMap</code> and <code>ObjectList</code> by default.
+ When the map or list type is not specified, or is the abstract <code>Map</code>, <code>Collection</code>,
+ or <code>List</code> types, the parser will use <code>ObjectMap</code> and <code>ObjectList</code> by default.
</p>
<p>
Starting back with our original URL-encoded string:
@@ -849,9 +903,10 @@
String json = JsonSerializer.<jsf>DEFAULT_LAX_READABLE</jsf>.serialize(m);
</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 <code>Boolean</code> objects
- when parsing into generic models.
+ 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
+ <code>Boolean</code> objects when parsing into generic models.
</p>
<p class='bcode'>
{
@@ -876,7 +931,7 @@
</p>
<p>
Once parsed into a generic model, various convenience methods are provided on the <code>ObjectMap</code>
- and <code>ObjectList</code> classes to retrieve values:
+ and <code>ObjectList</code> classes to retrieve values:
</p>
<p class='bcode'>
<jc>// Parse URL-encoded string into a generic POJO model.</jc>
@@ -901,7 +956,8 @@
</p>
<p>
- As a general rule, parsing into beans is often more efficient than parsing into generic models.<br>
+ 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.
</p>
</div>
@@ -927,414 +983,16 @@
<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 URL-encoding parsers are thread safe and maintain an internal cache of bean classes encountered.<br>
- For performance reasons, it's recommended that parser be reused whenever possible instead of always creating new instances.
+ <li>Like all other Juneau parsers, the URL-encoding parsers are thread safe and maintain an internal cache
+ of bean classes encountered.
+ <br>
+ For performance reasons, it's recommended that parser be reused whenever possible instead of always
+ creating new instances.
</ul>
</div>
</div>
-
-<!-- ======================================================================================================== -->
-<a id="RestApiSupport"></a>
-<h2 class='topic' onclick='toggle(this)'>4 - REST API support</h2>
-<div class='topic'>
- <p>
- Juneau provides fully-integrated support for URL-encoding serialization/parsing in the REST server and client APIs.<br>
- The next two sections describe these in detail.
- </p>
-
- <!-- ======================================================================================================== -->
- <a id="RestServerSupport"></a>
- <h3 class='topic' onclick='toggle(this)'>4.1 - REST server support</h3>
- <div class='topic'>
- <p>
- There are four general ways of defining REST interfaces with support for JSON.
- Two using the built-in Juneau Server API, and two using the JAX-RS integration component.
- </p>
- <ul class='spaced-list'>
- <li>Create a servlet that subclasses from {@link org.apache.juneau.rest.RestServletDefault}.<br>
- This includes URL-encoding serialization/parsing support by default, in addition to several other media types.
- <li>Create a servlet that subclasses from {@link org.apache.juneau.rest.RestServlet} and specify the
- URL-encoding serializer and/or parser using the {@link org.apache.juneau.rest.annotation.RestResource#serializers()} and
- {@link org.apache.juneau.rest.annotation.RestResource#parsers()} on the entire servlet class, or
- the {@link org.apache.juneau.rest.annotation.RestMethod#serializers()} and {@link org.apache.juneau.rest.annotation.RestMethod#parsers()}
- annotations on individual methods within the class.
- <li>Register {@link org.apache.juneau.rest.jaxrs.DefaultProvider} with JAX-RS.<br>
- This includes URL-encoding serialization/parsing support by default, in addition to several other media types.
- <li>Create and register a subclass of {@link org.apache.juneau.rest.jaxrs.BaseProvider} and specify the serializers and parsers to use on JAX-RS resources.
- </ul>
- <p>
- In general, the Juneau REST server API is much more configurable and easier to use than JAX-RS, but beware that the author may be slightly biased in this statement.
- </p>
-
- <!-- ======================================================================================================== -->
- <a id="RestServletDefault"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.1 - Using RestServletDefault</h4>
- <div class='topic'>
- <p>
- The quickest way to implement a REST resource with URL-encoding support is to create a subclass of {@link org.apache.juneau.rest.RestServletDefault}.<br>
- This class provides support for JSON, XML, HTML, URL-Encoding, and others.
- </p>
- <p>
- The <code>AddressBookResource</code> example shown in the first chapter uses the <code>RestServletJenaDefault</code> class
- which is a subclass of <code>RestServletDefault</code> with additional support for RDF languages.<br>
- The start of the class definition is shown below:
- </p>
- <p class='bcode'>
- <jc>// Proof-of-concept resource that shows off the capabilities of working with POJO resources.
- // Consists of an in-memory address book repository.</jc>
- <ja>@RestResource</ja>(
- messages=<js>"nls/AddressBookResource"</js>,
- title=<js>"$L{title}"</js>,
- description=<js>"$L{description}"</js>,
- htmldoc=<ja>@HtmlDoc</ja>(
- links=<js>"{options:'?method=OPTIONS'}"</js>
- ),
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_useWhitespace</jsf>, value=<js>"true"</js>)
- },
- encoders=GzipEncoder.<jk>class</jk>
- )
- <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
- </p>
- <p>
- Notice how serializer and parser properties can be specified using the <code>@RestResource.properties()</code> annotation.<br>
- In this case, we're overriding the <jsf>SERIALIZER_useWhitespace</jsf> property to add whitespace to the output.
- The remaining properties are specific to the HTML serializer.
- </p>
- <p>
- The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the <code>messages</code> annotation.
- These variables are replaced at runtime based on the HTTP request locale.
- Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.
- See {@link org.apache.juneau.rest.RestContext#getVarResolver()} for more information.
- </p>
- <p>
- This document won't go into all the details of the Juneau <code>RestServlet</code> class.<br>
- Refer to the <a class='doclink' href='../rest/package-summary.html#TOC'>org.apache.juneau.rest</a> documentation for more information on the REST servlet class in general.
- </p>
- <p>
- The rest of the code in the resource class consists of REST methods that simply accept and return POJOs.<br>
- The framework takes care of all content negotiation, serialization/parsing, and error handling.<br>
- Below are 3 of those methods to give you a general idea of the concept:
- </p>
- <p class='bcode'>
- <jc>// GET person request handler</jc>
- <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/people/{id}/*"</js>, rc={200,404})
- <jk>public</jk> Person getPerson(RestRequest req, RestResponse res, <ja>@Path</ja> <jk>int</jk> id) throws Exception {
- res.setPageTitle(req.getPathInfo());
- <jk>return</jk> findPerson(id);
- }
-
- <jc>// POST person handler</jc>
- <ja>@RestMethod</ja>(name=<js>"POST"</js>, path=<js>"/people"</js>, guards=AdminGuard.<jk>class</jk>, rc={307,404})
- <jk>public void</jk> createPerson(RestResponse res, <ja>@Body</ja> CreatePerson cp) <jk>throws</jk> Exception {
- Person p = addressBook.createPerson(cp);
- res.sendRedirect(p.<jf>uri</jf>);
- }
-
- <jc>// DELETE person handler</jc>
- <ja>@RestMethod</ja>(name=<js>"DELETE"</js>, path=<js>"/people/{id}"</js>, guards=AdminGuard.<jk>class</jk>, rc={200,404})
- <jk>public</jk> String deletePerson(RestResponse res, <ja>@Path</ja> <jk>int</jk> id) <jk>throws</jk> Exception {
- Person p = findPerson(id);
- addressBook.remove(p);
- <jk>return</jk> <js>"DELETE successful"</js>;
- }
- </p>
- <p>
- The resource class can be registered with the web application like any other servlet, or can be
- defined as a child of another resource through the {@link org.apache.juneau.rest.annotation.RestResource#children()} annotation.
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="RestServlet"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.2 - Using RestServlet with annotations</h4>
- <div class='topic'>
- <p>
- For fine-tuned control of media types, the {@link org.apache.juneau.rest.RestServlet} class
- can be subclassed directly.<br>
- The serializers/parsers can be specified through annotations at the class and/or method levels.
- </p>
- <p>
- An equivalent <code>AddressBookResource</code> class could be defined to only support URL-encoding using
- the following definition:
- </p>
- <p class='bcode'>
- <ja>@RestResource</ja>(
- serializers={UrlEncodingSerializer.<jk>class</jk>},
- parsers={UrlEncodingParser.<jk>class</jk>},
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_useWhitespace</jsf>, value=<js>"true"</js>)
- }
- )
- <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServlet {
- </p>
- <p>
- Likewise, serializers and parsers can be specified/augmented/overridden at the method level like so:
- </p>
- <p class='bcode'>
- <jc>// GET person request handler</jc>
- <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/people/{id}/*"</js>, rc={200,404},
- serializers={UrlEncodingSerializer.<jk>class</jk>},
- parsers={UrlEncodingParser.<jk>class</jk>},
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_useWhitespace</jsf>, value=<js>"true"</js>)
- }
- )
- <jk>public</jk> Person getPerson(RestRequest req, RestResponse res, <ja>@Path</ja> <jk>int</jk> id) throws Exception {
- res.setPageTitle(req.getPathInfo());
- <jk>return</jk> findPerson(id);
- }
- </p>
- <p>
- The {@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit()} and
- {@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit()} control how various artifacts
- are inherited from the parent class.<br>
- Refer to <a class='doclink' href='../rest/package-summary.html#TOC'>org.apache.juneau.rest</a> for additional information on using these annotations.
- </p>
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="DefaultProvider"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.3 - Using JAX-RS DefaultProvider</h4>
- <div class='topic'>
- <p>
- URL-encoding media type support in JAX-RS can be achieved by using the {@link org.apache.juneau.rest.jaxrs.DefaultProvider} class.<br>
- It implements the JAX-RS <code>MessageBodyReader</code> and <code>MessageBodyWriter</code> interfaces for all Juneau supported media types.
- </p>
- <p>
- The <code>DefaultProvider</code> class definition is shown below:
- </p>
- <p class='bcode'>
- <ja>@Provider</ja>
- <ja>@Produces</ja>(
- <js>"application/json,text/json,"</js>+ <jc>// JsonSerializer</jc>
- <js>"application/json+simple,text/json+simple,"</js>+ <jc>// JsonSerializer.Simple</jc>
- <js>"application/json+schema,text/json+schema,"</js>+ <jc>// JsonSchemaSerializer</jc>
- <js>"text/xml,"</js>+ <jc>// XmlDocSerializer</jc>
- <js>"text/xml+simple,"</js>+ <jc>// XmlDocSerializer.Simple</jc>
- <js>"text/xml+schema,"</js>+ <jc>// XmlSchemaDocSerializer</jc>
- <js>"text/html,"</js>+ <jc>// HtmlDocSerializer</jc>
- <js>"text/uon,"</js>+ <jc>// UonSerializer</jc>
- <js>"application/x-www-form-urlencoded,"</js>+ <jc>// UrlEncodingSerializer</jc>
- <js>"text/xml+soap,"</js>+ <jc>// SoapXmlSerializer</jc>
- <js>"application/x-java-serialized-object"</js> <jc>// JavaSerializedObjectSerializer</jc>
- )
- <ja>@Consumes</ja>(
- <js>"application/json,text/json,"</js>+ <jc>// JsonParser</jc>
- <js>"text/xml,"</js>+ <jc>// XmlParser</jc>
- <js>"text/html,"</js>+ <jc>// HtmlParser</jc>
- <js>"text/uon,"</js>+ <jc>// UonParser</jc>
- <js>"application/x-www-form-urlencoded,"</js>+ <jc>// UrlEncodingParser</jc>
- <js>"application/x-java-serialized-object"</js> <jc>// JavaSerializedObjectParser</jc>
- )
- <ja>@JuneauProvider</ja>(
- serializers={
- JsonSerializer.<jk>class</jk>,
- JsonSerializer.Simple.<jk>class</jk>,
- JsonSchemaSerializer.<jk>class</jk>,
- XmlDocSerializer.<jk>class</jk>,
- XmlDocSerializer.Simple.<jk>class</jk>,
- XmlSchemaDocSerializer.<jk>class</jk>,
- HtmlDocSerializer.<jk>class</jk>,
- UonSerializer.<jk>class</jk>,
- UrlEncodingSerializer.<jk>class</jk>,
- SoapXmlSerializer.<jk>class</jk>,
- JavaSerializedObjectSerializer.<jk>class</jk>
- },
- parsers={
- JsonParser.<jk>class</jk>,
- XmlParser.<jk>class</jk>,
- HtmlParser.<jk>class</jk>,
- UonParser.<jk>class</jk>,
- UrlEncodingParser.<jk>class</jk>,
- JavaSerializedObjectParser.<jk>class</jk>,
- }
- )
- <jk>public final class</jk> DefaultProvider <jk>extends</jk> BaseProvider {}
- </p>
- <p>
- That's the entire class. It consists of only annotations to hook up media types to Juneau serializers and parsers.
- The <ja>@Provider</ja>, <ja>@Produces</ja>, and <ja>@Consumes</ja> annotations are standard JAX-RS annotations, and the <ja>@JuneauProvider</ja> annotation is from Juneau.
- </p>
- <p>
- To enable the provider, you need to make the JAX-RS environment aware of it.
- In Wink, this is accomplished by adding an entry to a config file.
- </p>
- <p class='bcode'>
- <xt><web-app</xt> <ua>version</ua>=<us>"2.3"</us><xt>></xt>
- <xt><servlet></xt>
- <xt><servlet-name></xt>WinkService<xt></servlet-name></xt>
- <xt><servlet-class></xt>org.apache.wink.server.internal.servlet.RestServlet<xt></servlet-class></xt>
- <xt><init-param></xt>
- <xt><param-name></xt>applicationConfigLocation<xt></param-name></xt>
- <xt><param-value></xt>/WEB-INF/wink.cfg<xt></param-value></xt>
- <xt></init-param></xt>
- <xt></servlet></xt>
- </p>
- <p>
- Simply include a reference to the provider in the configuration file.
- <p class='bcode'>
- org.apache.juneau.rest.jaxrs.DefaultProvider
- </p>
- <p>
- Properties can be specified on providers through the {@link org.apache.juneau.rest.jaxrs.JuneauProvider#properties()} annotation.<br>
- Properties can also be specified at the method level by using the {@link org.apache.juneau.rest.annotation.RestMethod#properties} annotation, like so:
- </p>
- <p class='bcode'>
- <ja>@GET</ja>
- <ja>@Produces</ja>(<js>"*/*"</js>)
- <ja>@RestMethod</ja>( <jc>/* Override some properties */</jc>
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_useWhitespace</jsf>, value=<js>"true"</js>)
- }
- )
- <jk>public</jk> Message getMessage() {
- <jk>return</jk> message;
- }
- </p>
- <h6 class='topic'>Limitations</h6>
- <p>
- In general, the Juneau REST API is considerably more flexible than the JAX-RS API, since you can specify and override
- serializers, parsers, properties, transforms, converters, guards, etc... at both the class and method levels.<br>
- Therefore, the JAX-RS API has the following limitations that the Juneau Server API does not:
- </p>
- <ul class='spaced-list'>
- <li>The ability to specify different media type providers at the class and method levels.<br>
- For example, you may want to use <code>JsonSerializer</code> with one set of properties on
- one class, and another instance with different properties on another class.<br>
- There is currently no way to define this at the class level.<br>
- You can override properties at the method level, but this can be cumbersome since it would have to be
- done for all methods in the resource.
- <li>The Juneau Server API allows you to manipulate properties programatically through the {@link org.apache.juneau.rest.RestResponse#setProperty(String,Object)}
- method, and through the {@link org.apache.juneau.rest.annotation.Properties} annotation.<br>
- There is no equivalent in JAX-RS.
- </ul>
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="BaseProvider"></a>
- <h4 class='topic' onclick='toggle(this)'>4.1.4 - Using JAX-RS BaseProvider with annotations</h4>
- <div class='topic'>
- <p>
- To provide support for only JSON media types, you can define your own provider class, like so:
- </p>
- <p class='bcode'>
- <ja>@Provider</ja>
- <ja>@Produces</ja>(
- <js>"application/x-www-form-urlencoded"</js> <jc>// UrlEncodingSerializer</jc>
- )
- <ja>@Consumes</ja>(
- <js>"application/x-www-form-urlencoded"</js> <jc>// UrlEncodingParser</jc>
- )
- <ja>@JuneauProvider</ja>(
- serializers={
- UrlEncodingSerializer.<jk>class</jk>
- },
- parsers={
- UrlEncodingParser.<jk>class</jk>,
- }
- properties={
- <ja>@Property</ja>(name=SerializerContext.<jsf>SERIALIZER_useWhitespace</jsf>, value=<js>"true"</js>)
- }
- )
- <jk>public final class</jk> MyUrlEncodingProvider <jk>extends</jk> BaseProvider {}
- </p>
- <p>
- Then register it with Wink the same way as <code>DefaultProvider</code>.
- </p>
- </div>
-
- </div>
-
- <!-- ======================================================================================================== -->
- <a id="RestClientSupport"></a>
- <h3 class='topic' onclick='toggle(this)'>4.2 - REST client support</h3>
- <div class='topic'>
- <p>
- The {@link org.apache.juneau.rest.client.RestClient} class provides an easy-to-use REST client interface with
- pluggable media type handling using any of the Juneau serializers and parsers.<br>
- Defining a client to support the URL-encoding media type on HTTP requests and responses can be done in one line of code:
- </p>
- <p class='bcode'>
- <jc>// Create a client to handle URL-encoded requests and responses.</jc>
- RestClient client = <uk>new</uk> RestClient(UrlEncodingSerializer.<uk>class</uk>, UrlEncodingParser.<uk>class</uk>);
- </p>
- <p>
- The client handles all content negotiation based on the registered serializers and parsers.
- </p>
- <p>
- The following code is pulled from the main method of the <code>ClientTest</code> class in the sample web application, and
- is run against the <code>AddressBookResource</code> class running within the sample app.<br>
- It shows how the client can be used to interact with the REST API while completely hiding the negotiated content type and working with nothing more than beans.
- </p>
- <h6 class='figure'>Example:</h6>
- <p class='bcode'>
- String root = <js>"http://localhost:9080/sample/addressBook"</js>;
-
- <jc>// Get the current contents of the address book</jc>
- AddressBook ab = client.doGet(root).getResponse(AddressBook.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Number of entries = "</js> + ab.size());
-
- <jc>// Delete the existing entries</jc>
- <jk>for</jk> (Person p : ab) {
- String r = client.doDelete(p.<jf>uri</jf>).getResponse(String.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Deleted person "</js> + p.<jf>name</jf> + <js>", response = "</js> + r);
- }
-
- <jc>// Make sure they're gone</jc>
- ab = client.doGet(root).getResponse(AddressBook.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Number of entries = "</js> + ab.size());
-
- <jc>// Add 1st person again</jc>
- CreatePerson cp = <jk>new</jk> CreatePerson(
- <js>"Barack Obama"</js>,
- <jsm>toCalendar</jsm>(<js>"Aug 4, 1961"</js>),
- <jk>new</jk> CreateAddress(<js>"1600 Pennsylvania Ave"</js>, <js>"Washington"</js>, <js>"DC"</js>, 20500, <jk>true</jk>),
- <jk>new</jk> CreateAddress(<js>"5046 S Greenwood Ave"</js>, <js>"Chicago"</js>, <js>"IL"</js>, 60615, <jk>false</jk>)
- );
- Person p = client.doPost(root + <js>"/people"</js>, cp).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created person "</js> + p.<jf>name</jf> + <js>", uri = "</js> + p.<jf>uri</jf>);
-
- <jc>// Add 2nd person again, but add addresses separately</jc>
- cp = <jk>new</jk> CreatePerson(
- <js>"George Walker Bush"</js>,
- toCalendar(<js>"Jul 6, 1946"</js>)
- );
- p = client.doPost(root + <js>"/people"</js>, cp).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created person "</js> + p.<jf>name</jf> + <js>", uri = "</js> + p.<jf>uri</jf>);
-
- <jc>// Add addresses to 2nd person</jc>
- CreateAddress ca = <jk>new</jk> CreateAddress(<js>"43 Prairie Chapel Rd"</js>, <js>"Crawford"</js>, <js>"TX"</js>, 76638, <jk>true</jk>);
- Address a = client.doPost(p.<jf>uri</jf> + <js>"/addresses"</js>, ca).getResponse(Address.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created address "</js> + a.<jf>uri</jf>);
-
- ca = <jk>new</jk> CreateAddress(<js>"1600 Pennsylvania Ave"</js>, <js>"Washington"</js>, <js>"DC"</js>, 20500, <jk>false</jk>);
- a = client.doPost(p.<jf>uri</jf> + "/addresses"</js>, ca).getResponse(Address.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Created address "</js> + a.<jf>uri</jf>);
-
- <jc>// Find 1st person, and change name</jc>
- Person[] pp = client.doGet(root + <js>"?q={name:\"'Barack+Obama'\"}"</js>).getResponse(Person[].<jk>class</jk>);
- String r = client.doPut(pp[0].<jf>uri</jf> + <js>"/name"</js>, <js>"Barack Hussein Obama"</js>).getResponse(String.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"Changed name, response = "</js> + r);
- p = client.doGet(pp[0].<jf>uri</jf>).getResponse(Person.<jk>class</jk>);
- System.<jsm>out</jsm>.println(<js>"New name = "</js> + p.<jf>name</jf>);
- </p>
- <h6 class='figure'>Results</h6>
- <p class='bcode'>
- Number of entries = 2
- Deleted person Barack Obama, response = DELETE successful
- Deleted person George Walker Bush, response = DELETE successful
- Number of entries = 0
- Created person Barack Obama, uri = http://localhost:9080/sample/addressBook/people/3
- Created person George Walker Bush, uri = http://localhost:9080/sample/addressBook/people/4
- Created address http://localhost:9080/sample/addressBook/addresses/7
- Created address http://localhost:9080/sample/addressBook/addresses/8
- Changed name, response = PUT successful
- New name = Barack Hussein Obama
- </p>
- </div>
-</div>
<p align="center"><i><b>*** fín ***</b></i></p>
</body>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java
index 75206db..fd7bd75 100644
--- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java
+++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java
@@ -20,8 +20,8 @@ import java.lang.annotation.*;
import org.apache.juneau.urlencoding.*;
/**
- * Annotation that can be applied to classes, fields, and methods to tweak how
- * they are handled by {@link UrlEncodingSerializer} and {@link UrlEncodingParser}.
+ * Annotation that can be applied to classes, fields, and methods to tweak how they are handled by
+ * {@link UrlEncodingSerializer} and {@link UrlEncodingParser}.
*/
@Documented
@Target({TYPE})
@@ -30,7 +30,7 @@ import org.apache.juneau.urlencoding.*;
public @interface UrlEncoding {
/**
- * When true, bean properties of type array or Collection will be expanded into multiple key=value pairings.
+ * When true, bean properties of type array or Collection will be expanded into multiple key/value pairings.
* <p>
* This annotation is identical in behavior to using the {@link UrlEncodingContext#URLENC_expandedParams}
* property, but applies to only instances of this bean.
[07/23] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/transform/AnnotationBeanFilterBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transform/AnnotationBeanFilterBuilder.java b/juneau-core/src/main/java/org/apache/juneau/transform/AnnotationBeanFilterBuilder.java
index 4b31f35..5b03cea 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transform/AnnotationBeanFilterBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/transform/AnnotationBeanFilterBuilder.java
@@ -30,7 +30,8 @@ public final class AnnotationBeanFilterBuilder extends BeanFilterBuilder {
* Constructor.
*
* @param annotatedClass The class found to have a {@link Bean @Bean} annotation.
- * @param annotations The {@link Bean @Bean} annotations found on the class and all parent classes in child-to-parent order.
+ * @param annotations The {@link Bean @Bean} annotations found on the class and all parent classes in
+ * child-to-parent order.
* @throws Exception Thrown from property namer constructor.
*/
public AnnotationBeanFilterBuilder(Class<?> annotatedClass, Map<Class<?>,Bean> annotations) throws Exception {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/transform/BeanFilter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transform/BeanFilter.java b/juneau-core/src/main/java/org/apache/juneau/transform/BeanFilter.java
index 931e701..0cdd606 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transform/BeanFilter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/transform/BeanFilter.java
@@ -24,7 +24,7 @@ import org.apache.juneau.annotation.*;
* <p>
* This class can be considered a programmatic equivalent to using the {@link Bean @Bean} annotation on bean classes.
* Thus, it can be used to perform the same function as the <code>@Bean</code> annotation when you don't have
- * the ability to annotate those classes (e.g. you don't have access to the source code).
+ * the ability to annotate those classes (e.g. you don't have access to the source code).
*/
public class BeanFilter {
@@ -48,11 +48,15 @@ public class BeanFilter {
this.stopClass = builder.stopClass;
this.sortProperties = builder.sortProperties;
this.propertyNamer = builder.propertyNamer;
- this.beanDictionary = builder.beanDictionary == null ? null : builder.beanDictionary.toArray(new Class<?>[builder.beanDictionary.size()]);
+ this.beanDictionary =
+ builder.beanDictionary == null
+ ? null
+ : builder.beanDictionary.toArray(new Class<?>[builder.beanDictionary.size()]);
}
/**
* Returns the bean class that this filter applies to.
+ *
* @return The bean class that this filter applies to.
*/
public Class<?> getBeanClass() {
@@ -70,7 +74,9 @@ public class BeanFilter {
/**
* Returns the set and order of names of properties associated with a bean class.
- * @return The name of the properties associated with a bean class, or <jk>null</jk> if all bean properties should be used.
+ *
+ * @return The name of the properties associated with a bean class, or <jk>null</jk> if all bean properties should
+ * be used.
*/
public String[] getProperties() {
return properties;
@@ -134,8 +140,7 @@ public class BeanFilter {
}
/**
- * Subclasses can override this property to convert property values to some other
- * object just before serialization.
+ * Subclasses can override this property to convert property values to some other object just before serialization.
*
* @param bean The bean from which the property was read.
* @param name The property name.
@@ -147,14 +152,13 @@ public class BeanFilter {
}
/**
- * Subclasses can override this property to convert property values to some other
- * object just before calling the bean setter.
+ * Subclasses can override this property to convert property values to some other object just before calling the
+ * bean setter.
*
* @param bean The bean from which the property was read.
* @param name The property name.
* @param value The value just parsed.
- * @return <jk>true</jk> if we set the property, <jk>false</jk> if we should allow the
- * framework to call the setter.
+ * @return <jk>true</jk> if we set the property, <jk>false</jk> if we should allow the framework to call the setter.
*/
public boolean writeProperty(Object bean, String name, Object value) {
return false;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/transform/BeanFilterBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transform/BeanFilterBuilder.java b/juneau-core/src/main/java/org/apache/juneau/transform/BeanFilterBuilder.java
index c166407..5312693 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transform/BeanFilterBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/transform/BeanFilterBuilder.java
@@ -78,7 +78,8 @@ public abstract class BeanFilterBuilder {
/**
* Specifies the set and order of names of properties associated with the bean class.
- * The order specified is the same order that the entries will be returned by the {@link BeanMap#entrySet()} and related methods.
+ * The order specified is the same order that the entries will be returned by the {@link BeanMap#entrySet()} and
+ * related methods.
* Entries in the list can also contain comma-delimited lists that will be split.
*
* @param properties The properties associated with the bean class.
@@ -130,8 +131,8 @@ public abstract class BeanFilterBuilder {
* <jsm>assertEquals</jsm>(<js>"{f0:'f0'}"</js>, r); <jc>// Note f1 is not serialized</jc>
* </p>
* <p>
- * Note that this filter can be used on the parent class so that it filters to all child classes,
- * or can be set individually on the child classes.
+ * Note that this filter can be used on the parent class so that it filters to all child classes, or can be set
+ * individually on the child classes.
*
* @param interfaceClass The interface class to use for this bean class.
* @return This object (for method chaining).
@@ -147,8 +148,8 @@ public abstract class BeanFilterBuilder {
* Identical in purpose to the stop class specified by {@link Introspector#getBeanInfo(Class, Class)}.
* Any properties in the stop class or in its base classes will be ignored during analysis.
* <p>
- * For example, in the following class hierarchy, instances of <code>C3</code> will include property <code>p3</code>, but
- * not <code>p1</code> or <code>p2</code>.
+ * For example, in the following class hierarchy, instances of <code>C3</code> will include property <code>p3</code>,
+ * but not <code>p1</code> or <code>p2</code>.
* <p class='bcode'>
* <jk>public class</jk> C1 {
* <jk>public int</jk> getP1();
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/transform/InterfaceBeanFilterBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transform/InterfaceBeanFilterBuilder.java b/juneau-core/src/main/java/org/apache/juneau/transform/InterfaceBeanFilterBuilder.java
index 5e7faa1..64e7d1a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transform/InterfaceBeanFilterBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/transform/InterfaceBeanFilterBuilder.java
@@ -21,11 +21,11 @@ import org.apache.juneau.annotation.*;
import org.apache.juneau.internal.*;
/**
- * Simple bean filter that simply identifies a class to be used as an interface
- * class for all child classes.
+ * Simple bean filter that simply identifies a class to be used as an interface class for all child classes.
* <p>
- * These objects are created when you pass in non-<code>BeanFilterBuilder</code> classes to {@link PropertyStore#addToProperty(String,Object)},
- * and are equivalent to adding a <code><ja>@Bean</ja>(interfaceClass=Foo.<jk>class</jk>)</code> annotation on the <code>Foo</code> class.
+ * These objects are created when you pass in non-<code>BeanFilterBuilder</code> classes to
+ * {@link PropertyStore#addToProperty(String,Object)}, and are equivalent to adding a
+ * <code><ja>@Bean</ja>(interfaceClass=Foo.<jk>class</jk>)</code> annotation on the <code>Foo</code> class.
*/
public class InterfaceBeanFilterBuilder extends BeanFilterBuilder {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 2986aaf..e6384fe 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
@@ -25,18 +25,20 @@ import org.apache.juneau.serializer.*;
*
* <h5 class='section'>Description:</h5>
* <p>
- * <code>PojoSwaps</code> are used to extend the functionality of the serializers and parsers to be able to handle POJOs
- * that aren't automatically handled by the serializers or parsers. For example, JSON does not have a standard
- * representation for rendering dates. By defining a special {@code Date} swap and associating it with a serializer and
- * parser, you can convert a {@code Date} object to a {@code String} during serialization, and convert that {@code String} object back into
- * a {@code Date} object during parsing.
+ * <code>PojoSwaps</code> are used to extend the functionality of the serializers and parsers to be able to handle
+ * POJOs that aren't automatically handled by the serializers or parsers. For example, JSON does not have a standard
+ * representation for rendering dates.
+ * By defining a special {@code Date} swap and associating it with a serializer and parser, you can convert a
+ * {@code Date} object to a {@code String} during serialization, and convert that {@code String} object back into a
+ * {@code Date} object during parsing.
* <p>
* Swaps MUST declare a public no-arg constructor so that the bean context can instantiate them.
* <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>
+ * <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
- * {@link BeanMap#get(Object)} or {@link BeanMap#put(String, Object)} methods are called.<br>
+ * {@link BeanMap#get(Object)} or {@link BeanMap#put(String, Object)} methods are called.
* <p>
* <code>PojoSwaps</code> have two parameters:
* <ol>
@@ -44,8 +46,11 @@ import org.apache.juneau.serializer.*;
* <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 {@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 {@link BeanMap#put(String,Object)}.
+ * {@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
+ * {@link BeanMap#put(String,Object)}.
*
* <h6 class='topic'>Subtypes</h6>
* <p>
@@ -57,15 +62,17 @@ import org.apache.juneau.serializer.*;
*
* <h6 class='topic'>Localization</h6>
* <p>
- * Swaps have access to the session locale and timezone through the {@link BeanSession#getLocale()} and {@link BeanSession#getTimeZone()}
- * methods. This allows you to specify localized swap values when needed.
- * If using the REST server API, the locale and timezone are set based on the <code>Accept-Language</code> and <code>Time-Zone</code> headers
- * on the request.
+ * Swaps have access to the session locale and timezone through the {@link BeanSession#getLocale()} and
+ * {@link BeanSession#getTimeZone()} methods.
+ * This allows you to specify localized swap values when needed.
+ * If using the REST server API, the locale and timezone are set based on the <code>Accept-Language</code> and
+ * <code>Time-Zone</code> headers on the request.
*
* <h6 class='topic'>Swap Class Type {@code <S>}</h6>
* <p>
- * The swapped object representation of an object must be an object type that the serializers can
- * natively convert to JSON (or language-specific equivalent). The list of valid transformed types are as follows...
+ * The swapped object representation of an object must be an object type that the serializers can natively convert to
+ * JSON (or language-specific equivalent).
+ * The list of valid transformed types are as follows...
* <ul class='spaced-list'>
* <li>{@link String}
* <li>{@link Number}
@@ -78,18 +85,20 @@ import org.apache.juneau.serializer.*;
*
* <h6 class='topic'>Normal Class Type {@code <T>}</h6>
* <p>
- * The normal object representation of an object.<br>
+ * The normal object representation of an object.
*
* <h6 class='topic'>One-way vs. Two-way Serialization</h6>
* <p>
* Note that while there is a unified interface for handling swaps during both serialization and parsing,
- * in many cases only one of the {@link #swap(BeanSession, Object)} or {@link #unswap(BeanSession, Object, ClassMeta)} methods will be defined
- * because the swap is one-way. For example, a swap may be defined to convert an {@code Iterator} to a {@code ObjectList}, but
- * it's not possible to unswap an {@code Iterator}. In that case, the {@code swap(Object}} method would
- * be implemented, but the {@code unswap(ObjectMap)} object would not, and the swap would be associated on
- * the serializer, but not the parser. Also, you may choose to serialize objects like {@code Dates} to readable {@code Strings},
- * in which case it's not possible to reparse it back into a {@code Date}, since there is no way for the {@code Parser} to
- * know it's a {@code Date} from just the JSON or XML text.
+ * in many cases only one of the {@link #swap(BeanSession, Object)} or {@link #unswap(BeanSession, Object, ClassMeta)}
+ * methods will be defined because the swap is one-way.
+ * For example, a swap may be defined to convert an {@code Iterator} to a {@code ObjectList}, but
+ * it's not possible to unswap an {@code Iterator}.
+ * In that case, the {@code swap(Object}} method would be implemented, but the {@code unswap(ObjectMap)} object would
+ * not, and the swap would be associated on the serializer, but not the parser.
+ * Also, you may choose to serialize objects like {@code Dates} to readable {@code Strings}, in which case it's not
+ * possible to re-parse it back into a {@code Date}, since there is no way for the {@code Parser} to know it's a
+ * {@code Date} from just the JSON or XML text.
*
* <h5 class='section'>Additional information:</h5>
* See <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.transform</a> for more information.
@@ -142,10 +151,10 @@ public abstract class PojoSwap<T,S> {
* <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.
* This is always going to be the same bean context that created this swap.
* @param o The object to be transformed.
- *
* @return The transformed object.
* @throws SerializeException If a problem occurred trying to convert the output.
*/
@@ -155,13 +164,13 @@ public abstract class PojoSwap<T,S> {
/**
* If this transform is to be used to reconstitute POJOs that aren't true Java beans, it must implement this method.
+ *
* @param session The bean session to use to get the class meta.
* This is always going to be the same bean context that created this swap.
* @param f The transformed object.
* @param hint If possible, the parser will try to tell you the object type being created. For example,
- * on a serialized date, this may tell you that the object being created must be of type {@code GregorianCalendar}.<br>
- * This may be <jk>null</jk> if the parser cannot make this determination.
- *
+ * on a serialized date, this may tell you that the object being created must be of type {@code GregorianCalendar}.
+ * <br>This may be <jk>null</jk> if the parser cannot make this determination.
* @return The narrowed object.
* @throws ParseException If this method is not implemented.
*/
@@ -179,10 +188,10 @@ public abstract class PojoSwap<T,S> {
}
/**
- * Returns the G class, the generialized form of the class.
+ * Returns the G class, the generalized form of the class.
* <p>
- * Subclasses must override this method if the generialized class is {@code Object},
- * meaning it can produce multiple generialized forms.
+ * Subclasses must override this method if the generalized class is {@code Object}, meaning it can produce multiple
+ * generalized forms.
*
* @return The transformed form of this class.
*/
@@ -209,7 +218,7 @@ public abstract class PojoSwap<T,S> {
*
* @param o The object to check.
* @return <jk>true</jk> if the specified object is a subclass of the normal class defined on this transform.
- * <jk>null</jk> always return <jk>false</jk>.
+ * <jk>null</jk> always return <jk>false</jk>.
*/
public boolean isNormalObject(Object o) {
if (o == null)
@@ -222,7 +231,7 @@ public abstract class PojoSwap<T,S> {
*
* @param o The object to check.
* @return <jk>true</jk> if the specified object is a subclass of the transformed class defined on this transform.
- * <jk>null</jk> always return <jk>false</jk>.
+ * <jk>null</jk> always return <jk>false</jk>.
*/
public boolean isSwappedObject(Object o) {
if (o == null)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 d6bdd39..a547340 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
@@ -24,8 +24,7 @@ import org.apache.juneau.serializer.*;
* Specialized {@link PojoSwap} for surrogate classes.
* <p>
* Surrogate classes are used in place of other classes during serialization.
- * For example, you may want to use a surrogate class to change the names or order of bean
- * properties on a bean.
+ * For example, you may want to use a surrogate class to change the names or order of bean properties on a bean.
* <p>
* The following is an example of a surrogate class change changes a property name:
* <p class='bcode'>
@@ -38,7 +37,7 @@ import org.apache.juneau.serializer.*;
* }
* </p>
* <p>
- * Optionally, a public static method can be used to untransform a class during parsing:
+ * Optionally, a public static method can be used to un-transform a class during parsing:
* <p class='bcode'>
* <jk>public class</jk> SurrogateClass {
* ...
@@ -53,13 +52,17 @@ import org.apache.juneau.serializer.*;
* <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 type
- * and returns an instance of the normal type. This is called the untransform method. The method can be called anything.
- * <li>If an untransform 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 untransform method).
+ * <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
+ * transformed class can be instantiated by the parser before being converted into the normal class by the
+ * un-transform method).
* </ul>
* <p>
- * Surrogate classes are associated with serializers and parsers using the {@link CoreObjectBuilder#pojoSwaps(Class...)} method.
+ * Surrogate classes are associated with serializers and parsers using the {@link CoreObjectBuilder#pojoSwaps(Class...)}
+ * method.
* <p class='bcode'>
* <ja>@Test</ja>
* <jk>public void</jk> test() <jk>throws</jk> Exception {
@@ -95,10 +98,10 @@ import org.apache.juneau.serializer.*;
* f2 = n.f1;
* }
*
- * <jc>// Constructor used during parsing (only needed if untransform method specified)</jc>
+ * <jc>// Constructor used during parsing (only needed if un-transform method specified)</jc>
* <jk>public</jk> Surrogate() {}
*
- * <jc>// Untransform method (optional)</jc>
+ * <jc>// Un-transform method (optional)</jc>
* <jk>public static</jk> Normal <jsm>toNormal</jsm>(Surrogate f) {
* Normal n = <jk>new</jk> Normal();
* n.f1 = f.f2;
@@ -107,7 +110,8 @@ import org.apache.juneau.serializer.*;
* }
* </p>
* <p>
- * It should be noted that a surrogate class is functionally equivalent to the following {@link PojoSwap} implementation:
+ * It should be noted that a surrogate class is functionally equivalent to the following {@link PojoSwap}
+ * implementation:
* <p class='bcode'>
* <jk>public static class</jk> SurrogateSwap <jk>extends</jk> PojoSwap<Normal,Surrogate> {
* <jk>public</jk> Surrogate swap(Normal n) <jk>throws</jk> SerializeException {
@@ -195,7 +199,8 @@ public class SurrogateSwap<T,F> extends PojoSwap<T,F> {
@SuppressWarnings("unchecked")
public T unswap(BeanSession session, F f, ClassMeta<?> hint) throws ParseException {
if (untransformMethod == null)
- throw new ParseException("static valueOf({0}) method not implement on surrogate class ''{1}''", f.getClass().getName(), getNormalClass().getName());
+ throw new ParseException("static valueOf({0}) method not implement on surrogate class ''{1}''",
+ f.getClass().getName(), getNormalClass().getName());
try {
return (T)untransformMethod.invoke(null, f);
} catch (Exception e) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 32f0413..a51c2e8 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
@@ -80,11 +80,13 @@
</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 serializable POJOs during serialization
- (and optionally vis-versa during parsing).
+ <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 objects to strings.
- <li>{@link org.apache.juneau.transform.MapSwap} - Convenience subclass for swaps that convert objects to maps.
+ <li>{@link org.apache.juneau.transform.StringSwap} - Convenience subclass for swaps that convert
+ objects to strings.
+ <li>{@link org.apache.juneau.transform.MapSwap} - Convenience subclass for swaps that convert
+ objects to maps.
</ol>
</li>
</ul>
@@ -120,10 +122,10 @@
<li>Define bean interface classes.
</ul>
<p>
- It should be noted that the {@link org.apache.juneau.annotation.Bean @Bean} annotation provides equivalent functionality
- through annotations.
- However, the <code>BeanFilter</code> class allows you to provide the same features when you do
- not have access to the source code.
+ It should be noted that the {@link org.apache.juneau.annotation.Bean @Bean} annotation provides equivalent
+ functionality through annotations.
+ 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>
@@ -212,11 +214,11 @@
<h6 class='topic'>Limiting bean properties to parent bean classes</h6>
<p>
- Occassionally, you may want to limit bean properties to some parent interface.
+ Occasionally, you may want to limit bean properties to some parent interface.
For example, in the <code>RequestEchoResource</code> class in the sample war file, we serialize instances of
- <code>HttpServletRequest</code> and <code>HttpServletResponse</code>.
+ <code>HttpServletRequest</code> and <code>HttpServletResponse</code>.
However, we really only want to serialize the properties defined on those specific APIs, not
- vendor-specific methods on the instances of those classes.
+ vendor-specific methods on the instances of those classes.
This can be done through the <code>interfaceClass</code> property of a bean filter.
</p>
<p>
@@ -234,7 +236,8 @@
}
</p>
<p>
- Suppose we only want to render the properties defined on <code>MyClass</code>, not those defined on child classes.
+ Suppose we only want to render the properties defined on <code>MyClass</code>, not those defined on child
+ classes.
To do so, we can define the following bean filter:
</p>
<p class='bcode'>
@@ -273,10 +276,10 @@
}
</p>
<p>
- Also, the <code>*BeanFilters(...)</code> methods will automatically interpret any non-<code>BeanFilter</code> classes
- passed in as meaning interface classes.
+ Also, the <code>*BeanFilters(...)</code> methods will automatically interpret any
+ non-<code>BeanFilter</code> classes passed in as meaning interface classes.
So in the previous example, the <code>BeanFilter</code> class could have been avoided altogether by just
- passing in <code>MyClass.<jk>class</jk></code> to the serializer, like so:
+ passing in <code>MyClass.<jk>class</jk></code> to the serializer, like so:
</p>
<p class='bcode'>
<jc>// Serialize to JSON</jc>
@@ -297,8 +300,8 @@
<h6 class='topic'>Allowing non-public bean classes/methods/fields to be used by the framework</h6>
<p>
- By default, only public classes are interpreted as beans. Non-public classes are treated as 'other' POJOs that
- are typically just serialized to strings using the <code>toString()</code> method.
+ By default, only public classes are interpreted as beans. Non-public classes are treated as 'other' POJOs
+ that are typically just serialized to strings using the <code>toString()</code> method.
Likewise, by default, only public fields/methods are interpreted as bean properties.
</p>
<p>
@@ -312,8 +315,8 @@
<li>{@link org.apache.juneau.BeanContext#BEAN_beanFieldVisibility}
</ul>
<p>
- Also, specifying a {@link org.apache.juneau.annotation.BeanProperty @BeanProperty} annotation on non-public getters/setters/fields
- will also allow them to be detected by the framework.
+ Also, specifying a {@link org.apache.juneau.annotation.BeanProperty @BeanProperty} annotation on non-public
+ getters/setters/fields will also allow them to be detected by the framework.
</p>
<p class='bcode'>
<jk>public class</jk> MyBean {
@@ -344,15 +347,20 @@
They allow the Juneau serializers and parsers to be extended to handle virtually any kind of Java object.
</p>
<p>
- As explained in the overview, Juneau has built-in support for serializing and parsing specific kinds of objects, like primitive objects, bean, maps, collections, and arrays.
- Other kinds of POJOs, such as {@code Date} objects, cannot be serialized properly, since they are not true beans.
+ As explained in the overview, Juneau has built-in support for serializing and parsing specific kinds of
+ objects, like primitive objects, bean, maps, collections, and arrays.
+ Other kinds of POJOs, such as {@code Date} objects, cannot be serialized properly, since they are not true
+ beans.
This is where <code>PojoSwaps</code> come into play.
</p>
<p>
- The purpose of an <code>PojoSwap</code> is to convert a non-serializable object to a serializable surrogate form during serialization, and to optionally convert that surrogate form back into the original object during parsing.
+ The purpose of an <code>PojoSwap</code> is to convert a non-serializable object to a serializable surrogate
+ form during serialization, and to optionally convert that surrogate form back into the original object
+ during parsing.
</p>
<p>
- For example, the following swap can be used to convert {@link java.util.Date} objects to ISO8601 strings during serialization, and {@link java.util.Date} objects from ISO8601 string during parsing:
+ For example, the following swap can be used to convert {@link java.util.Date} objects to ISO8601 strings
+ during serialization, and {@link java.util.Date} objects from ISO8601 string during parsing:
</p>
<p class='bcode'>
<jc>// Sample swap for converting Dates to ISO8601 strings.</jc>
@@ -397,7 +405,9 @@
<jk>int</jk> day = bean.<jf>date</jf>.getDay(); <jc>// == 3</jc>
</p>
<p>
- In addition, the {@link org.apache.juneau.BeanMap#get(Object)} and {@link org.apache.juneau.BeanMap#put(String,Object)} methods will automatically convert to swapped values as the following example shows:
+ In addition, the {@link org.apache.juneau.BeanMap#get(Object)} and
+ {@link org.apache.juneau.BeanMap#put(String,Object)} methods will automatically convert to swapped values
+ as the following example shows:
</p>
<p class='bcode'>
<jc>// Create a new bean context and add our swap.</jc>
@@ -471,22 +481,31 @@
a2 = parser.parse(s2, <jk>byte</jk>[][].<jk>class</jk>); <jc>// Reproduces {{1,2,3},{4,5,6},null}</jc>
</p>
<p>
- It should be noted that the sample swaps shown above have already been implemented in the <a class='doclink' href='../transforms/package-summary.html#TOC'>org.apache.juneau.transforms</a> package.
+ It should be noted that the sample swaps shown above have already been implemented in the
+ <a class='doclink' href='../transforms/package-summary.html#TOC'>org.apache.juneau.transforms</a> package.
The following are a list of out-of-the-box swaps:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.transforms.ByteArrayBase64Swap} - Converts byte arrays to BASE64 encoded strings.
- <li>{@link org.apache.juneau.transforms.CalendarSwap} - Swaps for converting <code>Calendar</code> objects to various date format strings.
- <li>{@link org.apache.juneau.transforms.DateSwap} - Swaps for converting <code>Date</code> objects to various date format strings.
- <li>{@link org.apache.juneau.transforms.EnumerationSwap} - Swaps for converting <code>Enumeration</code> objects to arrays.
- <li>{@link org.apache.juneau.transforms.IteratorSwap} - Swaps for converting <code>Iterator</code> objects to arrays.
- <li>{@link org.apache.juneau.transforms.ReaderSwap} - Swaps for converting <code>Readers</code> to objects before serialization.
- <li>{@link org.apache.juneau.transforms.XMLGregorianCalendarSwap} - Swaps for converting <code>XMLGregorianCalendar</code> objects to ISO8601 strings.
+ <li>{@link org.apache.juneau.transforms.ByteArrayBase64Swap}
+ - Converts byte arrays to BASE64 encoded strings.
+ <li>{@link org.apache.juneau.transforms.CalendarSwap}
+ - Swaps for converting <code>Calendar</code> objects to various date format strings.
+ <li>{@link org.apache.juneau.transforms.DateSwap}
+ - Swaps for converting <code>Date</code> objects to various date format strings.
+ <li>{@link org.apache.juneau.transforms.EnumerationSwap}
+ - Swaps for converting <code>Enumeration</code> objects to arrays.
+ <li>{@link org.apache.juneau.transforms.IteratorSwap}
+ - Swaps for converting <code>Iterator</code> objects to arrays.
+ <li>{@link org.apache.juneau.transforms.ReaderSwap}
+ - Swaps for converting <code>Readers</code> to objects before serialization.
+ <li>{@link org.apache.juneau.transforms.XMLGregorianCalendarSwap}
+ - Swaps for converting <code>XMLGregorianCalendar</code> objects to ISO8601 strings.
</ul>
<h6 class='topic'>Valid swapped class types</h6>
<p>
- The swapped class type can be any serializable class type as defined in the <a href='../../../../overview-summary.html#Core.PojoCategories'>POJO categories</a> table.
+ The swapped class type can be any serializable class type as defined in the
+ <a href='../../../../overview-summary.html#Core.PojoCategories'>POJO categories</a> table.
</p>
</div>
@@ -496,8 +515,10 @@
<h3 class='topic' onclick='toggle(this)'>1.3 - One-Way PojoSwaps</h3>
<div class='topic'>
<p>
- In the previous section, we defined two-way swaps, meaning swaps where the original objects could be reconstructing during parsing. '
- However, there are certain kinds of POJOs that we may want to support for serializing, but that are not possible to reconstruct during parsing.
+ In the previous section, we defined two-way swaps, meaning swaps where the original objects could be
+ reconstructing during parsing.
+ However, there are certain kinds of POJOs that we may want to support for serializing, but that are not
+ possible to reconstruct during parsing.
For these, we can use one-way object swaps.
</p>
<p>
@@ -506,7 +527,8 @@
</p>
<p>
An example of a one-way swaps would be one that allows {@code Iterators} to be serialized as JSON arrays.
- It can make sense to be able to render {@code Iterators} as arrays, but in general it's not possible to reconstruct an {@code Iterator} during parsing.
+ It can make sense to be able to render {@code Iterators} as arrays, but in general it's not possible to
+ reconstruct an {@code Iterator} during parsing.
</p>
<p class='bcode'>
<jk>public class</jk> IteratorSwap <jk>extends</jk> PojoSwap<Iterator,List> {
@@ -522,7 +544,8 @@
</p>
<p>
Here is an example of our one-way swap being used.
- Note that trying to parse the original object will cause a {@link org.apache.juneau.parser.ParseException} to be thrown.
+ Note that trying to parse the original object will cause a {@link org.apache.juneau.parser.ParseException}
+ to be thrown.
</p>
<p class='bcode'>
<jc>// Create a JSON serializer that can serialize Iterators.</jc>
@@ -545,7 +568,7 @@
<h3 class='topic' onclick='toggle(this)'>1.4 - Stop Classes</h3>
<div class='topic'>
<p>
- Occassionally, you may want to limit bean properties to only those defined on a parent class or interface.
+ Occasionally, you may want to limit bean properties to only those defined on a parent class or interface.
There are a couple of ways of doing this.
</p>
<p>
@@ -563,7 +586,8 @@
}
</p>
<p>
- Suppose we only want to render the properties defined on <code>MyClass</code>, not those defined on child classes.
+ Suppose we only want to render the properties defined on <code>MyClass</code>, not those defined on
+ child classes.
To do so, we can define the following bean filter:
</p>
<p class='bcode'>
@@ -602,8 +626,10 @@
}
</p>
<p>
- Also, the <code>beanFilters()</code> methods will automatically interpret any non-<code>BeanFilter</code> classes passed in as meaning interface classes.
- So in the previous example, the <code>BeanFilter</code> class could have been avoided altogether by just passing in <code>MyClass.<jk>class</jk></code> to the serializer, like so:
+ Also, the <code>beanFilters()</code> methods will automatically interpret any non-<code>BeanFilter</code>
+ classes passed in as meaning interface classes.
+ So in the previous example, the <code>BeanFilter</code> class could have been avoided altogether by just
+ passing in <code>MyClass.<jk>class</jk></code> to the serializer, like so:
</p>
<p class='bcode'>
<jc>// Serialize to JSON</jc>
@@ -616,11 +642,12 @@
<h3 class='topic' onclick='toggle(this)'>1.5 - Surrogate Classes</h3>
<div class='topic'>
<p>
- Surrogate classes are very similar in concept to one-way <code>PojoSwaps</code> except they represent a simpler syntax.
+ Surrogate classes are very similar in concept to one-way <code>PojoSwaps</code> except they represent a
+ simpler syntax.
</p>
<p>
- For example, let's say we want to be able to serialize the following class, but it's not serializable for some reason (for example, there are no
- properties exposed):
+ For example, let's say we want to be able to serialize the following class, but it's not serializable for
+ some reason (for example, there are no properties exposed):
<p class='bcode'>
<jk>public class</jk> MyNonSerializableClass {
<jk>protected</jk> String <jf>foo</jf>;
@@ -645,7 +672,8 @@
}
</p>
<p>
- However, the same can be accomplished by using a surrogate class that simply contains a constructor with the non-serializable class as an argument:
+ However, the same can be accomplished by using a surrogate class that simply contains a constructor with
+ the non-serializable class as an argument:
</p>
<p class='bcode'>
<jk>public class</jk> MySerializableSurrogate {
@@ -664,7 +692,8 @@
Serializer serializer = <jk>new</jk> JsonSerializerBuilder().pojoSwaps(MySerializableSurrogate.<jk>class</jk>).build();
</p>
<p>
- When the serializer encounters the non-serializable class, it will serialize an instance of the surrogate instead.
+ When the serializer encounters the non-serializable class, it will serialize an instance of the surrogate
+ instead.
</p>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java
index f438551..ce8df39 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java
@@ -19,10 +19,12 @@ import org.apache.juneau.transform.*;
* Transforms beans into {@link String Strings} by simply calling the {@link Object#toString()} method.
* <p>
* Allows you to specify classes that should just be converted to {@code Strings} instead of potentially
- * being turned into Maps by the {@link BeanContext} (or worse, throwing {@link BeanRuntimeException BeanRuntimeExceptions}).
+ * being turned into Maps by the {@link BeanContext} (or worse, throwing
+ * {@link BeanRuntimeException BeanRuntimeExceptions}).
* <p>
* This is usually a one-way transform.
- * Beans serialized as strings cannot be reconstituted using a parser unless it is a <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">Type 5 POJO</a>.
+ * Beans serialized as strings cannot be reconstituted using a parser unless it is a
+ * <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">Type 5 POJO</a>.
*
* @param <T> The class type of the bean.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 02294ab..498a8b7 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
@@ -76,9 +76,8 @@ public class CalendarSwap extends StringSwap<Calendar> {
* @param timeStyle The {@link DateFormat} time style (e.g. {@link DateFormat#SHORT}).
* Ignored if <code>pattern</code> is not <jk>null</jk>.
* Ignored if <code>-1</code>.
- * @param timeZone The timeZone to use for dates. If <jk>null</jk> then either the
- * timezone specified on the {@link Calendar} object or the timezone returned
- * by {@link BeanSession#getTimeZone()} is used.
+ * @param timeZone The timeZone to use for dates. If <jk>null</jk> then either the timezone specified on the
+ * {@link Calendar} object or the timezone returned by {@link BeanSession#getTimeZone()} is used.
*/
protected CalendarSwap(String pattern, int dateStyle, int timeStyle, TimeZone timeZone) {
this.pattern = pattern;
@@ -91,7 +90,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
* Transforms {@link Calendar Calendars} to {@link String Strings} using the {@code Date.toString()} method.
*
* <h5 class='section'>Example output:</h5>
- * <ul>
+ * <ul>
* <li><js>"Wed Jul 04 15:30:45 EST 2001"</js>
* </ul>
*/
@@ -524,9 +523,10 @@ public class CalendarSwap extends StringSwap<Calendar> {
* Returns the {@link DateFormat} object for this session for formatting dates.
*
* @param session The current bean session.
- * @param c Optional <code>Calendar</code> object to copy <code>TimeZone</code> from if not specified in session or <code>timeZone</code> setting.
- * @return The {@link DateFormat} object. Multiple calls to this method on the same
- * session will return a cached copy of date format object.
+ * @param c Optional <code>Calendar</code> object to copy <code>TimeZone</code> from if not specified in session or
+ * <code>timeZone</code> setting.
+ * @return The {@link DateFormat} object. Multiple calls to this method on the same session will return a cached
+ * copy of date format object.
*/
protected DateFormat getDateFormat(BeanSession session, Calendar c) {
DateFormat df = session.getFromCache(DateFormat.class, this.getClass().getName());
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 3de5ba3..94b27b1 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
@@ -76,8 +76,8 @@ public class DateSwap extends StringSwap<Date> {
* @param timeStyle The {@link DateFormat} time style (e.g. {@link DateFormat#SHORT}).
* Ignored if <code>pattern</code> is not <jk>null</jk>.
* Ignored if <code>-1</code>.
- * @param timeZone The timeZone to use for dates. If <jk>null</jk> then the timezone returned
- * by {@link BeanSession#getTimeZone()} is used.
+ * @param timeZone The timeZone to use for dates. If <jk>null</jk> then the timezone returned by
+ * {@link BeanSession#getTimeZone()} is used.
*/
protected DateSwap(String pattern, int dateStyle, int timeStyle, TimeZone timeZone) {
this.pattern = pattern;
@@ -90,7 +90,7 @@ public class DateSwap extends StringSwap<Date> {
* Transforms {@link Date Dates} to {@link String Strings} using the {@code Date.toString()} method.
*
* <h5 class='section'>Example output:</h5>
- * <ul>
+ * <ul>
* <li><js>"Wed Jul 04 15:30:45 EST 2001"</js>
* </ul>
*/
@@ -531,8 +531,8 @@ public class DateSwap extends StringSwap<Date> {
* Returns the {@link DateFormat} object for this session for formatting dates.
*
* @param session The current bean session.
- * @return The {@link DateFormat} object. Multiple calls to this method on the same
- * session will return a cached copy of date format object.
+ * @return The {@link DateFormat} object. Multiple calls to this method on the same session will return a cached
+ * copy of date format object.
*/
protected DateFormat getDateFormat(BeanSession session) {
DateFormat df = session.getFromCache(DateFormat.class, this.getClass().getName());
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 cbca731..b8e9011 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
@@ -29,8 +29,8 @@ import org.apache.juneau.xml.*;
*
* <h5 class='section'>Description:</h5>
* <p>
- * The {@code Reader} must contain JSON, Juneau-generated XML (output from {@link XmlSerializer}),
- * or Juneau-generated HTML (output from {@link JsonSerializer}) in order to be parsed correctly.
+ * The {@code Reader} must contain JSON, Juneau-generated XML (output from {@link XmlSerializer}), or Juneau-generated
+ * HTML (output from {@link JsonSerializer}) in order to be parsed correctly.
* <p>
* Useful for serializing models that contain {@code Readers} created by {@code RestCall} instances.
* <p>
@@ -91,8 +91,7 @@ public class ReaderSwap extends PojoSwap<Reader,Object> {
}
/**
- * Converts the specified {@link Reader} to an {@link Object} whose type is determined
- * by the contents of the reader.
+ * Converts the specified {@link Reader} to an {@link Object} whose type is determined by the contents of the reader.
*/
@Override /* PojoSwap */
public Object swap(BeanSession session, Reader o) throws SerializeException {
@@ -103,7 +102,8 @@ public class ReaderSwap extends PojoSwap<Reader,Object> {
} catch (IOException e) {
return e.getLocalizedMessage();
} catch (Exception e) {
- throw new SerializeException("ReaderSwap could not transform object of type ''{0}''", o == null ? null : o.getClass().getName()).initCause(e);
+ throw new SerializeException("ReaderSwap could not transform object of type ''{0}''",
+ o == null ? null : o.getClass().getName()).initCause(e);
}
}
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/transforms/StringFormatSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/StringFormatSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/StringFormatSwap.java
index 842b261..bb05ab1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transforms/StringFormatSwap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/transforms/StringFormatSwap.java
@@ -27,6 +27,7 @@ public class StringFormatSwap extends StringSwap<Object> {
/**
* Constructor.
+ *
* @param format The string format string.
*/
public StringFormatSwap(String format) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/transforms/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/package.html b/juneau-core/src/main/java/org/apache/juneau/transforms/package.html
index a8de183..5853f5e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transforms/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/transforms/package.html
@@ -61,6 +61,7 @@
This package contains various predefined instances of transforms for commonly-serialized/parsed class types.
</p>
<p>
- See <a class='doclink' href='../transform/package-summary.html#TOC'>org.apache.juneau.transform</a> for more information about transforms.
+ See <a class='doclink' href='../transform/package-summary.html#TOC'>org.apache.juneau.transform</a> for more
+ information about transforms.
</p>
</body>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/uon/UonParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonParser.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonParser.java
index a455178..7985742 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/UonParser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonParser.java
@@ -66,6 +66,7 @@ public class UonParser extends ReaderParser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public Decoding(PropertyStore propertyStore) {
@@ -83,6 +84,7 @@ public class UonParser extends ReaderParser {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public UonParser(PropertyStore propertyStore) {
@@ -102,12 +104,14 @@ public class UonParser extends ReaderParser {
* @param eType The class type being parsed, or <jk>null</jk> if unknown.
* @param r The reader being parsed.
* @param outer The outer object (for constructing nested inner classes).
- * @param isUrlParamValue If <jk>true</jk>, then we're parsing a top-level URL-encoded value which is treated a bit different than the default case.
+ * @param isUrlParamValue If <jk>true</jk>, then we're parsing a top-level URL-encoded value which is treated a bit
+ * different than the default case.
* @param pMeta The current bean property being parsed.
* @return The parsed object.
* @throws Exception
*/
- protected <T> T parseAnything(UonParserSession session, ClassMeta<T> eType, ParserReader r, Object outer, boolean isUrlParamValue, BeanPropertyMeta pMeta) throws Exception {
+ protected <T> T parseAnything(UonParserSession session, ClassMeta<T> eType, ParserReader r, Object outer,
+ boolean isUrlParamValue, BeanPropertyMeta pMeta) throws Exception {
if (eType == null)
eType = (ClassMeta<T>)object();
@@ -175,12 +179,20 @@ public class UonParser extends ReaderParser {
o = session.cast(m, pMeta, eType);
// Handle case where it's a collection, but only a single value was specified.
else {
- Collection l = (sType.canCreateNewInstance(outer) ? (Collection)sType.newInstance(outer) : new ObjectList(session));
+ Collection l = (
+ sType.canCreateNewInstance(outer)
+ ? (Collection)sType.newInstance(outer)
+ : new ObjectList(session)
+ );
l.add(m.cast(sType.getElementType()));
o = l;
}
} else {
- Collection l = (sType.canCreateNewInstance(outer) ? (Collection)sType.newInstance(outer) : new ObjectList(session));
+ Collection l = (
+ sType.canCreateNewInstance(outer)
+ ? (Collection)sType.newInstance(outer)
+ : new ObjectList(session)
+ );
o = parseIntoCollection(session, r, l, sType, isUrlParamValue, pMeta);
}
} else if (sType.canCreateNewBean(outer)) {
@@ -217,12 +229,14 @@ public class UonParser extends ReaderParser {
if (m.containsKey(session.getBeanTypePropertyName(sType)))
o = session.cast(m, pMeta, eType);
else
- throw new ParseException(session, "Class ''{0}'' could not be instantiated. Reason: ''{1}''", sType.getInnerClass().getName(), sType.getNotABeanReason());
+ throw new ParseException(session, "Class ''{0}'' could not be instantiated. Reason: ''{1}''",
+ sType.getInnerClass().getName(), sType.getNotABeanReason());
} else if (c == 'n') {
r.read();
parseNull(session, r);
} else {
- throw new ParseException(session, "Class ''{0}'' could not be instantiated. Reason: ''{1}''", sType.getInnerClass().getName(), sType.getNotABeanReason());
+ throw new ParseException(session, "Class ''{0}'' could not be instantiated. Reason: ''{1}''",
+ sType.getInnerClass().getName(), sType.getNotABeanReason());
}
if (o == null && sType.isPrimitive())
@@ -236,7 +250,8 @@ public class UonParser extends ReaderParser {
return (T)o;
}
- private <K,V> Map<K,V> parseIntoMap(UonParserSession session, ParserReader r, Map<K,V> m, ClassMeta<K> keyType, ClassMeta<V> valueType, BeanPropertyMeta pMeta) throws Exception {
+ private <K,V> Map<K,V> parseIntoMap(UonParserSession session, ParserReader r, Map<K,V> m, ClassMeta<K> keyType,
+ ClassMeta<V> valueType, BeanPropertyMeta pMeta) throws Exception {
if (keyType == null)
keyType = (ClassMeta<K>)string();
@@ -322,7 +337,8 @@ public class UonParser extends ReaderParser {
return null; // Unreachable.
}
- private <E> Collection<E> parseIntoCollection(UonParserSession session, ParserReader r, Collection<E> l, ClassMeta<E> type, boolean isUrlParamValue, BeanPropertyMeta pMeta) throws Exception {
+ private <E> Collection<E> parseIntoCollection(UonParserSession session, ParserReader r, Collection<E> l,
+ ClassMeta<E> type, boolean isUrlParamValue, BeanPropertyMeta pMeta) throws Exception {
int c = r.readSkipWs();
if (c == -1 || c == AMP)
@@ -355,14 +371,16 @@ public class UonParser extends ReaderParser {
if (state == S1 || state == S2) {
if (c == ')') {
if (state == S2) {
- l.add((E)parseAnything(session, type.isArgs() ? type.getArg(argIndex++) : type.getElementType(), r.unread(), l, false, pMeta));
+ l.add((E)parseAnything(session, type.isArgs() ? type.getArg(argIndex++) : type.getElementType(),
+ r.unread(), l, false, pMeta));
r.read();
}
return l;
} else if (Character.isWhitespace(c)) {
skipSpace(r);
} else {
- l.add((E)parseAnything(session, type.isArgs() ? type.getArg(argIndex++) : type.getElementType(), r.unread(), l, false, pMeta));
+ l.add((E)parseAnything(session, type.isArgs() ? type.getArg(argIndex++) : type.getElementType(),
+ r.unread(), l, false, pMeta));
state = S3;
}
} else if (state == S3) {
@@ -389,7 +407,8 @@ public class UonParser extends ReaderParser {
if (Character.isWhitespace(c)) {
skipSpace(r);
} else {
- l.add((E)parseAnything(session, type.isArgs() ? type.getArg(argIndex++) : type.getElementType(), r.unread(), l, false, pMeta));
+ l.add((E)parseAnything(session, type.isArgs() ? type.getArg(argIndex++) : type.getElementType(),
+ r.unread(), l, false, pMeta));
state = S2;
}
} else if (state == S2) {
@@ -587,7 +606,8 @@ public class UonParser extends ReaderParser {
/**
- * Returns true if the next character in the stream is preceeded by an escape '~' character.
+ * Returns true if the next character in the stream is preceded by an escape '~' character.
+ *
* @param c The current character.
* @param r The reader.
* @param prevIsInEscape What the flag was last time.
@@ -738,7 +758,8 @@ public class UonParser extends ReaderParser {
//--------------------------------------------------------------------------------
@Override /* Parser */
- public UonParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public UonParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale,
+ TimeZone timeZone, MediaType mediaType) {
return new UonParserSession(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 e4eccd1..2dcf520 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
@@ -35,6 +35,7 @@ public class UonParserBuilder extends ParserBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public UonParserBuilder(PropertyStore propertyStore) {
@@ -61,8 +62,8 @@ public class UonParserBuilder extends ParserBuilder {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <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.
+ * 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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 5ce1d9b..49764ee 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,9 +26,11 @@ 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> - Properties associated with handling beans on serializers and parsers.
+ * <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.
+ * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
+ * - Configurable properties common to all parsers.
* </ul>
* </ul>
*/
@@ -44,8 +46,8 @@ public class UonParserContext extends ParserContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <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.
+ * 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.
*/
public static final String UON_decodeChars = "UonParser.decodeChars";
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/uon/UonParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserSession.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserSession.java
index a5ba78d..95f685a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserSession.java
@@ -36,7 +36,7 @@ public class UonParserSession extends ParserSession {
* Create a new session using properties specified in the context.
*
* @param ctx The context creating this session object.
- * he context contains all the configuration settings for this object.
+ * The context contains all the configuration settings for this object.
* @param input The input. Can be any of the following types:
* <ul>
* <li><jk>null</jk>
@@ -55,7 +55,8 @@ public class UonParserSession extends ParserSession {
* If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
*/
- public UonParserSession(UonParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
+ public UonParserSession(UonParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer,
+ Locale locale, TimeZone timeZone, MediaType mediaType) {
super(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);
if (op == null || op.isEmpty()) {
decodeChars = ctx.decodeChars;
@@ -67,17 +68,18 @@ public class UonParserSession extends ParserSession {
/**
* Create a specialized parser session for parsing URL parameters.
* <p>
- * The main difference is that characters are never decoded, and the {@link UonParserContext#UON_decodeChars} property is always ignored.
+ * The main difference is that characters are never decoded, and the {@link UonParserContext#UON_decodeChars}
+ * property is always ignored.
*
* @param ctx The context to copy setting from.
* @param input The input. Can be any of the following types:
- * <ul>
- * <li><jk>null</jk>
- * <li>{@link Reader}
- * <li>{@link CharSequence} (e.g. {@link String})
- * <li>{@link InputStream} - Read as UTF-8 encoded character stream.
- * <li>{@link File} - Read as system-default encoded stream.
- * </ul>
+ * <ul>
+ * <li><jk>null</jk>
+ * <li>{@link Reader}
+ * <li>{@link CharSequence} (e.g. {@link String})
+ * <li>{@link InputStream} - Read as UTF-8 encoded character stream.
+ * <li>{@link File} - Read as system-default encoded stream.
+ * </ul>
*/
public UonParserSession(UonParserContext ctx, Object input) {
super(ctx, null, input, null, null, null, null, null);
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializer.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializer.java
index 8bd45e0..346645e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializer.java
@@ -35,7 +35,8 @@ import org.apache.juneau.transform.*;
*
* <h5 class='section'>Description:</h5>
* <p>
- * This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient.
+ * This serializer provides several serialization options.
+ * Typically, one of the predefined DEFAULT serializers will be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
*
* <h5 class='section'>Configurable properties:</h5>
@@ -122,7 +123,8 @@ import org.apache.juneau.transform.*;
* <jk>public int</jk> getZip();
* }
*
- * Person p = <jk>new</jk> Person(<js>"John Doe"</js>, 23, <js>"123 Main St"</js>, <js>"Anywhere"</js>, <js>"NY"</js>, 12345, <jk>false</jk>);
+ * Person p = <jk>new</jk> Person(<js>"John Doe"</js>, 23, <js>"123 Main St"</js>, <js>"Anywhere"</js>,
+ * <js>"NY"</js>, 12345, <jk>false</jk>);
*
* <jc>// Produces "(name='John Doe',age=23,address=(street='123 Main St',city=Anywhere,state=NY,zip=12345),deceased=false)"</jc>
* String s = UonSerializer.<jsf>DEFAULT</jsf>.serialize(s);
@@ -147,6 +149,7 @@ public class UonSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public Readable(PropertyStore propertyStore) {
@@ -166,6 +169,7 @@ public class UonSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public Encoding(PropertyStore propertyStore) {
@@ -183,6 +187,7 @@ public class UonSerializer extends WriterSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public UonSerializer(PropertyStore propertyStore) {
@@ -196,15 +201,16 @@ public class UonSerializer extends WriterSerializer {
}
/**
- * Workhorse method. Determines the type of object, and then calls the
- * appropriate type-specific serialization method.
+ * Workhorse method. Determines the type of object, and then calls the appropriate type-specific serialization
+ * method.
+ *
* @param session The context that exist for the duration of a serialize.
* @param out The writer to serialize to.
* @param o The object being serialized.
* @param eType The expected type of the object if this is a bean property.
- * @param attrName The bean property name if this is a bean property. <jk>null</jk> if this isn't a bean property being serialized.
+ * @param attrName The bean property name if this is a bean property.
+ * <jk>null</jk> if this isn't a bean property being serialized.
* @param pMeta The bean property metadata.
- *
* @return The same writer passed in.
* @throws Exception
*/
@@ -383,7 +389,8 @@ public class UonSerializer extends WriterSerializer {
//--------------------------------------------------------------------------------
@Override /* Serializer */
- public UonSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ public UonSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale,
+ TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
return new UonSerializerSession(ctx, null, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 8443578..3eb3c03 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
@@ -35,6 +35,7 @@ public class UonSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public UonSerializerBuilder(PropertyStore propertyStore) {
@@ -64,8 +65,8 @@ public class UonSerializerBuilder extends SerializerBuilder {
* Encode non-valid URI characters with <js>"%xx"</js> constructs.
* <p>
* 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.
+ * 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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 78f4f65..685408f 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,9 +26,12 @@ 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> - Properties associated with handling beans on serializers and parsers.
+ * <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.
+ * <li class='jc'><a class="doclink"
+ * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
* </ul>
* </ul>
*/
@@ -47,8 +50,8 @@ public class UonSerializerContext extends SerializerContext {
* Encode non-valid URI characters with <js>"%xx"</js> constructs.
* <p>
* 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.
+ * 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.
*/
public static final String UON_encodeChars = "UonSerializer.encodeChars";
@@ -62,9 +65,11 @@ public class UonSerializerContext extends SerializerContext {
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
* <p>
- * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred through reflection.
+ * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
+ * through reflection.
* 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.
+ * For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined from
+ * the value type.
* <p>
* When present, this value overrides the {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -86,14 +91,19 @@ public class UonSerializerContext extends SerializerContext {
* 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
- * quoted (<js>"'true'"</js>, <js>"'false'"</js>, <js>"'123'"</js>.
+ * <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
- * the results since UON constructs won't be differentiatable.
- * <br>However, this is not an issue if you're simply creating queries or form posts against 3rd-party interfaces.
+ * <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.
* </ul>
*/
public static final String UON_paramFormat = "UonSerializer.paramFormat";
@@ -114,7 +124,8 @@ public class UonSerializerContext extends SerializerContext {
public UonSerializerContext(PropertyStore ps) {
super(ps);
encodeChars = ps.getProperty(UON_encodeChars, boolean.class, false);
- addBeanTypeProperties = ps.getProperty(UON_addBeanTypeProperties, boolean.class, ps.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));
+ addBeanTypeProperties = ps.getProperty(UON_addBeanTypeProperties, boolean.class,
+ ps.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));
plainTextParams = ps.getProperty(UON_paramFormat, String.class, "UON").equals("PLAINTEXT");
}
@@ -130,6 +141,7 @@ public class UonSerializerContext extends SerializerContext {
/**
* Returns <jk>true</jk> if the {@link UonSerializerContext#UON_paramFormat} is <js>"PLAINTEXT"</js>.
+ *
* @return <jk>true</jk> if the {@link UonSerializerContext#UON_paramFormat} is <js>"PLAINTEXT"</js>.
*/
public boolean plainTextParams() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
index 33a082e..82c2e42 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
@@ -39,21 +39,22 @@ public class UonSerializerSession extends SerializerSession {
* Create a new session using properties specified in the context.
*
* @param ctx The context creating this session object.
- * The context contains all the configuration settings for this object.
+ * The context contains all the configuration settings for this object.
* @param encode Override the {@link UonSerializerContext#UON_encodeChars} setting.
* @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.
* @param op The override properties.
- * These override any context properties defined in the context.
+ * These override any context properties defined in the context.
* @param javaMethod The java method that called this serializer, usually the method in a REST servlet.
* @param locale The session locale.
- * If <jk>null</jk>, then the locale defined on the context is used.
+ * If <jk>null</jk>, then the locale defined on the context is used.
* @param timeZone The session timezone.
- * If <jk>null</jk>, then the timezone defined on the context is used.
+ * If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
* @param uriContext The URI context.
- * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
+ * Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
*/
- protected UonSerializerSession(UonSerializerContext ctx, Boolean encode, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
+ protected UonSerializerSession(UonSerializerContext ctx, Boolean encode, ObjectMap op, Object output,
+ Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {
super(ctx, op, output, javaMethod, locale, timeZone, mediaType, uriContext);
if (op == null || op.isEmpty()) {
encodeChars = encode == null ? ctx.encodeChars : encode;
@@ -87,6 +88,7 @@ public class UonSerializerSession extends SerializerSession {
/**
* Returns <jk>true</jk> if the {@link UonSerializerContext#UON_paramFormat} is <js>"PLAINTEXT"</js>.
+ *
* @return <jk>true</jk> if the {@link UonSerializerContext#UON_paramFormat} is <js>"PLAINTEXT"</js>.
*/
public boolean isPlainTextParams() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/uon/UonUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonUtils.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonUtils.java
index 1e22b25..811b716 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/UonUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonUtils.java
@@ -27,8 +27,7 @@ public final class UonUtils {
/**
* Returns <jk>true</jk> if the specified string needs to be quoted per UON notation.
* <p>
- * For example, strings that start with '(' or '@' or look like boolean or numeric values
- * need to be quoted.
+ * For example, strings that start with '(' or '@' or look like boolean or numeric values need to be quoted.
*
* @param s The string to test.
* @return <jk>true</jk> if the specified string needs to be quoted per UON notation.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/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 ef0940c..b107af3 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
@@ -38,7 +38,7 @@ public final class UonWriter extends SerializerWriter {
// Identical to unencodedChars, but excludes '='.
private static final AsciiSet unencodedCharsAttrName = new AsciiSet("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789;/?:@-_.!*'$(),~");
- // Characters that need to be preceeded with an escape character.
+ // Characters that need to be preceded with an escape character.
private static final AsciiSet escapedChars = new AsciiSet("~'");
private static final AsciiSet noChars = new AsciiSet("");
@@ -57,7 +57,8 @@ public final class UonWriter extends SerializerWriter {
* @param plainTextParams If <jk>true</jk>, don't use UON notation for values.
* @param uriResolver The URI resolver for resolving URIs to absolute or root-relative form.
*/
- protected UonWriter(UonSerializerSession session, Writer out, boolean useWhitespace, int maxIndent, boolean encodeChars, boolean trimStrings, boolean plainTextParams, UriResolver uriResolver) {
+ protected UonWriter(UonSerializerSession session, Writer out, boolean useWhitespace, int maxIndent,
+ boolean encodeChars, boolean trimStrings, boolean plainTextParams, UriResolver uriResolver) {
super(out, useWhitespace, maxIndent, trimStrings, '\'', uriResolver);
this.session = session;
this.encodeChars = encodeChars;