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:43 UTC
[15/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/json/JsonParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParser.java
index 15cb118..ab98319 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParser.java
@@ -17,16 +17,18 @@ import org.apache.juneau.parser.*;
/**
* Parses any valid JSON text into a POJO model.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Content-Type</code> types: <code>application/json, text/json</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Content-Type</code> types: <code><b>application/json, text/json</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* 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.
- *
+ *
* <p>
* This parser handles all valid JSON syntax.
* In addition, when strict mode is disable, the parser also handles the following:
@@ -40,10 +42,10 @@ import org.apache.juneau.parser.*;
* <li>
* Unquoted attributes.
* </ul>
- *
+ *
* <p>
* 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'>
@@ -68,7 +70,7 @@ import org.apache.juneau.parser.*;
* <li>
* Input consisting of only whitespace or JSON comments are converted to <jk>null</jk>.
* </ul>
- *
+ *
* <p>
* Input can be any of the following:
* <ul class='spaced-list'>
@@ -91,7 +93,7 @@ import org.apache.juneau.parser.*;
* <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)
@@ -120,7 +122,7 @@ public class JsonParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Strict(PropertyStore ps) {
@@ -135,7 +137,7 @@ public class JsonParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public JsonParser(PropertyStore ps) {
@@ -144,7 +146,7 @@ public class JsonParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
* @param consumes The list of media types that this parser consumes (e.g. <js>"application/json"</js>).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
index 049436a..0c42db6 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
@@ -32,7 +32,7 @@ public class JsonParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public JsonParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserSession.java
index ede380d..6cf0932 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserSession.java
@@ -25,7 +25,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link JsonParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -37,7 +37,7 @@ public final class JsonParserSession 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.
@@ -50,12 +50,12 @@ public final class JsonParserSession extends ReaderParserSession {
/**
* Returns <jk>true</jk> if the specified character is whitespace.
- *
+ *
* <p>
* The definition of whitespace is different for strict vs lax mode.
* Strict mode only interprets 0x20 (space), 0x09 (tab), 0x0A (line feed) and 0x0D (carriage return) as whitespace.
* Lax mode uses {@link Character#isWhitespace(int)} to make the determination.
- *
+ *
* @param cp The codepoint.
* @return <jk>true</jk> if the specified character is whitespace.
*/
@@ -67,7 +67,7 @@ public final class JsonParserSession extends ReaderParserSession {
/**
* Returns <jk>true</jk> if the specified character is whitespace or '/'.
- *
+ *
* @param cp The codepoint.
* @return <jk>true</jk> if the specified character is whitespace or '/'.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
index e2aed0a..1f268d5 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
@@ -17,22 +17,24 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO metadata to HTTP responses as JSON.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>application/json+schema, text/json+schema</code>
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>application/json+schema, text/json+schema</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>application/json</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>application/json</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Produces the JSON-schema for the JSON produced by the {@link JsonSerializer} class with the same properties.
*/
public final class JsonSchemaSerializer extends JsonSerializer {
/**
* Constructor.
- *
+ *
* @param ps Initialize with the specified config property store.
*/
public JsonSchemaSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
index 8b8c744..545638c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
@@ -32,7 +32,7 @@ public class JsonSchemaSerializerBuilder extends JsonSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public JsonSchemaSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerSession.java
index 9f24afd..0054fbf 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerSession.java
@@ -22,7 +22,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link JsonSchemaSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -31,7 +31,7 @@ public class JsonSchemaSerializerSession extends JsonSerializerSession {
/**
* 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.
@@ -53,7 +53,7 @@ public class JsonSchemaSerializerSession extends JsonSerializerSession {
/*
* Creates a schema representation of the specified class type.
- *
+ *
* @param eType The class type to get the schema of.
* @param ctx Serialize context used to prevent infinite loops.
* @param attrName The name of the current attribute.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializer.java
index e237b57..27f2aa9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializer.java
@@ -19,15 +19,17 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO models to JSON.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>application/json, text/json</code>
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>application/json, text/json</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>application/json</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>application/json</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* The conversion is as follows...
* <ul class='spaced-list'>
* <li>
@@ -48,21 +50,21 @@ import org.apache.juneau.serializer.*;
* <li>
* {@code beans} are converted to JSON objects.
* </ul>
- *
+ *
* <p>
* The types above are considered "JSON-primitive" object types.
* Any non-JSON-primitive object types are transformed into JSON-primitive object types through
* {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated through the
* {@link BeanContextBuilder#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.
* However, custom serializers can be constructed to fine-tune behavior.
- *
+ *
* <h6 class='topic'>Behavior-specific subclasses</h6>
- *
+ *
* The following direct subclasses are provided for convenience:
* <ul class='spaced-list'>
* <li>
@@ -70,18 +72,18 @@ import org.apache.juneau.serializer.*;
* <li>
* {@link SimpleReadable} - Default serializer, single quotes, simple mode, with whitespace.
* </ul>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Use one of the default serializers to serialize a POJO</jc>
* String json = JsonSerializer.<jsf>DEFAULT</jsf>.serialize(someObject);
- *
+ *
* <jc>// Create a custom serializer for lax syntax using single quote characters</jc>
* JsonSerializer serializer = JsonSerializer.<jsm>create</jsm>().simple().sq().build();
- *
+ *
* <jc>// Clone an existing serializer and modify it to use single-quotes</jc>
* JsonSerializer serializer = JsonSerializer.<jsf>DEFAULT</jsf>.builder().sq().build();
- *
+ *
* <jc>// Serialize a POJO to JSON</jc>
* String json = serializer.serialize(someObject);
* </p>
@@ -96,7 +98,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"JsonSerializer.addBeanTypeProperties.b"</js>
@@ -108,12 +110,12 @@ public class JsonSerializer extends WriterSerializer {
* <li class='jm'>{@link JsonSerializerBuilder#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}.
@@ -122,7 +124,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Configuration property: Prefix solidus <js>'/'</js> characters with escapes.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"JsonSerializer.escapeSolidus.b"</js>
@@ -135,7 +137,7 @@ public class JsonSerializer extends WriterSerializer {
* <li class='jm'>{@link JsonSerializerBuilder#escapeSolidus()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, solidus (e.g. slash) characters should be escaped.
@@ -167,7 +169,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Configuration property: Simple JSON mode.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"JsonSerializer.simpleMode.b"</js>
@@ -181,7 +183,7 @@ public class JsonSerializer extends WriterSerializer {
* <li class='jm'>{@link JsonSerializerBuilder#ssq()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, JSON attribute names will only be quoted when necessary.
@@ -281,7 +283,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Readable(PropertyStore ps) {
@@ -296,7 +298,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Simple(PropertyStore ps) {
@@ -316,7 +318,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public SimpleReadable(PropertyStore ps) {
@@ -338,7 +340,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public SimpleReadableSafe(PropertyStore ps) {
@@ -367,7 +369,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -377,7 +379,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
@@ -427,7 +429,7 @@ public class JsonSerializer extends WriterSerializer {
* <p>
* Note that this method creates a builder initialized to all default settings, whereas {@link #builder()} copies
* the settings of the object called on.
- *
+ *
* @return The schema serializer.
*/
public JsonSchemaSerializer getSchemaSerializer() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
index ac70a1b..e535186 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
@@ -34,7 +34,7 @@ public class JsonSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public JsonSerializerBuilder(PropertyStore ps) {
@@ -53,10 +53,10 @@ public class JsonSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Prefix solidus <js>'/'</js> characters with escapes.
- *
+ *
* <p>
* If <jk>true</jk>, solidus (e.g. slash) characters should be escaped.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link JsonSerializer#JSON_escapeSolidus}
@@ -73,10 +73,10 @@ public class JsonSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Prefix solidus <js>'/'</js> characters with escapes.
- *
+ *
* <p>
* Shortcut for calling <code>escapeSolidus(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link JsonSerializer#JSON_escapeSolidus}
@@ -90,11 +90,11 @@ public class JsonSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Simple JSON mode.
- *
+ *
* <p>
* If <jk>true</jk>, JSON attribute names will only be quoted when necessary.
* <br>Otherwise, they are always quoted.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link JsonSerializer#JSON_simpleMode}
@@ -114,7 +114,7 @@ public class JsonSerializerBuilder extends SerializerBuilder {
*
* <p>
* Shortcut for calling <code>simple(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link JsonSerializer#JSON_simpleMode}
@@ -131,7 +131,7 @@ public class JsonSerializerBuilder extends SerializerBuilder {
*
* <p>
* Shortcut for calling <code>simple().sq()</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link JsonSerializer#JSON_simpleMode}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
index 1ea85b4..3396055 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
@@ -23,7 +23,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link JsonSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -37,7 +37,7 @@ public class JsonSerializerSession extends WriterSerializerSession {
/**
* 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.
@@ -235,7 +235,7 @@ public class JsonSerializerSession extends WriterSerializerSession {
/**
* Returns the {@link JsonSerializer#JSON_addBeanTypeProperties} setting value for this session.
- *
+ *
* @return The {@link JsonSerializer#JSON_addBeanTypeProperties} setting value for this session.
*/
@Override /* SerializerSession */
@@ -245,7 +245,7 @@ public class JsonSerializerSession extends WriterSerializerSession {
/**
* Converts the specified output target object to an {@link JsonWriter}.
- *
+ *
* @param out The output target object.
* @return The output target object wrapped in an {@link JsonWriter}.
* @throws Exception
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonWriter.java
index 977cbcc..635aa0b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonWriter.java
@@ -20,8 +20,9 @@ import org.apache.juneau.serializer.*;
/**
* Specialized writer for serializing JSON.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>This class is not intended for external use.
* </ul>
@@ -55,7 +56,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.
@@ -75,7 +76,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.
@@ -122,7 +123,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.
@@ -170,7 +171,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Appends a URI to the output.
- *
+ *
* @param uri The URI to append to the output.
* @return This object (for method chaining).
* @throws IOException
@@ -197,7 +198,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Performs an indentation only if we're currently past max indentation.
- *
+ *
* @param depth The current indentation depth.
* @return This object (for method chaining).
* @throws IOException
@@ -240,7 +241,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Adds a space only if the current indentation level is below maxIndent.
- *
+ *
* @param indent
* @return This object (for method chaining).
* @throws IOException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/annotation/Json.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/annotation/Json.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/annotation/Json.java
index 6d91626..754158e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/annotation/Json.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/annotation/Json.java
@@ -19,10 +19,10 @@ import java.lang.annotation.*;
/**
* Annotation for specifying various JSON options for the JSON serializers and parsers.
- *
+ *
* <p>
* Can be applied to Java types.
- *
+ *
* <p>
* Can be used for the following:
* <ul class='spaced-list'>
@@ -38,13 +38,13 @@ public @interface Json {
/**
* Wraps beans in a JSON object with the specified attribute name.
- *
+ *
* <p>
* Applies only to {@link ElementType#TYPE}.
- *
+ *
* <p>
* This annotation can be applied to beans as well as other objects serialized to other types (e.g. strings).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Json</ja>(wrapperAttr=<js>"myWrapper"</js>)
@@ -52,7 +52,7 @@ public @interface Json {
* <jk>public int</jk> f1 = 123;
* }
* </p>
- *
+ *
* <p>
* Without the <ja>@Xml</ja> annotations, serializing this bean as JSON would have produced the following...
* <p class='bcode'>
@@ -60,7 +60,7 @@ public @interface Json {
* f1: 123
* }
* </p>
- *
+ *
* <p>
* With the annotations, serializing this bean as XML produces the following...
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
index 44f5868..00fd66b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
@@ -21,8 +21,9 @@ import org.apache.juneau.parser.*;
/**
* Specialized input stream for parsing MessagePack streams.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>This class is not intended for external use.
* </ul>
@@ -59,7 +60,7 @@ public final class MsgPackInputStream extends InputStream {
/**
* Constructor.
- *
+ *
* @param pipe The parser input.
* @throws Exception
*/
@@ -78,7 +79,7 @@ public final class MsgPackInputStream extends InputStream {
/**
* Reads the data type flag from the stream.
- *
+ *
* <p>
* This is the byte that indicates what kind of data follows.
*/
@@ -383,7 +384,7 @@ public final class MsgPackInputStream extends InputStream {
/**
* Returns the length value for the field.
- *
+ *
* <p>
* For ints/floats/bins/strings, this is the number of bytes that the field takes up (minus the data-type flag).
* For arrays, it's the number of array entries.
@@ -493,7 +494,7 @@ public final class MsgPackInputStream extends InputStream {
/**
* Returns the pipe that was passed into the constructor.
- *
+ *
* @return The pipe that was 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/msgpack/MsgPackOutputStream.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java
index 1760da6..74b2d8b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java
@@ -20,8 +20,9 @@ import java.util.concurrent.atomic.*;
/**
* Specialized output stream for serializing MessagePack streams.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>This class is not intended for external use.
* </ul>
@@ -32,7 +33,7 @@ public final class MsgPackOutputStream extends OutputStream {
/**
* Constructor.
- *
+ *
* @param os The output stream being wrapped.
*/
protected MsgPackOutputStream(OutputStream os) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
index 48960f3..d622690 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
@@ -17,10 +17,11 @@ import org.apache.juneau.parser.*;
/**
* Parses a MessagePack stream into a POJO model.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Content-Type</code> types: <code>octal/msgpack</code>
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Content-Type</code> types: <code><b>octal/msgpack</b></code>
*/
public class MsgPackParser extends InputStreamParser {
@@ -38,7 +39,7 @@ public class MsgPackParser extends InputStreamParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public MsgPackParser(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
index 9cc1fd5..1c0d0b6 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
@@ -32,7 +32,7 @@ public class MsgPackParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public MsgPackParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
index 10b880c..400818c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
@@ -22,7 +22,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link MsgPackParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -32,7 +32,7 @@ public final class MsgPackParserSession extends InputStreamParserSession {
/**
* 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/msgpack/MsgPackSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java
index c505a5a..b419cbf 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java
@@ -17,13 +17,13 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO models to MessagePack.
- *
+ *
+ *
* <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>octal/msgpack</code>
- *
+ *
+ * Handles <code>Accept</code> types: <code><b>octal/msgpack</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>octal/msgpack</code>
+ * Produces <code>Content-Type</code> types: <code><b>octal/msgpack</b></code>
*/
public class MsgPackSerializer extends OutputStreamSerializer {
@@ -35,7 +35,7 @@ public class MsgPackSerializer extends OutputStreamSerializer {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"MsgPackSerializer.addBeanTypeProperties.b"</js>
@@ -47,12 +47,12 @@ public class MsgPackSerializer extends OutputStreamSerializer {
* <li class='jm'>{@link MsgPackSerializerBuilder#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}.
@@ -77,7 +77,7 @@ public class MsgPackSerializer extends OutputStreamSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public MsgPackSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
index a74949f..0360c95 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
@@ -32,7 +32,7 @@ public class MsgPackSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public MsgPackSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
index 13b542a..a836d8c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
@@ -23,7 +23,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link MsgPackSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -35,7 +35,7 @@ public final class MsgPackSerializerSession extends OutputStreamSerializerSessio
/**
* 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.
@@ -60,7 +60,7 @@ public final class MsgPackSerializerSession extends OutputStreamSerializerSessio
/**
* Returns the {@link MsgPackSerializer#MSGPACK_addBeanTypeProperties} setting value for this session.
- *
+ *
* @return The {@link MsgPackSerializer#MSGPACK_addBeanTypeProperties} setting value for this session.
*/
@Override /* SerializerSession */
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParser.java
index 62518b9..6623e3b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParser.java
@@ -16,9 +16,10 @@ import org.apache.juneau.*;
/**
* Subclass of {@link Parser} for byte-based parsers.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* This class is typically the parent class of all byte-based parsers.
* It has 1 abstract method to implement...
* <ul>
@@ -29,7 +30,7 @@ public abstract class InputStreamParser extends Parser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
* @param consumes The list of media types that this parser consumes (e.g. <js>"application/json"</js>).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParserSession.java
index 7497193..c12376a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParserSession.java
@@ -14,7 +14,7 @@ package org.apache.juneau.parser;
/**
* Subclass of parser session objects for byte-based parsers.
- *
+ *
* <p>
* This class is NOT thread safe. It is typically discarded after one-time use.
*/
@@ -22,7 +22,7 @@ public abstract class InputStreamParserSession extends ParserSession {
/**
* 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.
@@ -35,7 +35,7 @@ public abstract class InputStreamParserSession extends ParserSession {
/**
* Constructor for sessions that don't require context.
- *
+ *
* @param args
* Runtime session arguments.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParseException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParseException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParseException.java
index f90d497..1945dcd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParseException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParseException.java
@@ -27,7 +27,7 @@ public class ParseException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param location The location of the parse exception.
* @param message The exception message containing {@link MessageFormat}-style arguments.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -38,7 +38,7 @@ public class ParseException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param message The exception message containing {@link MessageFormat}-style arguments.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -48,7 +48,7 @@ public class ParseException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param location The location of the parse exception.
* @param causedBy The inner exception.
*/
@@ -58,7 +58,7 @@ public class ParseException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param causedBy The inner exception.
*/
public ParseException(Exception causedBy) {
@@ -76,10 +76,10 @@ public class ParseException extends FormattedException {
/**
* Returns the highest-level <code>ParseException</code> in the stack trace.
- *
+ *
* <p>
* Useful for JUnit testing of error conditions.
- *
+ *
* @return The root parse exception, or this exception if there isn't one.
*/
public ParseException getRootCause() {
@@ -91,7 +91,7 @@ public class ParseException extends FormattedException {
/**
* Sets the inner cause for this exception.
- *
+ *
* @param cause The inner cause.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Parser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Parser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Parser.java
index de8900a..9d944c1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Parser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Parser.java
@@ -26,12 +26,12 @@ import org.apache.juneau.utils.*;
/**
* Parent class for all Juneau parsers.
- *
+ *
* <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#juneau-marshall.PojoCategories">POJO Categories</a>.
- *
+ *
* <p>
* Some examples of conversions are shown below...
* </p>
@@ -62,8 +62,8 @@ import org.apache.juneau.utils.*;
* <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>
+ * <td class='code'>List<Integer>, <jk>int</jk>[], Float[], Set<Person></td>
+ * </tr>
* <tr>
* <td>number</td>
* <td>Numbers</td>
@@ -86,11 +86,11 @@ import org.apache.juneau.utils.*;
* <td class='code'>String, StringBuilder</td>
* </tr>
* </table>
- *
+ *
* <p>
* In addition, any class types with {@link PojoSwap PojoSwaps} associated with them on the registered
* bean context can also be passed in.
- *
+ *
* <p>
* For example, if the {@link CalendarSwap} transform is used to generalize {@code Calendar} objects to {@code String}
* objects.
@@ -123,7 +123,7 @@ public abstract class Parser extends BeanContext {
/**
* Configuration property: File charset.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Parser.fileCharset.s"</js>
@@ -136,14 +136,14 @@ public abstract class Parser extends BeanContext {
* <li class='jm'>{@link ParserBuilder#fileCharset(Charset)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* The character set to use for reading <code>Files</code> from the file system.
- *
+ *
* <p>
* Used when passing in files to {@link Parser#parse(Object, Class)}.
- *
+ *
* <p>
* <js>"DEFAULT"</js> can be used to indicate the JVM default file system charset.
*
@@ -169,7 +169,7 @@ public abstract class Parser extends BeanContext {
/**
* Configuration property: Input stream charset.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Parser.inputStreamCharset.s"</js>
@@ -182,11 +182,11 @@ public abstract class Parser extends BeanContext {
* <li class='jm'>{@link ParserBuilder#inputStreamCharset(Charset)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* The character set to use for converting <code>InputStreams</code> and byte arrays to readers.
- *
+ *
* <p>
* Used when passing in input streams and byte arrays to {@link Parser#parse(Object, Class)}.
*
@@ -212,7 +212,7 @@ public abstract class Parser extends BeanContext {
/**
* Configuration property: Parser listener.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Parser.listener.c"</js>
@@ -224,7 +224,7 @@ public abstract class Parser extends BeanContext {
* <li class='jm'>{@link ParserBuilder#listener(Class)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Class used to listen for errors and warnings that occur during parsing.
@@ -275,7 +275,7 @@ public abstract class Parser extends BeanContext {
/**
* Configuration property: Strict mode.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Parser.strict.b"</js>
@@ -292,10 +292,10 @@ public abstract class Parser extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, strict mode for the parser is enabled.
- *
+ *
* <p>
* Strict mode can mean different things for different parsers.
- *
+ *
* <table class='styled'>
* <tr><th>Parser class</th><th>Strict behavior</th></tr>
* <tr>
@@ -348,7 +348,7 @@ public abstract class Parser extends BeanContext {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Parser.trimStrings.b"</js>
@@ -361,7 +361,7 @@ public abstract class Parser extends BeanContext {
* <li class='jm'>{@link ParserBuilder#trimStrings()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
@@ -450,7 +450,7 @@ public abstract class Parser extends BeanContext {
/**
* Returns <jk>true</jk> if this parser subclasses from {@link ReaderParser}.
- *
+ *
* @return <jk>true</jk> if this parser subclasses from {@link ReaderParser}.
*/
public boolean isReaderParser() {
@@ -459,11 +459,11 @@ public abstract class Parser extends BeanContext {
/**
* 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}.
- *
+ *
* @param args
* Runtime arguments.
* @return The new session.
@@ -477,44 +477,44 @@ public abstract class Parser extends BeanContext {
/**
* Parses input into the specified object type.
- *
+ *
* <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'>
* ReaderParser p = JsonParser.<jsf>DEFAULT</jsf>;
- *
+ *
* <jc>// Parse into a linked-list of strings.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of beans.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of string keys/values.</jc>
* Map m = p.parse(json, 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 = p.parse(json, 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 #parse(Object, Class)} method instead if you don't need a parameterized map/collection.
* </ul>
- *
+ *
* @param <T> The class type of the object to create.
* @param input
* The input.
@@ -557,30 +557,30 @@ public abstract class Parser extends BeanContext {
/**
* Same as {@link #parse(Object, Type, Type...)} except optimized for a non-parameterized class.
- *
+ *
* <p>
* This is the preferred parse method for simple types since you don't need to cast the results.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* ReaderParser p = JsonParser.<jsf>DEFAULT</jsf>;
- *
+ *
* <jc>// Parse into a string.</jc>
* String s = p.parse(json, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a bean.</jc>
* MyBean b = p.parse(json, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a bean array.</jc>
* MyBean[] ba = p.parse(json, MyBean[].<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of objects.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of object keys/values.</jc>
* Map m = p.parse(json, TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* @param <T> The class type of the object being created.
* @param input
* The input.
@@ -597,10 +597,10 @@ public abstract class Parser extends BeanContext {
/**
* 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.
- *
+ *
* @param <T> The class type of the object being created.
* @param input
* The input.
@@ -630,10 +630,10 @@ public abstract class Parser extends BeanContext {
/**
* Parses the contents of the specified reader and loads the results into the specified map.
- *
+ *
* <p>
* Reader must contain something that serializes to a map (such as text containing a JSON object).
- *
+ *
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
@@ -641,7 +641,7 @@ public abstract class Parser extends BeanContext {
* 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.
@@ -658,7 +658,7 @@ public abstract class Parser extends BeanContext {
/**
* Parses the contents of the specified reader and loads the results into the specified collection.
- *
+ *
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
@@ -666,7 +666,7 @@ public abstract class Parser extends BeanContext {
* The various character-based constructors in {@link ObjectList} (e.g.
* {@link ObjectList#ObjectList(CharSequence,Parser)}.
* </ul>
- *
+ *
* @param <E> The element class type.
* @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.
* @param c The collection being loaded.
@@ -683,18 +683,18 @@ public abstract class Parser extends BeanContext {
/**
* Parses the specified array input with each entry in the object defined by the {@code argTypes}
* 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.
- *
+ *
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
* <li>
* Used to parse argument strings in the {@link PojoIntrospector#invokeMethod(Method, Reader)} method.
* </ul>
- *
+ *
* @param input The input. Subclasses can support different input types.
* @param argTypes Specifies the type of objects to create for each entry in the array.
* @return An array of parsed objects.
@@ -714,7 +714,7 @@ public abstract class Parser extends BeanContext {
/**
* Returns the media types handled based on the values passed to the <code>consumes</code> constructor parameter.
- *
+ *
* @return The list of media types. Never <jk>null</jk>.
*/
public final MediaType[] getMediaTypes() {
@@ -723,7 +723,7 @@ public abstract class Parser extends BeanContext {
/**
* Returns the first media type handled based on the values passed to the <code>consumes</code> constructor parameter.
- *
+ *
* @return The media type.
*/
public final MediaType getPrimaryMediaType() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
index 290270d..dc7ce0e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
@@ -34,7 +34,7 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public ParserBuilder(PropertyStore ps) {
@@ -47,10 +47,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: File charset.
- *
+ *
* <p>
* The character set to use for reading <code>Files</code> from the file system.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_fileCharset}
@@ -67,10 +67,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: File charset.
- *
+ *
* <p>
* The character set to use for reading <code>Files</code> from the file system.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_fileCharset}
@@ -87,10 +87,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Input stream charset.
- *
+ *
* <p>
* The character set to use for converting <code>InputStreams</code> and byte arrays to readers.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_inputStreamCharset}
@@ -107,10 +107,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Input stream charset.
- *
+ *
* <p>
* The character set to use for converting <code>InputStreams</code> and byte arrays to readers.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_inputStreamCharset}
@@ -127,10 +127,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Parser listener.
- *
+ *
* <p>
* Class used to listen for errors and warnings that occur during parsing.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_listener}
@@ -145,10 +145,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Strict mode.
- *
+ *
* <p>
* If <jk>true</jk>, strict mode for the parser is enabled.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -168,7 +168,7 @@ public class ParserBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>strict(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -182,11 +182,11 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
@@ -203,10 +203,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroup.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroup.java
index 80b0e69..a25fae1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroup.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroup.java
@@ -20,9 +20,10 @@ import org.apache.juneau.http.*;
/**
* Represents a group of {@link Parser Parsers} that can be looked up by media type.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Provides the following features:
* <ul class='spaced-list'>
* <li>
@@ -34,36 +35,36 @@ import org.apache.juneau.http.*;
* <li>
* Clones existing groups and all parsers within the group in a single method call.
* </ul>
- *
+ *
* <h6 class='topic'>Match ordering</h6>
- *
+ *
* Parsers are matched against <code>Content-Type</code> strings in the order they exist in this group.
- *
+ *
* <p>
* Adding new entries will cause the entries to be prepended to the group.
* This allows for previous parsers to be overridden through subsequent calls.
- *
+ *
* <p>
* For example, calling <code>g.append(P1.<jk>class</jk>,P2.<jk>class</jk>).append(P3.<jk>class</jk>,P4.<jk>class</jk>)</code>
* will result in the order <code>P3, P4, P1, P2</code>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a new parser group builder</jc>
* ParserGroupBuilder b = ParserGroup.<jsm>create</jsm>();
- *
+ *
* <jc>// Add some parsers to it</jc>
* b.append(JsonParser.<jk>class</jk>, XmlParser.<jk>class</jk>);
- *
+ *
* <jc>// Change settings on parsers simultaneously</jc>
* b.set(BeanContext.<jsf>BEAN_beansRequireSerializable</jsf>, <jk>true</jk>)
* .pojoSwaps(CalendarSwap.ISO8601DT.<jk>class</jk>);
- *
+ *
* ParserGroup g = b.build();
- *
+ *
* <jc>// Find the appropriate parser by Content-Type</jc>
* ReaderParser p = (ReaderParser)g.getParser(<js>"text/json"</js>);
- *
+ *
* <jc>// Parse a bean from JSON</jc>
* String json = <js>"{...}"</js>;
* AddressBook addressBook = p.parse(json, AddressBook.<jk>class</jk>);
@@ -103,7 +104,7 @@ public final class ParserGroup extends BeanContext {
/**
* Constructor.
- *
+ *
* @param ps
* 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.
@@ -132,10 +133,10 @@ public final class ParserGroup extends BeanContext {
/**
* Searches the group for a parser that can handle the specified <l>Content-Type</l> header value.
- *
+ *
* <p>
* The returned object includes both the parser and media type that matched.
- *
+ *
* @param contentTypeHeader The HTTP <l>Content-Type</l> header value.
* @return The parser and media type that matched the content type header, or <jk>null</jk> if no match was made.
*/
@@ -157,7 +158,7 @@ public final class ParserGroup extends BeanContext {
/**
* Same as {@link #getParserMatch(String)} but matches using a {@link MediaType} instance.
- *
+ *
* @param mediaType The HTTP <l>Content-Type</l> header value as a media type.
* @return The parser and media type that matched the media type, or <jk>null</jk> if no match was made.
*/
@@ -167,7 +168,7 @@ public final class ParserGroup extends BeanContext {
/**
* Same as {@link #getParserMatch(String)} but returns just the matched parser.
- *
+ *
* @param contentTypeHeader The HTTP <l>Content-Type</l> header string.
* @return The parser that matched the content type header, or <jk>null</jk> if no match was made.
*/
@@ -178,7 +179,7 @@ public final class ParserGroup extends BeanContext {
/**
* Same as {@link #getParserMatch(MediaType)} but returns just the matched parser.
- *
+ *
* @param mediaType The HTTP media type.
* @return The parser that matched the media type, or <jk>null</jk> if no match was made.
*/
@@ -189,10 +190,10 @@ public final class ParserGroup extends BeanContext {
/**
* Returns the media types that all parsers in this group can handle
- *
+ *
* <p>
* Entries are ordered in the same order as the parsers in the group.
- *
+ *
* @return An unmodifiable list of media types.
*/
public List<MediaType> getSupportedMediaTypes() {
@@ -201,7 +202,7 @@ public final class ParserGroup extends BeanContext {
/**
* Returns the parsers in this group.
- *
+ *
* @return An unmodifiable list of parsers in this group.
*/
public List<Parser> getParsers() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
index b7a967d..39f40dd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
@@ -37,7 +37,7 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Clone an existing parser group builder.
- *
+ *
* @param copyFrom The parser group that we're copying settings and parsers from.
*/
public ParserGroupBuilder(ParserGroup copyFrom) {
@@ -48,7 +48,7 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Registers the specified parsers with this group.
- *
+ *
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
@@ -63,7 +63,7 @@ public class ParserGroupBuilder extends BeanContextBuilder {
* <p>
* When passing in pre-instantiated parsers to this group, applying properties and transforms to the group
* do not affect them.
- *
+ *
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
@@ -77,7 +77,7 @@ public class ParserGroupBuilder extends BeanContextBuilder {
*
* <p>
* Objects can either be instances of parsers or parser classes.
- *
+ *
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
@@ -91,7 +91,7 @@ public class ParserGroupBuilder extends BeanContextBuilder {
*
* <p>
* Objects can either be instances of parsers or parser classes.
- *
+ *
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
@@ -102,10 +102,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Creates a new {@link ParserGroup} object using a snapshot of the settings defined in this builder.
- *
+ *
* <p>
* This method can be called multiple times to produce multiple parser groups.
- *
+ *
* @return A new {@link ParserGroup} object.
*/
@Override /* Context */
@@ -132,10 +132,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: File charset.
- *
+ *
* <p>
* The character set to use for reading <code>Files</code> from the file system.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_fileCharset}
@@ -152,10 +152,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Input stream charset.
- *
+ *
* <p>
* The character set to use for converting <code>InputStreams</code> and byte arrays to readers.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_inputStreamCharset}
@@ -172,10 +172,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Parser listener.
- *
+ *
* <p>
* Class used to listen for errors and warnings that occur during parsing.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_listener}
@@ -190,10 +190,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Strict mode.
- *
+ *
* <p>
* If <jk>true</jk>, strict mode for the parsers are enabled.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -210,10 +210,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Strict mode.
- *
+ *
* <p>
* Shortcut for calling <code>strict(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -227,11 +227,11 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
@@ -248,10 +248,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserListener.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserListener.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserListener.java
index 89586fd..4138e5a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserListener.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserListener.java
@@ -28,11 +28,11 @@ public class ParserListener {
/**
* Gets called when an unknown bean property is detected in a document.
- *
+ *
* <p>
* This method only gets called if {@link BeanContext#BEAN_ignoreUnknownBeanProperties} setting is <jk>true</jk>.
* Otherwise, the parser will throw a {@link ParseException}.
- *
+ *
* @param <T> The class type of the bean.
* @param session The parser session.
* @param pipe
@@ -56,7 +56,7 @@ public class ParserListener {
/**
* Called when an error occurs during parsing but is ignored.
- *
+ *
* @param session The parser session.
* @param pipe
* The parser input.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserMatch.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserMatch.java
index 64a8aec..c521b72 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserMatch.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserMatch.java
@@ -24,7 +24,7 @@ public final class ParserMatch {
/**
* Constructor.
- *
+ *
* @param mediaType The media type of the match.
* @param parser The parser that matched.
*/
@@ -35,7 +35,7 @@ public final class ParserMatch {
/**
* Returns the media type of the parser that matched the HTTP <code>Content-Type</code> header value.
- *
+ *
* @return The media type of the match.
*/
public MediaType getMediaType() {
@@ -44,7 +44,7 @@ public final class ParserMatch {
/**
* Returns the parser that matched the HTTP <code>Content-Type</code> header value.
- *
+ *
* @return The parser of the match.
*/
public Parser getParser() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserPipe.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserPipe.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserPipe.java
index 63dc64e..27a2c15 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserPipe.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserPipe.java
@@ -23,7 +23,7 @@ import org.apache.juneau.internal.*;
/**
* A wrapper around an object that a parser reads its input from.
- *
+ *
* <p>
* For character-based parsers, the input object can be any of the following:
* <ul>
@@ -34,7 +34,7 @@ import org.apache.juneau.internal.*;
* <li>{@link File}
* <li><code><jk>null</jk></code>
* </ul>
- *
+ *
* <p>
* For stream-based parsers, the input object can be any of the following:
* <ul>
@@ -44,7 +44,7 @@ import org.apache.juneau.internal.*;
* <li>{@link String} - Hex-encoded bytes. (not BASE-64!)
* <li><code><jk>null</jk></code>
* </ul>
- *
+ *
* <p>
* Note that Readers and InputStreams will NOT be automatically closed when {@link #close()} is called, but
* streams and readers created from other types (e.g. Files) WILL be automatically closed.
@@ -61,7 +61,7 @@ public final class ParserPipe implements Closeable {
/**
* Constructor.
- *
+ *
* @param input The parser input object.
* @param debug
* If <jk>true</jk>, the input contents will be copied locally and accessible via the {@link #getInputAsString()}
@@ -90,10 +90,10 @@ public final class ParserPipe implements Closeable {
/**
* Shortcut constructor, typically for straight string input.
- *
+ *
* <p>
* Equivalent to calling <code><jk>new</jk> ParserPipe(input, <jk>false</jk>, <jk>false</jk>, <jk>null</jk>, <jk>null</jk>);</code>
- *
+ *
* @param input The input object.
*/
public ParserPipe(Object input) {
@@ -102,10 +102,10 @@ public final class ParserPipe implements Closeable {
/**
* Wraps the specified input object inside an input stream.
- *
+ *
* <p>
* Subclasses can override this method to implement their own input streams.
- *
+ *
* @return The input object wrapped in an input stream, or <jk>null</jk> if the object is null.
* @throws IOException If object could not be converted to an input stream.
*/
@@ -146,10 +146,10 @@ public final class ParserPipe implements Closeable {
/**
* Wraps the specified input object inside a reader.
- *
+ *
* <p>
* Subclasses can override this method to implement their own readers.
- *
+ *
* @return The input object wrapped in a Reader, or <jk>null</jk> if the object is null.
* @throws IOException If object could not be converted to a reader.
*/
@@ -217,10 +217,10 @@ public final class ParserPipe implements Closeable {
/**
* Returns the contents of this pipe as a buffered reader.
- *
+ *
* <p>
* If the reader passed into this pipe is already a buffered reader, that reader will be returned.
- *
+ *
* @return The contents of this pipe as a buffered reader.
* @throws Exception
*/
@@ -230,10 +230,10 @@ public final class ParserPipe implements Closeable {
/**
* Returns the input to this parser as a plain string.
- *
+ *
* <p>
* This method only returns a value if {@link BeanContext#BEAN_debug} is enabled.
- *
+ *
* @return The input as a string, or <jk>null</jk> if debug mode not enabled.
*/
public String getInputAsString() {
@@ -242,7 +242,7 @@ public final class ParserPipe implements Closeable {
/**
* Converts this pipe into a {@link ParserReader}.
- *
+ *
* @return The converted pipe.
* @throws Exception
*/
@@ -258,7 +258,7 @@ public final class ParserPipe implements Closeable {
/**
* Returns <jk>true</jk> if the contents passed into this pipe was a {@link CharSequence}.
- *
+ *
* @return <jk>true</jk> if the contents passed into this pipe was a {@link CharSequence}.
*/
public boolean isString() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
index 3c75e36..16c4e84 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
@@ -19,14 +19,14 @@ import org.apache.juneau.internal.*;
/**
* Similar to a {@link java.io.PushbackReader} with a pushback buffer of 1 character.
- *
+ *
* <p>
* Code is optimized to work with a 1 character buffer.
- *
+ *
* <p>
* Additionally keeps track of current line and column number, and provides the ability to set mark points and capture
* characters from the previous mark point.
- *
+ *
* <p>
* <b>Warning:</b> Not thread safe.
*/
@@ -46,7 +46,7 @@ public class ParserReader extends Reader {
/**
* Constructor.
- *
+ *
* @param pipe The parser input.
* @throws IOException
*/
@@ -69,7 +69,7 @@ public class ParserReader extends Reader {
/**
* Returns the current line number position in this reader.
- *
+ *
* @return The current line number.
*/
public final int getLine() {
@@ -78,7 +78,7 @@ public class ParserReader extends Reader {
/**
* Returns the current column number position in this reader.
- *
+ *
* @return The current column number.
*/
public final int getColumn() {
@@ -87,12 +87,12 @@ public class ParserReader extends Reader {
/**
* Reads a single character.
- *
+ *
* <p>
* 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.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -112,7 +112,7 @@ public class ParserReader extends Reader {
/**
* Same as {@link #read()} but skips over any whitespace characters.
- *
+ *
* @return The first non-whitespace character, or -1 if the end of stream reached.
* @throws IOException
*/
@@ -126,7 +126,7 @@ public class ParserReader extends Reader {
/**
* 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.
*/
@@ -217,10 +217,10 @@ public class ParserReader extends Reader {
/**
* Peeks the next character in the stream.
- *
+ *
* <p>
* This is equivalent to doing a {@code read()} followed by an {@code unread()}.
- *
+ *
* @return The peeked character, or (char)-1 if the end of the stream has been reached.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -233,10 +233,10 @@ public class ParserReader extends Reader {
/**
* Same as {@link #peek()} but skips over any whitespace characters.
- *
+ *
* <p>
* This is equivalent to doing a {@code read()} followed by an {@code unread()}.
- *
+ *
* @return The peeked character, or (char)-1 if the end of the stream has been reached.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -253,7 +253,7 @@ public class ParserReader extends Reader {
/**
* Read the specified number of characters off the stream.
- *
+ *
* @param num The number of characters to read.
* @return The characters packaged as a String.
* @throws IOException If a problem occurred trying to read from the reader.
@@ -271,7 +271,7 @@ public class ParserReader extends Reader {
/**
* Pushes the last read character back into the stream.
- *
+ *
* @return This object (for method chaining).
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -285,7 +285,7 @@ public class ParserReader extends Reader {
/**
* Close this reader and the underlying reader.
- *
+ *
* @throws IOException If a problem occurred trying to read from the reader.
*/
@Override /* Reader */
@@ -296,7 +296,7 @@ public class ParserReader extends Reader {
/**
* Returns the contents of the reusable character buffer as a string, and resets the buffer for next usage.
- *
+ *
* @return The contents of the reusable character buffer as a string.
*/
public final String getMarked() {
@@ -305,13 +305,13 @@ public class ParserReader extends Reader {
/**
* Same as {@link #getMarked()} except allows you to specify offsets into the buffer.
- *
+ *
* <p>
* For example, to return the marked string, but trim the first and last characters, call the following:
* <p class='bcode'>
* getFromMarked(1, -1);
* </p>
- *
+ *
* @param offsetStart The offset of the start position.
* @param offsetEnd The offset of the end position.
* @return The contents of the reusable character buffer as a string.
@@ -338,10 +338,10 @@ public class ParserReader extends Reader {
/**
* Trims off the last character in the marking buffer.
- *
+ *
* <p>
* Useful for removing escape characters from sequences.
- *
+ *
* @return This object (for method chaining).
*/
public final ParserReader delete() {
@@ -351,7 +351,7 @@ public class ParserReader extends Reader {
/**
* Trims off the specified number of last characters in the marking buffer.
* Useful for removing escape characters from sequences.
- *
+ *
* @param count The number of characters to delete.
* @return This object (for method chaining).
*/
@@ -364,11 +364,11 @@ public class ParserReader extends Reader {
/**
* Replaces the last character in the marking buffer with the specified character.
- *
+ *
* <p>
* <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.
* @return This object (for method chaining).
@@ -396,7 +396,7 @@ public class ParserReader extends Reader {
/**
* Replace the last read character in the buffer with the specified character.
- *
+ *
* @param c The new character.
* @return This object (for method chaining).
* @throws IOException
@@ -407,7 +407,7 @@ public class ParserReader extends Reader {
/**
* Subclasses can override this method to provide additional filtering.
- *
+ *
* <p>
* Default implementation simply calls the same method on the underlying reader.
*/
@@ -418,7 +418,7 @@ public class ParserReader extends Reader {
/**
* Returns the combined location information on both this reader and the session.
- *
+ *
* @param session The session object to read the last location on.
* @return A new map describing the current parse location.
*/
@@ -428,7 +428,7 @@ public class ParserReader extends Reader {
/**
* Returns the pipe that was passed into the constructor.
- *
+ *
* @return The pipe that was passed into the constructor.
*/
public final ParserPipe getPipe() {