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 2018/01/14 16:02:38 UTC
[10/32] juneau git commit: Javadoc updates.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRest.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRest.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRest.java
index 2d7429a..7c7dafa 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRest.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRest.java
@@ -24,10 +24,10 @@ import org.apache.juneau.parser.*;
/**
* Provides the ability to perform standard REST operations (GET, PUT, POST, DELETE) against nodes in a POJO model.
- *
+ *
* <p>
* 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'>
@@ -38,20 +38,20 @@ import org.apache.juneau.parser.*;
* <li>
* Java beans.
* </ul>
- *
+ *
* <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.
- *
+ *
* <p>
* 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'>
* <jc>// Construct an unstructured POJO model</jc>
@@ -74,34 +74,34 @@ import org.apache.juneau.parser.*;
* + <js>" 'fico score':' > 640' "</js>
* + <js>"} "</js>
* );
- *
+ *
* <jc>// Wrap Map inside a PojoRest object</jc>
* PojoRest johnSmith = <jk>new</jk> PojoRest(m);
- *
+ *
* <jc>// Get a simple value at the top level</jc>
* <jc>// "John Smith"</jc>
* String name = johnSmith.getString(<js>"name"</js>);
- *
+ *
* <jc>// Change a simple value at the top level</jc>
* johnSmith.put(<js>"name"</js>, <js>"The late John Smith"</js>);
- *
+ *
* <jc>// Get a simple value at a deep level</jc>
* <jc>// "21 2nd Street"</jc>
* String streetAddress = johnSmith.getString(<js>"address/streetAddress"</js>);
- *
+ *
* <jc>// Set a simple value at a deep level</jc>
* johnSmith.put(<js>"address/streetAddress"</js>, <js>"101 Cemetery Way"</js>);
- *
+ *
* <jc>// Get entries in a list</jc>
* <jc>// "212 555-1111"</jc>
* String firstPhoneNumber = johnSmith.getString(<js>"phoneNumbers/0"</js>);
- *
+ *
* <jc>// Add entries to a list</jc>
* johnSmith.post(<js>"phoneNumbers"</js>, <js>"212 555-3333"</js>);
- *
+ *
* <jc>// Delete entries from a model</jc>
* johnSmith.delete(<js>"fico score"</js>);
- *
+ *
* <jc>// Add entirely new structures to the tree</jc>
* ObjectMap medicalInfo = new ObjectMap(<js>""</js>
* + <js>"{"</js>
@@ -112,12 +112,12 @@ import org.apache.juneau.parser.*;
* );
* johnSmith.put(<js>"additionalInfo/medicalInfo"</js>, medicalInfo);
* </p>
- *
+ *
* <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>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>
* <p class='bcode'>
* <jc>// Get map/bean with name attribute value of 'foo' from a list of items</jc>
@@ -141,10 +141,10 @@ public final class PojoRest {
/**
* Create a new instance of a REST interface over the specified object.
- *
+ *
* <p>
* Uses {@link BeanContext#DEFAULT} for working with Java beans.
- *
+ *
* @param o The object to be wrapped.
*/
public PojoRest(Object o) {
@@ -153,10 +153,10 @@ public final class PojoRest {
/**
* Create a new instance of a REST interface over the specified object.
- *
+ *
* <p>
* The parser is used as the bean context.
- *
+ *
* @param o The object to be wrapped.
* @param parser The parser to use for parsing arguments and converting objects to the correct data type.
*/
@@ -170,7 +170,7 @@ public final class PojoRest {
/**
* Call this method to prevent the root object from being overwritten on <code>put("", xxx);</code> calls.
- *
+ *
* @return This object (for method chaining).
*/
public PojoRest setRootLocked() {
@@ -180,7 +180,7 @@ public final class PojoRest {
/**
* The root object that was passed into the constructor of this method.
- *
+ *
* @return The root object.
*/
public Object getRootObject() {
@@ -189,7 +189,7 @@ public final class PojoRest {
/**
* Retrieves the element addressed by the URL.
- *
+ *
* @param url
* The URL of the element to retrieve.
* <br>If <jk>null</jk> or blank, returns the root.
@@ -201,7 +201,7 @@ public final class PojoRest {
/**
* Retrieves the element addressed by the URL.
- *
+ *
* @param url
* The URL of the element to retrieve.
* <br>If <jk>null</jk> or blank, returns the root.
@@ -215,35 +215,35 @@ public final class PojoRest {
/**
* Retrieves the element addressed by the URL as the specified object type.
- *
+ *
* <p>
* Will convert object to the specified type per {@link BeanSession#convertToType(Object, Class)}.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* PojoRest r = <jk>new</jk> PojoRest(object);
- *
+ *
* <jc>// Value converted to a string.</jc>
* String s = r.get(<js>"path/to/string"</js>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a bean.</jc>
* MyBean b = r.get(<js>"path/to/bean"</js>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a bean array.</jc>
* MyBean[] ba = r.get(<js>"path/to/beanarray"</js>, MyBean[].<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of objects.</jc>
* List l = r.get(<js>"path/to/list"</js>, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map of object keys/values.</jc>
* Map m2 = r.get(<js>"path/to/map"</js>, TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* @param url
* The URL of the element to retrieve.
* If <jk>null</jk> or blank, returns the root.
* @param type The specified object type.
- *
+ *
* @param <T> The specified object type.
* @return The addressed element, or null if that element does not exist in the tree.
*/
@@ -253,53 +253,53 @@ public final class PojoRest {
/**
* Retrieves the element addressed by the URL as the specified object type.
- *
+ *
* <p>
* Will convert object to the specified type per {@link BeanSession#convertToType(Object, Class)}.
- *
+ *
* <p>
* The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* PojoMap r = <jk>new</jk> PojoMap(object);
- *
+ *
* <jc>// Value converted to a linked-list of strings.</jc>
* List<String> l1 = r.get(<js>"path/to/list1"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of beans.</jc>
* List<MyBean> l2 = r.get(<js>"path/to/list2"</js>, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of linked-lists of strings.</jc>
* List<List<String>> l3 = r.get(<js>"path/to/list3"</js>, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map of string keys/values.</jc>
* Map<String,String> m1 = r.get(<js>"path/to/map1"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map containing string keys and values of lists containing beans.</jc>
* Map<String,List<MyBean>> m2 = r.get(<js>"path/to/map2"</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.
- *
+ *
* <p>
* The array can be arbitrarily long to indicate arbitrarily complex data structures.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Use the {@link #get(String, Class)} method instead if you don't need a parameterized map/collection.
* </ul>
- *
+ *
* @param url
* The URL of the element to retrieve.
* If <jk>null</jk> or blank, returns the root.
* @param type The specified object type.
* @param args The specified object parameter types.
- *
+ *
* @param <T> The specified object type.
* @return The addressed element, or null if that element does not exist in the tree.
*/
@@ -309,13 +309,13 @@ public final class PojoRest {
/**
* Same as {@link #get(String, Class)} but returns a default value if the addressed element is null or non-existent.
- *
+ *
* @param url
* The URL of the element to retrieve.
* If <jk>null</jk> or blank, returns the root.
* @param def The default value if addressed item does not exist.
* @param type The specified object type.
- *
+ *
* @param <T> The specified object type.
* @return The addressed element, or null if that element does not exist in the tree.
*/
@@ -328,14 +328,14 @@ public final class PojoRest {
/**
* Same as {@link #get(String,Type,Type[])} but returns a default value if the addressed element is null or non-existent.
- *
+ *
* @param url
* The URL of the element to retrieve.
* If <jk>null</jk? or blank, returns the root.
* @param def The default value if addressed item does not exist.
* @param type The specified object type.
* @param args The specified object parameter types.
- *
+ *
* @param <T> The specified object type.
* @return The addressed element, or null if that element does not exist in the tree.
*/
@@ -348,10 +348,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link String}.
- *
+ *
* <p>
* Shortcut for <code>get(String.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
*/
@@ -361,10 +361,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link String}.
- *
+ *
* <p>
* Shortcut for <code>get(String.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -375,10 +375,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to an {@link Integer}.
- *
+ *
* <p>
* Shortcut for <code>get(Integer.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -389,10 +389,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to an {@link Integer}.
- *
+ *
* <p>
* Shortcut for <code>get(Integer.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -404,10 +404,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Long}.
- *
+ *
* <p>
* Shortcut for <code>get(Long.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -418,10 +418,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Long}.
- *
+ *
* <p>
* Shortcut for <code>get(Long.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -433,10 +433,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Boolean}.
- *
+ *
* <p>
* Shortcut for <code>get(Boolean.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -447,10 +447,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Boolean}.
- *
+ *
* <p>
* Shortcut for <code>get(Boolean.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -462,10 +462,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Map}.
- *
+ *
* <p>
* Shortcut for <code>get(Map.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -476,10 +476,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Map}.
- *
+ *
* <p>
* Shortcut for <code>get(Map.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -491,10 +491,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link List}.
- *
+ *
* <p>
* Shortcut for <code>get(List.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -505,10 +505,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link List}.
- *
+ *
* <p>
* Shortcut for <code>get(List.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -520,10 +520,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Map}.
- *
+ *
* <p>
* Shortcut for <code>get(ObjectMap.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -534,10 +534,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link ObjectMap}.
- *
+ *
* <p>
* Shortcut for <code>get(ObjectMap.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -549,10 +549,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link ObjectList}.
- *
+ *
* <p>
* Shortcut for <code>get(ObjectList.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -563,10 +563,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link ObjectList}.
- *
+ *
* <p>
* Shortcut for <code>get(ObjectList.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -578,7 +578,7 @@ public final class PojoRest {
/**
* Executes the specified method with the specified parameters on the specified object.
- *
+ *
* @param url The URL of the element to retrieve.
* @param method
* The method signature.
@@ -628,7 +628,7 @@ public final class PojoRest {
/**
* 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.
*/
@@ -641,7 +641,7 @@ public final class PojoRest {
/**
* Returns the class type of the object at the specified URL.
- *
+ *
* @param url The URL.
* @return The class type.
*/
@@ -654,10 +654,10 @@ public final class PojoRest {
/**
* Sets/replaces the element addressed by the URL.
- *
+ *
* <p>
* This method expands the POJO model as necessary to create the new element.
- *
+ *
* @param url
* The URL of the element to create.
* If <jk>null</jk> or blank, the root itself is replaced with the specified value.
@@ -670,16 +670,16 @@ public final class PojoRest {
/**
* Adds a value to a list element in a POJO model.
- *
+ *
* <p>
* The URL is the address of the list being added to.
- *
+ *
* <p>
* If the list does not already exist, it will be created.
- *
+ *
* <p>
* This method expands the POJO model as necessary to create the new element.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>You can only post to three types of nodes:
@@ -689,7 +689,7 @@ public final class PojoRest {
* <li>arrays
* </ul>
* </ul>
- *
+ *
* @param url
* The URL of the element being added to.
* If <jk>null</jk> or blank, the root itself (assuming it's one of the types specified above) is added to.
@@ -702,10 +702,10 @@ public final class PojoRest {
/**
* Remove an element from a POJO model.
- *
+ *
* <p>
* 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/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRestException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRestException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRestException.java
index 77ec174..98b1151 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRestException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRestException.java
@@ -19,10 +19,10 @@ import org.apache.juneau.*;
/**
* Generic exception thrown from the {@link PojoRest} class.
- *
+ *
* <p>
* Typically, this is a user-error, such as trying to address a non-existent node in the tree.
- *
+ *
* <p>
* The status code is an HTTP-equivalent code. It will be one of the following:
* <ul class='spaced-list'>
@@ -45,7 +45,7 @@ public final class PojoRestException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param status The HTTP-equivalent status code.
* @param message The detailed message.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -57,10 +57,10 @@ public final class PojoRestException extends FormattedRuntimeException {
/**
* The HTTP-equivalent status code.
- *
+ *
* <p>
* See above for details.
- *
+ *
* @return The HTTP-equivalent status code.
*/
public int getStatus() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ProcBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ProcBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ProcBuilder.java
index d243803..ab3bfe1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ProcBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ProcBuilder.java
@@ -25,7 +25,7 @@ import org.apache.juneau.utils.IOPipe.*;
/**
* Utility class for running operating system processes.
- *
+ *
* <p>
* Similar to {@link java.lang.ProcessBuilder} but with additional features.
*/
@@ -41,10 +41,10 @@ public class ProcBuilder {
/**
* Creates a process builder with the specified arguments.
- *
+ *
* <p>
* Equivalent to calling <code>ProcessBuilder.create().command(args);</code>
- *
+ *
* @param args The command-line arguments.
* @return A new process builder.
*/
@@ -54,7 +54,7 @@ public class ProcBuilder {
/**
* Creates an empty process builder.
- *
+ *
* @return A new process builder.
*/
public static ProcBuilder create() {
@@ -63,10 +63,10 @@ public class ProcBuilder {
/**
* Command arguments.
- *
+ *
* <p>
* Arguments can be collections or arrays and will be automatically expanded.
- *
+ *
* @param args The command-line arguments.
* @return This object (for method chaining).
*/
@@ -76,10 +76,10 @@ public class ProcBuilder {
/**
* Command arguments if the specified matcher matches.
- *
+ *
* <p>
* Can be used for specifying OS-specific commands.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* ProcBuilder pb = ProcBuilder
@@ -89,7 +89,7 @@ public class ProcBuilder {
* .merge()
* .execute();
* </p>
- *
+ *
* @param m The matcher.
* @param args The command line arguments if matcher matches.
* @return This object (for method chaining).
@@ -102,10 +102,10 @@ public class ProcBuilder {
/**
* Append to the command arguments.
- *
+ *
* <p>
* Arguments can be collections or arrays and will be automatically expanded.
- *
+ *
* @param args The command-line arguments.
* @return This object (for method chaining).
*/
@@ -115,10 +115,10 @@ public class ProcBuilder {
/**
* Append to the command arguments if the specified matcher matches.
- *
+ *
* <p>
* Arguments can be collections or arrays and will be automatically expanded.
- *
+ *
* @param m The matcher.
* @param args The command line arguments if matcher matches.
* @return This object (for method chaining).
@@ -131,7 +131,7 @@ public class ProcBuilder {
/**
* Merge STDOUT and STDERR into a single stream.
- *
+ *
* @return This object (for method chaining).
*/
public ProcBuilder merge() {
@@ -141,10 +141,10 @@ public class ProcBuilder {
/**
* Use by-lines mode.
- *
+ *
* <p>
* Flushes output after every line of input.
- *
+ *
* @return This object (for method chaining).
*/
public ProcBuilder byLines() {
@@ -154,10 +154,10 @@ public class ProcBuilder {
/**
* Pipe output to the specified writer.
- *
+ *
* <p>
* The method can be called multiple times to write to multiple writers.
- *
+ *
* @param w The writer to pipe to.
* @param close Close the writer afterwards.
* @return This object (for method chaining).
@@ -169,7 +169,7 @@ public class ProcBuilder {
/**
* Pipe output to the specified writer, but don't close the writer.
- *
+ *
* @param w The writer to pipe to.
* @return This object (for method chaining).
*/
@@ -179,10 +179,10 @@ public class ProcBuilder {
/**
* Pipe output to the specified writer, including the command and return code.
- *
+ *
* <p>
* The method can be called multiple times to write to multiple writers.
- *
+ *
* @param w The writer to pipe to.
* @param close Close the writer afterwards.
* @return This object (for method chaining).
@@ -195,11 +195,11 @@ public class ProcBuilder {
/**
* Pipe output to the specified writer, including the command and return code.
- *
+ *
* <p>
* The method can be called multiple times to write to multiple writers.
* Don't close the writer afterwards.
- *
+ *
* @param w The writer to pipe to.
* @return This object (for method chaining).
*/
@@ -210,7 +210,7 @@ public class ProcBuilder {
/**
* Pipe output to the specified writer, including the command and return code.
* The method can be called multiple times to write to multiple writers.
- *
+ *
* @param level The log level.
* @param logger The logger to log to.
* @return This object (for method chaining).
@@ -232,7 +232,7 @@ public class ProcBuilder {
/**
* Line processor to use to process/convert lines of output returned by the process.
- *
+ *
* @param lp The new line processor.
* @return This object (for method chaining).
*/
@@ -243,7 +243,7 @@ public class ProcBuilder {
/**
* Append the specified environment variables to the process.
- *
+ *
* @param env The new set of environment variables.
* @return This object (for method chaining).
*/
@@ -257,7 +257,7 @@ public class ProcBuilder {
/**
* Append the specified environment variable.
- *
+ *
* @param key The environment variable name.
* @param val The environment variable value.
* @return This object (for method chaining).
@@ -269,7 +269,7 @@ public class ProcBuilder {
/**
* Sets the directory where the command will be executed.
- *
+ *
* @param directory The directory.
* @return This object (for method chaining).
*/
@@ -280,11 +280,11 @@ public class ProcBuilder {
/**
* Sets the maximum allowed return code on the process call.
- *
+ *
* <p>
* If the return code exceeds this value, an IOException is returned on the {@link #run()} command.
* The default value is '0'.
- *
+ *
* @param maxExitStatus The maximum exit status.
* @return This object (for method chaining).
*/
@@ -295,7 +295,7 @@ public class ProcBuilder {
/**
* Run this command and pipes the output to the specified writer or output stream.
- *
+ *
* @return The exit code from the process.
* @throws IOException
* @throws InterruptedException
@@ -320,7 +320,7 @@ public class ProcBuilder {
/**
* Run this command and returns the output as a simple string.
- *
+ *
* @return The output from the command.
* @throws IOException
* @throws InterruptedException
@@ -333,7 +333,7 @@ public class ProcBuilder {
/**
* Returns the output from this process as a {@link Scanner}.
- *
+ *
* @return The output from the process as a Scanner object.
* @throws IOException
* @throws InterruptedException
@@ -347,7 +347,7 @@ public class ProcBuilder {
/**
* Destroys the underlying process.
- *
+ *
* <p>
* This method is only needed if the {@link #getScanner()} method was used.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/SearchArgs.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/SearchArgs.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/SearchArgs.java
index ea7001e..93d3c7c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/SearchArgs.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/SearchArgs.java
@@ -41,7 +41,7 @@ public class SearchArgs {
/**
* Creates a new builder for {@link SearchArgs}
- *
+ *
* @return A new builder for {@link SearchArgs}
*/
public static Builder builder() {
@@ -60,22 +60,22 @@ public class SearchArgs {
/**
* Adds search terms to this builder.
- *
+ *
* <p>
* The search terms are a comma-delimited list of key/value pairs of column-names and search tokens.
- *
+ *
* <p>
* For example:
* <p class='bcode'>
* builder.search(<js>"column1=foo*, column2=bar baz"</js>);
* </p>
- *
+ *
* <p>
* It's up to implementers to decide the syntax and meaning of the search terms.
- *
+ *
* <p>
* Whitespace is trimmed from column names and search tokens.
- *
+ *
* @param searchTerms
* The search terms string.
* Can be <jk>null</jk>.
@@ -96,10 +96,10 @@ public class SearchArgs {
/**
* Adds a search term to this builder.
- *
+ *
* <p>
* It's up to implementers to decide the syntax and meaning of the search term.
- *
+ *
* @param column The column being searched.
* @param searchTerm The search term.
* @return This object (for method chaining).
@@ -111,22 +111,22 @@ public class SearchArgs {
/**
* Specifies the list of columns to view.
- *
+ *
* <p>
* The columns argument is a simple comma-delimited list of column names.
- *
+ *
* <p>
* For example:
* <p class='bcode'>
* builder.view(<js>"column1, column2"</js>);
* </p>
- *
+ *
* <p>
* Whitespace is trimmed from column names.
- *
+ *
* <p>
* Empty view columns imply view all columns.
- *
+ *
* @param columns
* The columns being viewed.
* Can be <jk>null</jk>.
@@ -140,10 +140,10 @@ public class SearchArgs {
/**
* Specifies the list of columns to view.
- *
+ *
* <p>
* Empty view columns imply view all columns.
- *
+ *
* @param columns The columns being viewed.
* @return This object (for method chaining).
*/
@@ -154,25 +154,25 @@ public class SearchArgs {
/**
* Specifies the sort arguments.
- *
+ *
* <p>
* The sort argument is a simple comma-delimited list of column names.
* <br>Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order.
* <br>No suffix implies ascending order.
- *
+ *
* <p>
* For example:
* <p class='bcode'>
* <jc>// Order by column1 ascending, then column2 descending.</jc>
* builder.sort(<js>"column1, column2-"</js>);
* </p>
- *
+ *
* <p>
* Note that the order of the order arguments is important.
- *
+ *
* <p>
* Whitespace is trimmed from column names.
- *
+ *
* @param sortArgs
* The columns to sort by.
* Can be <jk>null</jk>.
@@ -186,14 +186,14 @@ public class SearchArgs {
/**
* Specifies the sort arguments.
- *
+ *
* <p>
* Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order.
* <br>No suffix implies ascending order.
- *
+ *
* <p>
* Note that the order of the sort is important.
- *
+ *
* @param sortArgs
* The columns to sort by.
* Can be <jk>null</jk>.
@@ -213,7 +213,7 @@ public class SearchArgs {
/**
* Specifies the starting line number.
- *
+ *
* @param position The zero-indexed position.
* @return This object (for method chaining).
*/
@@ -224,7 +224,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.
@@ -237,10 +237,10 @@ public class SearchArgs {
/**
* Specifies whether case-insensitive search should be used.
- *
+ *
* <p>
* The default is <jk>false</jk>.
- *
+ *
* @param value The ignore-case flag value.
* @return This object (for method chaining).
*/
@@ -251,10 +251,10 @@ public class SearchArgs {
/**
* Construct the {@link SearchArgs} object.
- *
+ *
* <p>
* This method can be called multiple times to construct new objects.
- *
+ *
* @return A new {@link SearchArgs} object initialized with values in this builder.
*/
public SearchArgs build() {
@@ -264,13 +264,13 @@ public class SearchArgs {
/**
* The query search terms.
- *
+ *
* <p>
* The search terms are key/value pairs consisting of column-names and search tokens.
- *
+ *
* <p>
* It's up to implementers to decide the syntax and meaning of the search term.
- *
+ *
* @return An unmodifiable map of query search terms.
*/
public Map<String,String> getSearch() {
@@ -279,11 +279,11 @@ public class SearchArgs {
/**
* The view columns.
- *
+ *
* <p>
* The view columns are the list of columns that should be displayed.
* An empty list implies all columns should be displayed.
- *
+ *
* @return An unmodifiable list of columns to view.
*/
public List<String> getView() {
@@ -292,11 +292,11 @@ public class SearchArgs {
/**
* The sort columns.
- *
+ *
* <p>
* The sort columns are key/value pairs consisting of column-names and direction flags
* (<jk>false</jk> = ascending, <jk>true</jk> = descending).
- *
+ *
* @return An unmodifiable ordered map of sort columns and directions.
*/
public Map<String,Boolean> getSort() {
@@ -305,7 +305,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>
@@ -316,7 +316,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.
@@ -327,10 +327,10 @@ public class SearchArgs {
/**
* The ignore-case flag.
- *
+ *
* <p>
* 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>.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringMessage.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringMessage.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringMessage.java
index 329d58a..17ed8fa 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringMessage.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringMessage.java
@@ -22,7 +22,7 @@ import org.apache.juneau.http.*;
/**
* An encapsulated MessageFormat-style string and arguments.
- *
+ *
* <p>
* Useful for delayed serialization of arguments for logging.
* Message string will not be constructed until the <code>toString()</code> method is called.
@@ -35,7 +35,7 @@ public class StringMessage implements CharSequence, Writable {
/**
* Constructor.
- *
+ *
* @param pattern {@link MessageFormat}-style pattern.
* @param args Message arguments.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringObject.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringObject.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringObject.java
index 0cf0b28..2982db6 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringObject.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringObject.java
@@ -21,13 +21,13 @@ import org.apache.juneau.serializer.*;
/**
* A serializer/object pair used for delayed object serialization.
- *
+ *
* <p>
* Useful in certain conditions such as logging when you don't want to needlessly serialize objects.
- *
+ *
* <p>
* Instances of this method are created by the {@link WriterSerializer#toStringObject(Object)} method.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// The POJO will not be serialized unless DEBUG is enabled.</jc>
@@ -42,7 +42,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.
*/
@@ -53,7 +53,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/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ZipFileList.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ZipFileList.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ZipFileList.java
index a12183f..9395016 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ZipFileList.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ZipFileList.java
@@ -19,7 +19,7 @@ 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
* 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.
@@ -34,7 +34,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Constructor.
- *
+ *
* @param fileName The file name of the zip file to create.
*/
public ZipFileList(String fileName) {
@@ -43,7 +43,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Add an entry to this list.
- *
+ *
* @param e The zip file entry.
* @return This object (for method chaining).
*/
@@ -58,7 +58,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
public static interface ZipFileEntry {
/**
* Write this entry to the specified output stream.
- *
+ *
* @param zos The output stream to write to.
* @throws IOException
*/
@@ -78,7 +78,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Constructor.
- *
+ *
* @param root The root file that represents the base path.
* @param file The file to add to the zip file.
*/
@@ -89,7 +89,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Constructor.
- *
+ *
* @param file The file to add to the zip file.
*/
public FileEntry(File file) {
@@ -104,7 +104,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Subclasses can override this method to customize which files get added to a zip file.
- *
+ *
* @param f The file being added to the zip file.
* @return Always returns <jk>true</jk>.
*/
@@ -114,7 +114,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Adds the specified file to the specified output stream.
- *
+ *
* @param zos The output stream.
* @param f The file to add.
* @throws IOException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/Namespace.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/Namespace.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/Namespace.java
index d89a3e1..6451ec2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/Namespace.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/Namespace.java
@@ -21,7 +21,7 @@ import org.apache.juneau.internal.*;
/**
* 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 re-mappings
* in the serializer.
@@ -37,7 +37,7 @@ public final class Namespace {
*
* <p>
* Previously-encountered name/uri pairs return a cached copy.
- *
+ *
* @param name The namespace name. See {@link Namespace#getName()}.
* @param uri The namespace URI. See {@link Namespace#getUri()}.
* @return The namespace object.
@@ -73,14 +73,14 @@ public final class Namespace {
/**
* Converts the specified object into a {@link Namespace} object.
- *
+ *
* <p>
* Can be any of following types:
* <ul>
* <li>A {@link Namespace} object
* <li>A string containing a name/value pair of the form <js>"name:uri"</js>.
* </ul>
- *
+ *
* @param o The input.
* @return The namespace object, or <jk>null</jk> if the input was <jk>null</jk> or an empty JSON object.
*/
@@ -96,7 +96,7 @@ public final class Namespace {
/**
* Converts the specified object into an array of {@link Namespace} object.
- *
+ *
* <p>
* Can be any of following types:
* <ul>
@@ -104,7 +104,7 @@ public final class Namespace {
* <li>A comma-delimited string with key/value pairs of the form <js>"name:uri"</js>.
* <li>A <code>Collection</code> containing any of object that can be passed to {@link #createArray(Object)}.
* </ul>
- *
+ *
* @param o The input.
* @return The namespace objects, or <jk>null</jk> if the input was <jk>null</jk> or an empty JSON object.
*/
@@ -145,7 +145,7 @@ public final class Namespace {
/**
* Constructor.
- *
+ *
* @param name The short name of this schema.
* @param uri The URI of this schema.
*/
@@ -157,7 +157,7 @@ public final class Namespace {
/**
* Returns the namespace name.
- *
+ *
* @return The namespace name.
*/
public String getName() {
@@ -166,7 +166,7 @@ public final class Namespace {
/**
* Returns the namespace URI.
- *
+ *
* @return The namespace URI.
*/
public String getUri() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
index c93c08c..91e75e3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
@@ -35,7 +35,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* Constructor.
- *
+ *
* @param beanMeta The metadata on the bean that this metadata applies to.
*/
public XmlBeanMeta(BeanMeta<?> beanMeta) {
@@ -138,7 +138,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of properties that should be rendered as XML attributes.
- *
+ *
* @return Map of property names to property metadata.
*/
protected Map<String,BeanPropertyMeta> getAttrProperties() {
@@ -147,7 +147,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of names of properties that should be rendered as XML attributes.
- *
+ *
* @return Set of property names.
*/
protected Set<String> getAttrPropertyNames() {
@@ -156,7 +156,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of properties that should be rendered as child elements.
- *
+ *
* @return Map of property names to property metadata.
*/
protected Map<String,BeanPropertyMeta> getElementProperties() {
@@ -165,7 +165,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of names of properties that should be rendered as child elements.
- *
+ *
* @return Set of property names.
*/
protected Set<String> getElementPropertyNames() {
@@ -175,7 +175,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of properties that should be rendered as collapsed child elements.
* <br>See {@link Xml#childName() @Xml.childName()}
- *
+ *
* @return Map of property names to property metadata.
*/
protected Map<String,BeanPropertyMeta> getCollapsedProperties() {
@@ -184,7 +184,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of names of properties that should be rendered as collapsed child elements.
- *
+ *
* @return Set of property names.
*/
protected Set<String> getCollapsedPropertyNames() {
@@ -193,7 +193,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The property that returns a map of XML attributes as key/value pairs.
- *
+ *
* @return The bean property metadata, or <jk>null</jk> if there is no such method.
*/
protected BeanPropertyMeta getAttrsProperty() {
@@ -202,7 +202,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The name of the property that returns a map of XML attributes as key/value pairs.
- *
+ *
* @return The bean property name, or <jk>null</jk> if there is no such method.
*/
protected String getAttrsPropertyName() {
@@ -211,7 +211,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The property that represents the inner XML content of this bean.
- *
+ *
* @return The bean property metadata, or <jk>null</jk> if there is no such method.
*/
protected BeanPropertyMeta getContentProperty() {
@@ -220,7 +220,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The name of the property that represents the inner XML content of this bean.
- *
+ *
* @return The bean property name, or <jk>null</jk> if there is no such method.
*/
protected String getContentPropertyName() {
@@ -229,7 +229,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* Returns the format of the inner XML content of this bean.
- *
+ *
* <p>
* Can be one of the following:
* <ul>
@@ -242,7 +242,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
* <li>{@link XmlFormat#VOID}
* <li><jk>null</jk>
* </ul>
- *
+ *
* @return The format of the inner XML content of this bean.
*/
protected XmlFormat getContentFormat() {
@@ -251,11 +251,11 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* Returns bean property meta with the specified name.
- *
+ *
* <p>
* 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").
- *
+ *
* @param fieldName The bean property name.
* @return The property metadata.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
index ecef9e0..5c062a8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
@@ -29,7 +29,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Constructor.
- *
+ *
* @param bpm The metadata of the bean property of this additional metadata.
*/
public XmlBeanPropertyMeta(BeanPropertyMeta bpm) {
@@ -48,7 +48,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns the XML namespace associated with this bean property.
- *
+ *
* <p>
* Namespace is determined in the following order of {@link Xml#prefix() @Xml.prefix()} annotation:
* <ol>
@@ -62,7 +62,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
* <li>Bean interfaces.
* <li>Bean interface packages.
* </ol>
- *
+ *
* @return The namespace associated with this bean property, or <jk>null</jk> if no namespace is associated with it.
*/
public Namespace getNamespace() {
@@ -71,7 +71,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns the XML format of this property from the {@link Xml#format} annotation on this bean property.
- *
+ *
* @return The XML format, or {@link XmlFormat#DEFAULT} if annotation not specified.
*/
protected XmlFormat getXmlFormat() {
@@ -80,7 +80,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns the child element of this property from the {@link Xml#childName} annotation on this bean property.
- *
+ *
* @return The child element, or <jk>null</jk> if annotation not specified.
*/
protected String getChildName() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlClassMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
index 8dfb445..b3c853d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
@@ -34,7 +34,7 @@ public class XmlClassMeta extends ClassMetaExtended {
/**
* Constructor.
- *
+ *
* @param cm The class that this annotation is defined on.
*/
public XmlClassMeta(ClassMeta<?> cm) {
@@ -54,7 +54,7 @@ public class XmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Xml @Xml} annotation defined on the class.
- *
+ *
* @return
* The value of the annotation defined on the class, or <jk>null</jk> if annotation is not specified.
*/
@@ -64,7 +64,7 @@ public class XmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Xml#format() @Xml.format()} annotation defined on the class.
- *
+ *
* @return The value of the annotation, or {@link XmlFormat#DEFAULT} if not specified.
*/
protected XmlFormat getFormat() {
@@ -73,7 +73,7 @@ public class XmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Xml#childName() @Xml.childName()} annotation defined on the class.
- *
+ *
* @return The value of the annotation, or <jk>null</jk> if not specified.
*/
protected String getChildName() {
@@ -82,7 +82,7 @@ public class XmlClassMeta extends ClassMetaExtended {
/**
* Returns the XML namespace associated with this class.
- *
+ *
* <p>
* Namespace is determined in the following order of {@link Xml#prefix() @Xml.prefix()} annotation:
* <ol>
@@ -93,7 +93,7 @@ public class XmlClassMeta extends ClassMetaExtended {
* <li>Interfaces.
* <li>Interface packages.
* </ol>
- *
+ *
* @return The namespace associated with this class, or <jk>null</jk> if no namespace is associated with it.
*/
protected Namespace getNamespace() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
index a47849e..b9fef1a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
@@ -17,19 +17,20 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJOs to HTTP responses as XML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/xml</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/xml</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/xml</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/xml</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* 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 {
@@ -42,7 +43,7 @@ public class XmlDocSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Ns(PropertyStore ps) {
@@ -57,7 +58,7 @@ public class XmlDocSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public XmlDocSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializerSession.java
index 3f9449f..6763467 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializerSession.java
@@ -16,7 +16,7 @@ import org.apache.juneau.serializer.*;
/**
* Session object that lives for the duration of a single use of {@link XmlDocSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -25,7 +25,7 @@ public class XmlDocSerializerSession extends XmlSerializerSession {
/**
* 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.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParseException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParseException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParseException.java
index ca91a50..5e46e57 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParseException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParseException.java
@@ -28,7 +28,7 @@ public class XmlParseException extends ParseException {
/**
* Constructor.
- *
+ *
* @param location The location of the exception.
* @param message The exception message containing {@link MessageFormat}-style arguments.
* @param args Optional {@link MessageFormat}-style arguments.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParser.java
index 9b41700..45e77e0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParser.java
@@ -20,13 +20,14 @@ import org.apache.juneau.parser.*;
/**
* Parses text generated by the {@link XmlSerializer} class back into a POJO model.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Content-Type</code> types: <code>text/xml</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Content-Type</code> types: <code><b>text/xml</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* See the {@link XmlSerializer} class for a description of Juneau-generated XML.
*/
public class XmlParser extends ReaderParser {
@@ -39,7 +40,7 @@ public class XmlParser extends ReaderParser {
/**
* Configuration property: XML event allocator.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlParser.eventAllocator.c"</js>
@@ -51,7 +52,7 @@ public class XmlParser extends ReaderParser {
* <li class='jm'>{@link XmlParserBuilder#eventAllocator(XMLEventAllocator)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Associates an {@link XMLEventAllocator} with this parser.
@@ -60,7 +61,7 @@ public class XmlParser extends ReaderParser {
/**
* Configuration property: Preserve root element during generalized parsing.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlParser.preserveRootElement.b"</js>
@@ -73,12 +74,12 @@ public class XmlParser extends ReaderParser {
* <li class='jm'>{@link XmlParserBuilder#preserveRootElement()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Parser with preserve-root-element.</jc>
@@ -106,7 +107,7 @@ public class XmlParser extends ReaderParser {
/**
* Configuration property: XML reporter.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlParser.reporter.c"</js>
@@ -118,11 +119,11 @@ public class XmlParser extends ReaderParser {
* <li class='jm'>{@link XmlParserBuilder#reporter(XMLReporter)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Associates an {@link XMLReporter} with this parser.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Reporters are not copied to new parsers during a clone.
@@ -132,7 +133,7 @@ public class XmlParser extends ReaderParser {
/**
* Configuration property: XML resolver.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlParser.resolver.c"</js>
@@ -144,7 +145,7 @@ public class XmlParser extends ReaderParser {
* <li class='jm'>{@link XmlParserBuilder#resolver(XMLResolver)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Associates an {@link XMLResolver} with this parser.
@@ -153,7 +154,7 @@ public class XmlParser extends ReaderParser {
/**
* Configuration property: Enable validation.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlParser.validating.b"</js>
@@ -166,7 +167,7 @@ public class XmlParser extends ReaderParser {
* <li class='jm'>{@link XmlParserBuilder#validating()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, XML document will be validated.
@@ -198,7 +199,7 @@ public class XmlParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -208,7 +209,7 @@ public class XmlParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param consumes
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
index 1858b88..fc819fc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
@@ -37,7 +37,7 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public XmlParserBuilder(PropertyStore ps) {
@@ -56,10 +56,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: XML event allocator.
- *
+ *
* <p>
* Associates an {@link XMLEventAllocator} with this parser.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_eventAllocator}
@@ -74,11 +74,11 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: Preserve root element during generalized parsing.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_preserveRootElement}
@@ -95,10 +95,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: Preserve root element during generalized parsing.
- *
+ *
* <p>
* Shortcut for calling <code>preserveRootElement(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_preserveRootElement}
@@ -112,10 +112,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: XML reporter.
- *
+ *
* <p>
* Associates an {@link XMLReporter} with this parser.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_reporter}
@@ -130,10 +130,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: XML resolver.
- *
+ *
* <p>
* Associates an {@link XMLResolver} with this parser.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_resolver}
@@ -148,10 +148,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: Enable validation.
- *
+ *
* <p>
* If <jk>true</jk>, XML document will be validated.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_validating}
@@ -168,10 +168,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: Enable validation.
- *
+ *
* <p>
* Shortcut for calling <code>validating(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_validating}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserSession.java
index 2784e95..630bce6 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserSession.java
@@ -30,7 +30,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Session object that lives for the duration of a single use of {@link XmlParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -50,7 +50,7 @@ public class XmlParserSession extends ReaderParserSession {
/**
* 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.
@@ -80,7 +80,7 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Wrap the specified reader in a STAX reader based on settings in this context.
- *
+ *
* @param pipe The parser input.
* @return The new STAX reader.
* @throws Exception If problem occurred trying to create reader.
@@ -91,10 +91,10 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Decodes and trims the specified string.
- *
+ *
* <p>
* Any <js>'_x####_'</js> sequences in the string will be decoded.
- *
+ *
* @param s The string to be decoded.
* @return The decoded string.
*/
@@ -134,13 +134,13 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Returns the text content of the current XML element.
- *
+ *
* <p>
* Any <js>'_x####_'</js> sequences in the string will be decoded.
- *
+ *
* <p>
* Leading and trailing whitespace (unencoded) will be trimmed from the result.
- *
+ *
* @param r The reader to read the element text from.
* @return The decoded text. <jk>null</jk> if the text consists of the sequence <js>'_x0000_'</js>.
* @throws Exception
@@ -189,7 +189,7 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Parses the current element as text.
- *
+ *
* @param r
* @return The parsed text.
* @throws Exception
@@ -223,11 +223,11 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Returns <jk>true</jk> if the current element is a whitespace element.
- *
+ *
* <p>
* For the XML parser, this always returns <jk>false</jk>.
* However, the HTML parser defines various whitespace elements such as <js>"br"</js> and <js>"sp"</js>.
- *
+ *
* @param r The XML stream reader to read the current event from.
* @return <jk>true</jk> if the current element is a whitespace element.
*/
@@ -237,11 +237,11 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Parses the current whitespace element.
- *
+ *
* <p>
* For the XML parser, this always returns <jk>null</jk> since there is no concept of a whitespace element.
* However, the HTML parser defines various whitespace elements such as <js>"br"</js> and <js>"sp"</js>.
- *
+ *
* @param r The XML stream reader to read the current event from.
* @return The whitespace character or characters.
* @throws XMLStreamException
@@ -270,7 +270,7 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Workhorse method.
- *
+ *
* @param eType The expected type of object.
* @param currAttr The current bean property name.
* @param r The reader.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlReader.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlReader.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlReader.java
index c7206ce..7b8affa 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlReader.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlReader.java
@@ -22,7 +22,7 @@ import org.apache.juneau.parser.*;
/**
* Wrapper class around a {@link XMLStreamReader}.
- *
+ *
* <p>
* The purpose is to encapsulate the reader with the {@link ParserPipe} object so that it can be retrieved for
* debugging purposes.
@@ -34,7 +34,7 @@ public final class XmlReader implements XMLStreamReader {
/**
* Constructor.
- *
+ *
* @param pipe The parser input.
* @param validating The value for the {@link XMLInputFactory#IS_VALIDATING} setting.
* @param reporter The value for the {@link XMLInputFactory#REPORTER} setting.
@@ -68,7 +68,7 @@ public final class XmlReader implements XMLStreamReader {
/**
* Returns the pipe passed into the constructor.
- *
+ *
* @return The pipe passed into the constructor.
*/
public ParserPipe getPipe() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
index 233aa79..8247fd4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
@@ -17,16 +17,16 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO metadata to HTTP responses as XML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/xml+schema</code>
- *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/xml+schema</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/xml</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/xml</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* 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.
*/
@@ -38,7 +38,7 @@ public class XmlSchemaDocSerializer extends XmlSchemaSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public XmlSchemaDocSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializerSession.java
index 4d2dca7..f2ad70d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializerSession.java
@@ -16,7 +16,7 @@ import org.apache.juneau.serializer.*;
/**
* Session object that lives for the duration of a single use of {@link XmlSchemaDocSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -25,7 +25,7 @@ public class XmlSchemaDocSerializerSession extends XmlSchemaSerializerSession {
/**
* 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.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
index be2b2af..26780e7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
@@ -17,23 +17,23 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO metadata to HTTP responses as XML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/xml+schema</code>
- *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/xml+schema</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/xml</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/xml</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Produces the XML-schema representation of the XML produced by the {@link XmlSerializer} class with the same properties.
*/
public class XmlSchemaSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps Initialize with the specified config property store.
*/
public XmlSchemaSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
index 147e8aa..94b1a7b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
@@ -32,7 +32,7 @@ public class XmlSchemaSerializerBuilder extends XmlSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public XmlSchemaSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerSession.java
index aef9e26..9a3762f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerSession.java
@@ -31,7 +31,7 @@ import org.w3c.dom.ls.*;
/**
* Session object that lives for the duration of a single use of {@link XmlSchemaSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -40,7 +40,7 @@ public class XmlSchemaSerializerSession extends XmlSerializerSession {
/**
* 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.
@@ -69,7 +69,7 @@ public class XmlSchemaSerializerSession extends XmlSerializerSession {
/**
* Returns an XML-Schema validator based on the output returned by {@link #doSerialize(SerializerPipe, Object)};
- *
+ *
* @param out The target writer.
* @param o The object to serialize.
* @return The new validator.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializer.java
index 51f906b..9feffa3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializer.java
@@ -18,18 +18,19 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO models to XML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/xml</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/xml</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/xml</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/xml</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* See the {@link JsonSerializer} class for details on how Java models map to JSON.
- *
+ *
* <p>
* For example, the following JSON...
* <p class='bcode'>
@@ -70,7 +71,7 @@ import org.apache.juneau.serializer.*;
* <xt><height></xt>62.4<xt></height></xt>
* <xt><fico_x0020_score></xt> &gt; 640<xt></fico_x0020_score></xt>
* <xt></object></xt>
- *
+ *
* <p>
* An additional "add-json-properties" mode is also provided to prevent loss of JSON data types...
* <p class='bcode'>
@@ -91,18 +92,18 @@ import org.apache.juneau.serializer.*;
* <xt><fico_x0020_score</xt> <xa>_type</xa>=<xs>'string'</xs><xt>></xt> &gt; 640<xt></fico_x0020_score></xt>
* <xt></object></xt>
* </p>
- *
+ *
* <p>
* 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.
- *
+ *
* <h6 class='topic'>Behavior-specific subclasses</h6>
- *
+ *
* The following direct subclasses are provided for convenience:
* <ul>
* <li>{@link Sq} - Default serializer, single quotes.
@@ -119,7 +120,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.addBeanTypeProperties.b"</js>
@@ -131,12 +132,12 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#addBeanTypeProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
* through reflection.
- *
+ *
* <p>
* When present, this value overrides the {@link #SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -145,7 +146,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Add namespace URLs to the root element.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.addNamespaceUrisToRoot.b"</js>
@@ -158,11 +159,11 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#addNamespaceUrisToRoot()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* 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.
*/
@@ -170,7 +171,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Auto-detect namespace usage.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.autoDetectNamespaces.b"</js>
@@ -182,22 +183,22 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#autoDetectNamespaces(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <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.
- *
+ *
* <p>
* 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.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Auto-detection of namespaces can be costly performance-wise.
@@ -209,7 +210,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Default namespace.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.defaultNamespace.s"</js>
@@ -221,7 +222,7 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#defaultNamespace(String)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies the default namespace URI for this document.
@@ -230,7 +231,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Enable support for XML namespaces.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.enableNamespaces.b"</js>
@@ -242,7 +243,7 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#enableNamespaces(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If not enabled, XML output will not contain any namespaces regardless of any other settings.
@@ -251,7 +252,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Default namespaces.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.namespaces.ls"</js>
@@ -263,7 +264,7 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#defaultNamespace(String)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* The default list of namespaces associated with this serializer.
@@ -272,7 +273,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: XMLSchema namespace.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.xsNamespace.s"</js>
@@ -284,7 +285,7 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#xsNamespace(Namespace)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies the namespace for the <code>XMLSchema</code> namespace, used by the schema generated by the
@@ -325,7 +326,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Sq(PropertyStore ps) {
@@ -342,7 +343,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public SqReadable(PropertyStore ps) {
@@ -360,7 +361,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Ns(PropertyStore ps) {
@@ -379,7 +380,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public NsSq(PropertyStore ps) {
@@ -397,7 +398,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public NsSqReadable(PropertyStore ps) {
@@ -436,7 +437,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -446,7 +447,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces