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:47 UTC
[19/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/html/HtmlSchemaDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
index f538e9c..eb0d0ce 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
@@ -17,21 +17,22 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO metamodels to HTML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/html+schema</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/html+schema</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/html</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/html</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Essentially the same as {@link HtmlSerializer}, except serializes the POJO metamodel instead of the model itself.
- *
+ *
* <p>
* Produces output that describes the POJO metamodel similar to an XML schema document.
- *
+ *
* <p>
* The easiest way to create instances of this class is through the {@link HtmlSerializer#getSchemaSerializer()},
* which will create a schema serializer with the same settings as the originating serializer.
@@ -40,7 +41,7 @@ public final class HtmlSchemaDocSerializer extends HtmlDocSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store to use for creating the context for this serializer.
*/
@@ -50,7 +51,7 @@ public final class HtmlSchemaDocSerializer extends HtmlDocSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializerSession.java
index 4e7f940..1a75407 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializerSession.java
@@ -22,7 +22,7 @@ import org.apache.juneau.transform.*;
/**
* Context object that lives for the duration of a single serialization of {@link HtmlSchemaDocSerializer} and its subclasses.
- *
+ *
* <p>
* This class is NOT thread safe. It is meant to be discarded after one-time use.
*/
@@ -30,7 +30,7 @@ public class HtmlSchemaDocSerializerSession extends HtmlDocSerializerSession {
/**
* 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.
@@ -49,7 +49,7 @@ public class HtmlSchemaDocSerializerSession extends HtmlDocSerializerSession {
/*
* 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/html/HtmlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializer.java
index d46f053..b496180 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializer.java
@@ -21,16 +21,17 @@ import org.apache.juneau.xml.*;
/**
* Serializes POJO models to HTML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/html</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/html</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/html</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/html</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* The conversion is as follows...
* <ul class='spaced-list'>
* <li>
@@ -44,17 +45,17 @@ import org.apache.juneau.xml.*;
* <li>
* Everything else is converted to text.
* </ul>
- *
+ *
* <p>
* This serializer provides several serialization options. Typically, one of the predefined <jsf>DEFAULT</jsf>
* serializers will be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
- *
+ *
* <p>
* The {@link HtmlLink} annotation can be used on beans to add hyperlinks to the output.
- *
+ *
* <h6 class='topic'>Behavior-specific subclasses</h6>
- *
+ *
* The following direct subclasses are provided for convenience:
* <ul class='spaced-list'>
* <li>
@@ -62,25 +63,25 @@ import org.apache.juneau.xml.*;
* <li>
* {@link SqReadable} - Default serializer, single quotes, whitespace added.
* </ul>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Use one of the default serializers to serialize a POJO</jc>
* String html = HtmlSerializer.<jsf>DEFAULT</jsf>.serialize(someObject);
- *
+ *
* <jc>// Create a custom serializer that doesn't use whitespace and newlines</jc>
* HtmlSerializer serializer = <jk>new</jk> HtmlSerializerBuider().ws().build();
- *
+ *
* <jc>// Same as above, except uses cloning</jc>
* HtmlSerializer serializer = HtmlSerializer.<jsf>DEFAULT</jsf>.builder().ws().build();
- *
+ *
* <jc>// Serialize POJOs to HTML</jc>
- *
+ *
* <jc>// Produces: </jc>
* <jc>// <ul><li>1<li>2<li>3</ul></jc>
* List l = new ObjectList(1, 2, 3);
* String html = HtmlSerializer.<jsf>DEFAULT</jsf>.serialize(l);
- *
+ *
* <jc>// Produces: </jc>
* <jc>// <table> </jc>
* <jc>// <tr><th>firstName</th><th>lastName</th></tr> </jc>
@@ -93,7 +94,7 @@ import org.apache.juneau.xml.*;
* l.add(<jk>new</jk> ObjectMap(<js>"{firstName:'Billy',lastName:'TheKid'}"</js>));
* l.add(<jk>new</jk> ObjectMap(<js>"{firstName:'Barney',lastName:'Miller'}"</js>));
* String html = HtmlSerializer.<jsf>DEFAULT</jsf>.serialize(l);
- *
+ *
* <jc>// Produces: </jc>
* <jc>// <table> </jc>
* <jc>// <tr><th>key</th><th>value</th></tr> </jc>
@@ -102,7 +103,7 @@ import org.apache.juneau.xml.*;
* <jc>// </table> </jc>
* Map m = <jk>new</jk> ObjectMap(<js>"{foo:'bar',baz:123}"</js>);
* String html = HtmlSerializer.<jsf>DEFAULT</jsf>.serialize(m);
- *
+ *
* <jc>// HTML elements can be nested arbitrarily deep</jc>
* <jc>// Produces: </jc>
* <jc>// <table> </jc>
@@ -118,8 +119,8 @@ import org.apache.juneau.xml.*;
* <jc>// </td></tr> </jc>
* <jc>// </table> </jc>
* Map m = <jk>new</jk> ObjectMap(<js>"{foo:'bar',baz:123}"</js>);
- * m.put("someNumbers", new ObjectList(1, 2, 3));
- * m.put(<js>"someSubMap"</js>, new ObjectMap(<js>"{a:'b'}"</js>));
+ * m.put(<js>"someNumbers"</js>, <jk>new</jk> ObjectList(1, 2, 3));
+ * m.put(<js>"someSubMap"</js>, <jk>new</jk> ObjectMap(<js>"{a:'b'}"</js>));
* String html = HtmlSerializer.<jsf>DEFAULT</jsf>.serialize(m);
* </p>
*/
@@ -133,7 +134,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.addBeanTypeProperties.b"</js>
@@ -145,7 +146,7 @@ public class HtmlSerializer extends XmlSerializer {
* <li class='jm'>{@link HtmlSerializerBuilder#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
@@ -153,7 +154,7 @@ public class HtmlSerializer extends XmlSerializer {
* This is used to recreate the correct objects during parsing if the object types cannot be inferred.
* For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined
* from the value type.
- *
+ *
* <p>
* When present, this value overrides the {@link #SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -162,7 +163,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: Add key/value headers on bean/map tables.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.addKeyValueTableHeaders.b"</js>
@@ -184,7 +185,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: Look for URLs in {@link String Strings}.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.detectLinksInStrings.b"</js>
@@ -196,7 +197,7 @@ public class HtmlSerializer extends XmlSerializer {
* <li class='jm'>{@link HtmlSerializerBuilder#detectLinksInStrings(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If a string looks like a URL (e.g. starts with <js>"http://"</js> or <js>"https://"</js>, then treat it like a URL
@@ -206,7 +207,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: The parameter name to use when using {@link #HTML_lookForLabelParameters}.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.labelParameter.s"</js>
@@ -223,7 +224,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: Look for link labels in the <js>"label"</js> parameter of the URL.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.lookForLabelParameters.b"</js>
@@ -235,11 +236,11 @@ public class HtmlSerializer extends XmlSerializer {
* <li class='jm'>{@link HtmlSerializerBuilder#lookForLabelParameters(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If the URL has a label parameter (e.g. <js>"?label=foobar"</js>), then use that as the anchor text of the link.
- *
+ *
* <p>
* The parameter name can be changed via the {@link #HTML_labelParameter} property.
*/
@@ -247,7 +248,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: Anchor text source.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.uriAnchorText.s"</js>
@@ -263,12 +264,12 @@ public class HtmlSerializer extends XmlSerializer {
* <li class='jm'>{@link HtmlSerializerBuilder#uriAnchorText(AnchorText)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* When creating anchor tags (e.g. <code><xt><a</xt> <xa>href</xa>=<xs>'...'</xs>
* <xt>></xt>text<xt></a></xt></code>) in HTML, this setting defines what to set the inner text to.
- *
+ *
* <p>
* See the {@link AnchorText} enum for possible values.
*/
@@ -298,7 +299,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Sq(PropertyStore ps) {
@@ -315,7 +316,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public SqReadable(PropertyStore ps) {
@@ -345,7 +346,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -355,7 +356,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
index 0b2ef60..564e8d2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
@@ -35,7 +35,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public HtmlSerializerBuilder(PropertyStore ps) {
@@ -54,7 +54,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Configuration property: Add key/value headers on bean/map tables.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_addKeyValueTableHeaders}
@@ -74,7 +74,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
*
* <p>
* Shortcut for calling <code>addKeyValueTableHeaders(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_addKeyValueTableHeaders}
@@ -88,12 +88,12 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Configuration property: Look for URLs in {@link String Strings}.
- *
+ *
* <p>
* If a string looks like a URL (e.g. starts with <js>"http://"</js> or <js>"https://"</js>, then treat it like a URL
* and make it into a hyperlink based on the rules specified by {@link HtmlSerializer#HTML_uriAnchorText}.
- *
- *
+ *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_detectLinksInStrings}
@@ -110,7 +110,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Configuration property: The parameter name to use when using {@link HtmlSerializer#HTML_lookForLabelParameters}.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_labelParameter}
@@ -127,10 +127,10 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Configuration property: Look for link labels in the <js>"label"</js> parameter of the URL.
- *
+ *
* <p>
* If the URL has a label parameter (e.g. <js>"?label=foobar"</js>), then use that as the anchor text of the link.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_lookForLabelParameters}
@@ -147,11 +147,11 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Configuration property: Anchor text source.
- *
+ *
* <p>
* When creating anchor tags (e.g. <code><xt><a</xt> <xa>href</xa>=<xs>'...'</xs><xt>></xt>text<xt></a></xt></code>)
* in HTML, this setting defines what to set the inner text to.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_uriAnchorText}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
index c01a2c3..ff048b1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
@@ -29,7 +29,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Session object that lives for the duration of a single use of {@link HtmlSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -48,7 +48,7 @@ public class HtmlSerializerSession 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.
@@ -84,7 +84,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Converts the specified output target object to an {@link HtmlWriter}.
- *
+ *
* @param out The output target object.
* @return The output target object wrapped in an {@link HtmlWriter}.
* @throws Exception
@@ -101,7 +101,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Returns <jk>true</jk> if the specified object is a URL.
- *
+ *
* @param cm The ClassMeta of the object being serialized.
* @param pMeta
* The property metadata of the bean property of the object.
@@ -121,7 +121,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Returns the anchor text to use for the specified URL object.
- *
+ *
* @param pMeta
* The property metadata of the bean property of the object.
* Can be <jk>null</jk> if the object isn't from a bean property.
@@ -168,7 +168,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Returns the {@link HtmlSerializer#HTML_addKeyValueTableHeaders} setting value for this session.
- *
+ *
* @return The {@link HtmlSerializer#HTML_addKeyValueTableHeaders} setting value for this session.
*/
public final boolean isAddKeyValueTableHeaders() {
@@ -177,7 +177,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Returns the {@link HtmlSerializer#HTML_addBeanTypeProperties} setting value for this session.
- *
+ *
* @return The {@link HtmlSerializer#HTML_addBeanTypeProperties} setting value for this session.
*/
@Override /* SerializerSession */
@@ -197,7 +197,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Main serialization routine.
- *
+ *
* @param session The serialization context object.
* @param o The object being serialized.
* @param w The writer to serialize to.
@@ -211,7 +211,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Serialize the specified object to the specified writer.
- *
+ *
* @param out The writer.
* @param o The object to serialize.
* @param eType The expected type of the object if this is a bean property.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
index 1676dbb..4a2cedd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
@@ -17,16 +17,17 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJOs to HTTP responses as stripped HTML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/html+stripped</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/html+stripped</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/html</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/html</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Produces the same output as {@link HtmlDocSerializer}, but without the header and body tags and page title and
* description.
* Used primarily for JUnit testing the {@link HtmlDocSerializer} class.
@@ -35,7 +36,7 @@ public class HtmlStrippedDocSerializer extends HtmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public HtmlStrippedDocSerializer(PropertyStore ps) {
@@ -44,7 +45,7 @@ public class HtmlStrippedDocSerializer extends HtmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializerSession.java
index 1459fba..c90cf37 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializerSession.java
@@ -19,7 +19,7 @@ import org.apache.juneau.serializer.*;
/**
* Session object that lives for the duration of a single use of {@link HtmlStrippedDocSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe. It is meant to be discarded after one-time use.
*/
@@ -27,7 +27,7 @@ public class HtmlStrippedDocSerializerSession extends HtmlSerializerSession {
/**
* 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/html/HtmlWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlWriter.java
index 559cae4..b5386ef 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlWriter.java
@@ -26,7 +26,7 @@ public class HtmlWriter extends XmlWriter {
/**
* Constructor.
- *
+ *
* @param out The writer being wrapped.
* @param useWhitespace If <jk>true</jk>, tabs will be used in output.
* @param maxIndent The maximum indentation level.
@@ -41,7 +41,7 @@ public class HtmlWriter extends XmlWriter {
/**
* Append an attribute with a URI value.
- *
+ *
* @param name The attribute name.
* @param value The attribute value. Can be any object whose <code>toString()</code> method returns a URI.
* @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/html/SimpleHtmlWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java
index 299ba7d..f845b36 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java
@@ -16,7 +16,7 @@ import java.io.*;
/**
* Utility class for creating custom HTML.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* String table = <jk>new</jk> SimpleHtmlWriter().sTag(<js>"table"</js>).sTag(<js>"tr"</js>).sTag(<js>"td"</js>)
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/annotation/Html.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/annotation/Html.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/annotation/Html.java
index f8698d1..7cc74e9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/annotation/Html.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/annotation/Html.java
@@ -30,14 +30,14 @@ public @interface Html {
/**
* Use the specified anchor text when serializing a URI.
- *
+ *
* <p>
* The text can contain any bean property values resolved through variables of the form <js>"{property-name}"</js>.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jk>public class</jk> FileSpace {
- *
+ *
* <ja>@Html</ja>(anchorText=<js>"drive/{drive}"</js>)
* <jk>public</jk> String getDrive() {
* ...;
@@ -49,7 +49,7 @@ public @interface Html {
/**
* Treat as plain text.
- *
+ *
* <p>
* Object is serialized to a String using the <code>toString()</code> method and written directly to output.
* Useful when you want to serialize custom HTML.
@@ -58,7 +58,7 @@ public @interface Html {
/**
* Treat as XML.
- *
+ *
* <p>
* Useful when creating beans that model HTML elements.
*/
@@ -66,10 +66,10 @@ public @interface Html {
/**
* Adds a hyperlink to a bean property when rendered as HTML.
- *
+ *
* <p>
* The text can contain any bean property values resolved through variables of the form <js>"{property-name}"</js>.
- *
+ *
* <p>
* The URLs can be any of the following forms:
* <ul>
@@ -79,11 +79,11 @@ public @interface Html {
* <li>Servlet-relative - e.g. <js>"servlet:/myPath"</js>
* <li>Path-info-relative - e.g. <js>"myPath"</js>
* </ul>
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jk>public class</jk> FileSpace {
- *
+ *
* <ja>@Html</ja>(link=<js>"servlet:/drive/{drive}"</js>)
* <jk>public</jk> String getDrive() {
* ...;
@@ -95,7 +95,7 @@ public @interface Html {
/**
* When <jk>true</jk>, don't add headers to tables.
- *
+ *
* <p>
* Default is <jk>false</jk>.
*/
@@ -103,7 +103,7 @@ public @interface Html {
/**
* When <jk>true</jk>, collections of beans should be rendered as trees instead of tables.
- *
+ *
* <p>
* Default is <jk>false</jk>.
*/
@@ -111,7 +111,7 @@ public @interface Html {
/**
* Associates an {@link HtmlRender} with a bean property for custom HTML rendering of the property.
- *
+ *
* <p>
* This annotation applies to bean properties and classes.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Accept.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Accept.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Accept.java
index f095f97..7b56fad 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Accept.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Accept.java
@@ -21,25 +21,25 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept</l> HTTP request header.
- *
+ *
* <p>
* Content-Types that are acceptable for the response.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept: text/plain
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Accept request-header field can be used to specify certain media types which are acceptable for the response.
* Accept headers can be used to indicate that the request is specifically limited to a small set of desired types, as
* in the case of a request for an in-line image.
- *
+ *
* <p class='bcode'>
* Accept = "Accept" ":
* #( media-range [ accept-params ] )
- *
+ *
* media-range = ( "* /*"
* | ( type "/" "*" )
* | ( type "/" subtype )
@@ -47,12 +47,12 @@ import org.apache.juneau.internal.*;
* accept-params = ";" "q" "=" qvalue *( accept-extension )
* accept-extension = ";" token [ "=" ( token | quoted-string ) ]
* </p>
- *
+ *
* <p>
* The asterisk "*" character is used to group media types into ranges, with "* /*" indicating all media types and
* "type/*" indicating all subtypes of that type.
* The media-range MAY include media type parameters that are applicable to that range.
- *
+ *
* <p>
* Each media-range MAY be followed by one or more accept-params, beginning with the "q" parameter for indicating a
* relative quality factor.
@@ -60,7 +60,7 @@ import org.apache.juneau.internal.*;
* Quality factors allow the user or user agent to indicate the relative degree of preference for that media-range,
* using the qvalue scale from 0 to 1 (section 3.9).
* The default value is q=1.
- *
+ *
* <p>
* Note: Use of the "q" parameter name to separate media type parameters from Accept extension parameters is due to
* historical practice.
@@ -68,7 +68,7 @@ import org.apache.juneau.internal.*;
* believed to be unlikely given the lack of any "q" parameters in the IANA
* media type registry and the rare usage of any media type parameters in Accept.
* Future media types are discouraged from registering any parameter named "q".
- *
+ *
* <p>
* The example
* <p class='bcode'>
@@ -77,26 +77,26 @@ import org.apache.juneau.internal.*;
* <p>
* SHOULD be interpreted as "I prefer audio/basic, but send me any audio type if it is the best available after an 80%
* mark-down in quality."
- *
+ *
* <p>
* If no Accept header field is present, then it is assumed that the client accepts all media types.
- *
+ *
* <p>
* If an Accept header field is present, and if the server cannot send a response which is acceptable according to the
* combined Accept field value, then the server SHOULD send a 406 (not acceptable) response.
- *
+ *
* <p>
* A more elaborate example is
* <p class='bcode'>
* Accept: text/plain; q=0.5, text/html,
* text/x-dvi; q=0.8, text/x-c
* </p>
- *
+ *
* <p>
* Verbally, this would be interpreted as "text/html and text/x-c are the preferred media types, but if they do not
* exist, then send the
* text/x-dvi entity, and if that does not exist, send the text/plain entity."
- *
+ *
* <p>
* Media ranges can be overridden by more specific media ranges or specific media types.
* If more than one media range applies to a given type, the most specific reference has precedence.
@@ -112,7 +112,7 @@ import org.apache.juneau.internal.*;
* <li>text/*
* <li>* /*
* </ol>
- *
+ *
* <p>
* The media type quality factor associated with a given type is determined by finding the media range with the highest
* precedence which matches that type.
@@ -131,12 +131,12 @@ import org.apache.juneau.internal.*;
* text/html;level=2 = 0.4
* text/html;level=3 = 0.7
* </p>
- *
+ *
* <p>
* Note: A user agent might be provided with a default set of quality values for certain media ranges.
* However, unless the user agent is a closed system which cannot interact with other rendering agents, this default
* set ought to be configurable by the user.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -152,7 +152,7 @@ public final class Accept {
/**
* Returns a parsed <code>Accept</code> header.
- *
+ *
* @param value The <code>Accept</code> header string.
* @return The parsed <code>Accept</code> header, or <jk>null</jk> if the string was null.
*/
@@ -176,10 +176,10 @@ public final class Accept {
/**
* Returns the list of the media ranges that make up this header.
- *
+ *
* <p>
* The media ranges in the list are sorted by their q-value in descending order.
- *
+ *
* @return An unmodifiable list of media ranges.
*/
public List<MediaTypeRange> asRanges() {
@@ -188,7 +188,7 @@ public final class Accept {
/**
* Given a list of media types, returns the best match for this <code>Accept</code> header.
- *
+ *
* <p>
* Note that fuzzy matching is allowed on the media types where the <code>Accept</code> header may
* contain additional subtype parts.
@@ -197,11 +197,11 @@ public final class Accept {
* isn't found.
* <br>The purpose for this is to allow serializers to match when artifacts such as <code>id</code> properties are
* present in the header.
- *
+ *
* <p>
* See <a class='doclink' href='https://www.w3.org/TR/activitypub/#retrieving-objects'>
* ActivityPub / Retrieving Objects</a>
- *
+ *
* @param mediaTypes The media types to match against.
* @return The index into the array of the best match, or <code>-1</code> if no suitable matches could be found.
*/
@@ -235,11 +235,11 @@ public final class Accept {
/**
* Convenience method for searching through all of the subtypes of all the media ranges in this header for the
* presence of a subtype fragment.
- *
+ *
* <p>
* For example, given the header <js>"text/json+activity"</js>, calling
* <code>hasSubtypePart(<js>"activity"</js>)</code> returns <jk>true</jk>.
- *
+ *
* @param part The media type subtype fragment.
* @return <jk>true</jk> if subtype fragment exists.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptCharset.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptCharset.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptCharset.java
index 39e6c79..3d00338 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptCharset.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptCharset.java
@@ -19,19 +19,19 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept-Charset</l> HTTP request header.
- *
+ *
* <p>
* Character sets that are acceptable.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept-Charset: utf-8
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Accept-Charset request-header field can be used to indicate what character sets are acceptable for the response.
- *
+ *
* <p>
* This field allows clients capable of understanding more comprehensive or special- purpose character sets to signal
* that capability to a server which is capable of representing documents in those character sets.
@@ -39,7 +39,7 @@ import org.apache.juneau.internal.*;
* Accept-Charset = "Accept-Charset" ":"
* 1#( ( charset | "*" )[ ";" "q" "=" qvalue ] )
* </p>
- *
+ *
* <p>
* Character set values are described in section 3.4. Each charset MAY be given an associated quality value which
* represents the user's preference for that charset.
@@ -48,23 +48,23 @@ import org.apache.juneau.internal.*;
* <p class='bcode'>
* Accept-Charset: iso-8859-5, unicode-1-1;q=0.8
* </p>
- *
+ *
* <p>
* The special value "*", if present in the Accept-Charset field, matches every character set (including ISO-8859-1)
* which is not mentioned elsewhere in the Accept-Charset field.
- *
+ *
* <p>
* If no "*" is present in an Accept-Charset field, then all character sets not explicitly mentioned get a quality
* value of 0, except for ISO-8859-1, which gets a quality value of 1 if not explicitly mentioned.
- *
+ *
* <p>
* If no Accept-Charset header is present, the default is that any character set is acceptable.
- *
+ *
* <p>
* If an Accept-Charset header is present, and if the server cannot send a response which is acceptable according to
* the Accept-Charset header, then the server SHOULD send an error response with the 406 (not acceptable) status code,
* though the sending of an unacceptable response is also allowed.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -80,7 +80,7 @@ public final class AcceptCharset extends HeaderRangeArray {
/**
* Returns a parsed <code>Accept-Charset</code> header.
- *
+ *
* @param value The <code>Accept-Charset</code> header string.
* @return The parsed <code>Accept-Charset</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptEncoding.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptEncoding.java
index 9a8a516..071c6d2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptEncoding.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptEncoding.java
@@ -18,26 +18,26 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept-Encoding</l> HTTP request header.
- *
+ *
* <p>
* List of acceptable encodings.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept-Encoding: gzip, deflate
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Accept-Encoding request-header field is similar to Accept, but restricts the content-codings (section 3.5) that
* are acceptable in the response.
- *
+ *
* <p class='bcode'>
* Accept-Encoding = "Accept-Encoding" ":"
* 1#( codings [ ";" "q" "=" qvalue ] )
* codings = ( content-coding | "*" )
* </p>
- *
+ *
* <p>
* Examples of its use are:
* <p class='bcode'>
@@ -47,7 +47,7 @@ import org.apache.juneau.internal.*;
* Accept-Encoding: compress;q=0.5, gzip;q=1.0
* Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0
* </p>
- *
+ *
* <p>
* A server tests whether a content-coding is acceptable, according to an Accept-Encoding field, using these rules:
* <ol>
@@ -63,28 +63,28 @@ import org.apache.juneau.internal.*;
* "identity" content-coding.
* If the Accept-Encoding field-value is empty, then only the "identity" encoding is acceptable.
* </ol>
- *
+ *
* <p>
* If an Accept-Encoding field is present in a request, and if the server cannot send a response which is acceptable
* according to the Accept-Encoding header, then the server SHOULD send an error response with the 406 (Not Acceptable)
* status code.
- *
+ *
* <p>
* If no Accept-Encoding field is present in a request, the server MAY assume that the client will accept any content
* coding.
* In this case, if "identity" is one of the available content-codings, then the server SHOULD use the "identity"
* content-coding, unless it has additional information that a different content-coding is meaningful to the client.
- *
+ *
* <p>
* Note: If the request does not include an Accept-Encoding field, and if the "identity" content-coding is unavailable,
* then content-codings commonly understood by HTTP/1.0 clients (i.e.,"gzip" and "compress") are preferred; some older
* clients improperly display messages sent with other content-codings.
* The server might also make this decision based on information about the particular user-agent or client.
- *
+ *
* <p>
* Note: Most HTTP/1.0 applications do not recognize or obey qvalues associated with content-codings.
* This means that qvalues will not work and are not permitted with x-gzip or x-compress.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -100,7 +100,7 @@ public final class AcceptEncoding extends HeaderRangeArray {
/**
* Returns a parsed <code>Accept-Encoding</code> header.
- *
+ *
* @param value The <code>Accept-Encoding</code> header string.
* @return The parsed <code>Accept-Encoding</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptLanguage.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptLanguage.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptLanguage.java
index c855445..b9bef20 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptLanguage.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptLanguage.java
@@ -18,27 +18,27 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept-Language</l> HTTP request header.
- *
+ *
* <p>
* List of acceptable human languages for response.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept-Language: en-US
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Accept-Language request-header field is similar to Accept, but restricts the set of natural languages that are
* preferred as a response to the request.
* Language tags are defined in section 3.10.
- *
+ *
* <p class='bcode'>
* Accept-Language = "Accept-Language" ":"
* 1#( language-range [ ";" "q" "=" qvalue ] )
* language-range = ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) | "*" )
* </p>
- *
+ *
* <p>
* Each language-range MAY be given an associated quality value which represents an estimate of the user's preference
* for the languages specified by that range.
@@ -49,46 +49,46 @@ import org.apache.juneau.internal.*;
* </p>
* <p>
* ...would mean: "I prefer Danish, but will accept British English and other types of English."
- *
+ *
* <p>
* A language-range matches a language-tag if it exactly equals the tag, or if it exactly equals a prefix of the tag
* such that the first tag character following the prefix is "-".
- *
+ *
* <p>
* The special range "*", if present in the Accept-Language field, matches every tag not matched by any other range
* present in the Accept-Language field.
- *
+ *
* <p>
* Note: This use of a prefix matching rule does not imply that language tags are assigned to languages in such a way
* that it is always true that if a user understands a language with a certain
* tag, then this user will also understand all languages with tags for which this tag is a prefix.
* The prefix rule simply allows the use of prefix tags if this is the case.
- *
+ *
* <p>
* The language quality factor assigned to a language-tag by the Accept-Language field is the quality value of the
* longest language- range in the field that matches the language-tag.
- *
+ *
* <p>
* If no language- range in the field matches the tag, the language quality factor assigned is 0.
- *
+ *
* <p>
* If no Accept-Language header is present in the request, the server SHOULD assume that all languages are equally
* acceptable.
- *
+ *
* <p>
* If an Accept-Language header is present, then all languages which are assigned a quality factor greater than 0 are
* acceptable.
- *
+ *
* <p>
* It might be contrary to the privacy expectations of the user to send an Accept-Language header with the complete
* linguistic preferences of the user in every request.
* For a discussion of this issue, see section 15.1.4.
- *
+ *
* <p>
* As intelligibility is highly dependent on the individual user, it is recommended that client applications make the
* choice of linguistic preference available to the user.
* If the choice is not made available, then the Accept-Language header field MUST NOT be given in the request.
- *
+ *
* <p>
* Note: When making the choice of linguistic preference available to the user, we remind implementors of the fact that
* users are not familiar with the details of language matching as described above, and should provide appropriate
@@ -96,7 +96,7 @@ import org.apache.juneau.internal.*;
* As an example, users might assume that on selecting "en-gb", they will be served any kind of English document if
* British English is not available.
* A user agent might suggest in such a case to add "en" to get the best matching behavior.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -112,7 +112,7 @@ public final class AcceptLanguage extends HeaderRangeArray {
/**
* Returns a parsed <code>Accept-Language</code> header.
- *
+ *
* @param value The <code>Accept-Language</code> header string.
* @return The parsed <code>Accept-Language</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptRanges.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptRanges.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptRanges.java
index 18023b8..9650084 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptRanges.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptRanges.java
@@ -14,24 +14,24 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Accept-Range</l> HTTP response header.
- *
+ *
* <p>
* What partial content range types this server supports via byte serving.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept-Ranges: bytes
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Accept-Ranges response-header field allows the server to indicate its acceptance of range requests for a
* resource:
* <p class='bcode'>
* Accept-Ranges = "Accept-Ranges" ":" acceptable-ranges
* acceptable-ranges = 1#range-unit | "none"
* </p>
- *
+ *
* <p>
* Origin servers that accept byte-range requests MAY send...
* <p class='bcode'>
@@ -39,13 +39,13 @@ package org.apache.juneau.http;
* </p>
* <p>
* ...but are not required to do so.
- *
+ *
* <p>
* Clients MAY generate byte-range requests without having received this header for the resource involved.
- *
+ *
* <p>
* Range units are defined in section 3.12.
- *
+ *
* <p>
* Servers that do not accept any kind of range request for a resource MAY send...
* <p class='bcode'>
@@ -53,7 +53,7 @@ package org.apache.juneau.http;
* </p>
* <p>
* ...to advise the client not to attempt a range request.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -67,7 +67,7 @@ public final class AcceptRanges extends HeaderString {
/**
* Returns a parsed <code>Accept-Ranges</code> header.
- *
+ *
* @param value The <code>Accept-Ranges</code> header string.
* @return The parsed <code>Accept-Ranges</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Age.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Age.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Age.java
index 8cbdff0..4286b33 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Age.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Age.java
@@ -14,41 +14,41 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Age</l> HTTP response header.
- *
+ *
* <p>
* The age the object has been in a proxy cache in seconds.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Age: 12
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Age response-header field conveys the sender's estimate of the amount of time since the response (or its
* revalidation) was generated at the origin server.
* A cached response is "fresh" if its age does not exceed its freshness lifetime.
* Age values are calculated as specified in section 13.2.3.
- *
+ *
* <p class='bcode'>
* Age = "Age" ":" age-value
* age-value = delta-seconds
* </p>
- *
+ *
* <p>
* Age values are non-negative decimal integers, representing time in seconds.
- *
+ *
* <p>
* If a cache receives a value larger than the largest positive integer it can represent, or if any of its age
* calculations overflows, it MUST transmit an Age header with a value of 2147483648 (2^31).
- *
+ *
* <p>
* An HTTP/1.1 server that includes a cache MUST include an Age header field in every response generated from its own
* cache.
- *
+ *
* <p>
* Caches SHOULD use an arithmetic type of at least 31 bits of range.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -62,7 +62,7 @@ public final class Age extends HeaderInteger {
/**
* Returns a parsed <code>Age</code> header.
- *
+ *
* @param value The <code>Age</code> header string.
* @return The parsed <code>Age</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Allow.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Allow.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Allow.java
index b0fab92..21dbc29 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Allow.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Allow.java
@@ -14,51 +14,51 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Allow</l> HTTP response header.
- *
+ *
* <p>
* Valid methods for a specified resource. To be used for a 405 Method not allowed.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Allow: GET, HEAD
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Allow entity-header field lists the set of methods supported by the resource identified by the Request-URI.
* The purpose of this field is strictly to inform the recipient of valid methods associated with the resource.
* An Allow header field MUST be present in a 405 (Method Not Allowed) response.
- *
+ *
* <p class='bcode'>
* Allow = "Allow" ":" #Method
* </p>
- *
+ *
* <p>
* Example of use:
* <p class='bcode'>
* Allow: GET, HEAD, PUT
* </p>
- *
+ *
* <p>
* This field cannot prevent a client from trying other methods.
* However, the indications given by the Allow header field value SHOULD be followed.
- *
+ *
* <p>
* The actual set of allowed methods is defined by the origin server at the time of each request.
- *
+ *
* <p>
* The Allow header field MAY be provided with a PUT request to recommend the methods to be supported by the new or
* modified resource.
- *
+ *
* <p>
* The server is not required to support these methods and SHOULD include an Allow header in the response giving the
* actual supported methods.
- *
+ *
* <p>
* A proxy MUST NOT modify the Allow header field even if it does not understand all the methods specified, since the
* user agent might
* have other means of communicating with the origin server.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -72,7 +72,7 @@ public final class Allow extends HeaderStringArray {
/**
* Returns a parsed <code>Allow</code> header.
- *
+ *
* @param value The <code>Allow</code> header string.
* @return The parsed <code>Allow</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Authorization.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Authorization.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Authorization.java
index 07412c8..8a3cfdc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Authorization.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Authorization.java
@@ -14,36 +14,36 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Authorization</l> HTTP request header.
- *
+ *
* <p>
* Authentication credentials for HTTP authentication.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* A user agent that wishes to authenticate itself with a server--usually, but not necessarily, after receiving a 401
* response--does so by including an Authorization request-header field with the request.
- *
+ *
* <p>
* The Authorization field value consists of credentials containing the authentication information of the user agent for
* the realm of the resource being requested.
- *
+ *
* <p class='bcode'>
* Authorization = "Authorization" ":" credentials
* </p>
- *
+ *
* <p>
* HTTP access authentication is described in "HTTP Authentication: Basic and Digest Access Authentication".
- *
+ *
* <p>
* If a request is authenticated and a realm specified, the same credentials SHOULD be valid for all other requests
* within this realm (assuming that the authentication scheme itself does not require otherwise, such as credentials
* that vary according to a challenge value or using synchronized clocks).
- *
+ *
* <p>
* When a shared cache (see section 13.7) receives a request containing an Authorization field, it MUST NOT return the
* corresponding response as a reply to any other request, unless one of the following specific exceptions holds:
@@ -62,7 +62,7 @@ package org.apache.juneau.http;
* <li>If the response includes the "public" cache-control directive, it MAY be returned in reply to any subsequent
* request.
* </ol>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -76,7 +76,7 @@ public final class Authorization extends HeaderString {
/**
* Returns a parsed <code>Authorization</code> header.
- *
+ *
* @param value The <code>Authorization</code> header string.
* @return The parsed <code>Authorization</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/CacheControl.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/CacheControl.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/CacheControl.java
index 8c46228..b618673 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/CacheControl.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/CacheControl.java
@@ -14,33 +14,33 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Cache-Control</l> HTTP request header.
- *
+ *
* <p>
* Used to specify directives that must be obeyed by all caching mechanisms along the request-response chain.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Cache-Control: no-cache
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Cache-Control general-header field is used to specify directives that MUST be obeyed by all caching mechanisms
* along the request/response chain.
* The directives specify behavior intended to prevent caches from adversely interfering with the request or response.
* These directives typically override the default caching algorithms.
* Cache directives are unidirectional in that the presence of a directive in a request does not imply that the same
* directive is to be given in the response.
- *
+ *
* <p>
* Note that HTTP/1.0 caches might not implement Cache-Control and might only implement Pragma: no-cache (see section
* 14.32).
- *
+ *
* <p>
* Cache directives MUST be passed through by a proxy or gateway application, regardless of their significance to that
* application, since the directives might be applicable to all recipients along the request/response chain.
* It is not possible to specify a cache- directive for a specific cache.
- *
+ *
* <p class='bcode'>
* Cache-Control = "Cache-Control" ":" 1#cache-directive
* cache-directive = cache-request-directive
@@ -67,13 +67,13 @@ package org.apache.juneau.http;
* | cache-extension ; Section 14.9.6
* cache-extension = token [ "=" ( token | quoted-string ) ]
* </p>
- *
+ *
* <p>
* When a directive appears without any 1#field-name parameter, the directive applies to the entire request or response.
* When such a directive appears with a 1#field-name parameter, it applies only to the named field or fields, and not
* to the rest of the request or response. This mechanism supports extensibility; implementations of future versions
* of the HTTP protocol might apply these directives to header fields not defined in HTTP/1.1.
- *
+ *
* <p>
* The cache-control directives can be broken down into these general categories:
* <ul>
@@ -86,7 +86,7 @@ package org.apache.juneau.http;
* <li>Control over transformation of entities.
* <li>Extensions to the caching system.
* </ul>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -100,7 +100,7 @@ public final class CacheControl extends HeaderString {
/**
* Returns a parsed <code>Cache-Control</code> header.
- *
+ *
* @param value The <code>Cache-Control</code> header string.
* @return The parsed <code>Cache-Control</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Connection.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Connection.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Connection.java
index c005c25..8ac955f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Connection.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Connection.java
@@ -14,38 +14,38 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Connection</l> HTTP request header.
- *
+ *
* <p>
* Control options for the current connection and list of hop-by-hop request fields.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Connection: keep-alive
* Connection: Upgrade
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Connection general-header field allows the sender to specify options that are desired for that particular
* connection and MUST NOT be communicated by proxies over further connections.
- *
+ *
* <p>
* The Connection header has the following grammar:
* <p class='bcode'>
* Connection = "Connection" ":" 1#(connection-token)
* connection-token = token
* </p>
- *
+ *
* <p>
* HTTP/1.1 proxies MUST parse the Connection header field before a message is forwarded and, for each connection-token
* in this field, remove any header field(s) from the message with the same name as the connection-token.
* Connection options are signaled by the presence of a connection-token in the Connection header field, not by any
* corresponding additional header field(s), since the additional header field may not be sent if there are no
* parameters associated with that connection option.
- *
+ *
* <p>
* Message headers listed in the Connection header MUST NOT include end-to-end headers, such as Cache-Control.
- *
+ *
* <p>
* HTTP/1.1 defines the "close" connection option for the sender to signal that the connection will be closed after
* completion of the response.
@@ -56,18 +56,18 @@ package org.apache.juneau.http;
* <p>
* ...in either the request or the response header fields indicates that the connection SHOULD NOT be considered
* `persistent' (section 8.1) after the current request/response is complete.
- *
+ *
* <p>
* HTTP/1.1 applications that do not support persistent connections MUST include the "close" connection option in
* every message.
- *
+ *
* <p>
* A system receiving an HTTP/1.0 (or lower-version) message that includes a Connection header MUST, for each
* connection-token in this field, remove and ignore any header field(s) from the message with the same name as the
* connection-token.
* This protects against mistaken forwarding of such header fields by pre-HTTP/1.1 proxies.
* See section 19.6.2.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -81,7 +81,7 @@ public final class Connection extends HeaderString {
/**
* Returns a parsed <code>Connection</code> header.
- *
+ *
* @param value The <code>Connection</code> header string.
* @return The parsed <code>Connection</code> header, or <jk>null</jk> if the string was null.
*/
@@ -98,7 +98,7 @@ public final class Connection extends HeaderString {
/**
* Returns <jk>true</jk> if the header value is <code>close</code>.
- *
+ *
* @return <jk>true</jk> if the header value is <code>close</code>.
*/
public boolean isClose() {
@@ -107,7 +107,7 @@ public final class Connection extends HeaderString {
/**
* Returns <jk>true</jk> if the header value is <code>keep-alive</code>.
- *
+ *
* @return <jk>true</jk> if the header value is <code>keep-alive</code>.
*/
public boolean isKeepAlive() {
@@ -116,7 +116,7 @@ public final class Connection extends HeaderString {
/**
* Returns <jk>true</jk> if the header value is <code>upgrade</code>.
- *
+ *
* @return <jk>true</jk> if the header value is <code>upgrade</code>.
*/
public boolean isUpgrade() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Constants.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Constants.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Constants.java
index 2547b48..c3ab5d7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Constants.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Constants.java
@@ -14,7 +14,7 @@ package org.apache.juneau.http;
/**
* Constants used by classes in this package.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncoding.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncoding.java
index 76f9552..ce0ee3c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncoding.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncoding.java
@@ -14,17 +14,17 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Encoding</l> HTTP response header.
- *
+ *
* <p>
* The type of encoding used on the data.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Encoding: gzip
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Encoding entity-header field is used as a modifier to the media-type.
* When present, its value indicates what additional content codings have been applied to the entity-body, and thus
* what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type header
@@ -34,32 +34,32 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Content-Encoding = "Content-Encoding" ":" 1#content-coding
* </p>
- *
+ *
* <p>
* Content codings are defined in section 3.5. An example of its use is...
* <p class='bcode'>
* Content-Encoding: gzip
* </p>
- *
+ *
* <p>
* The content-coding is a characteristic of the entity identified by the Request-URI.
* Typically, the entity-body is stored with this encoding and is only decoded before rendering or analogous usage.
* However, a non-transparent proxy MAY modify the content-coding if the new coding is known to be acceptable to the
* recipient, unless the "no-transform" cache-control directive is present in the message.
- *
+ *
* <p>
* If the content-coding of an entity is not "identity", then the response MUST include a Content-Encoding
* entity-header (section 14.11) that lists the non-identity content-coding(s) used.
- *
+ *
* <p>
* If the content-coding of an entity in a request message is not acceptable to the origin server, the server SHOULD
* respond with a status code of 415 (Unsupported Media Type).
- *
+ *
* <p>
* If multiple encodings have been applied to an entity, the content codings MUST be listed in the order in which they
* were applied.
* Additional information about the encoding parameters MAY be provided.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -73,7 +73,7 @@ public final class ContentEncoding extends HeaderEnum<ContentEncodingEnum> {
/**
* Returns a parsed <code>Content-Encoding</code> header.
- *
+ *
* @param value The <code>Content-Encoding</code> header string.
* @return The parsed <code>Content-Encoding</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
index 9e7e820..58b4517 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
@@ -14,7 +14,7 @@ package org.apache.juneau.http;
/**
* Represents the possible values for a <code>Content-Encoding</code> header.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLanguage.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLanguage.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLanguage.java
index 4e6cef5..294b3e3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLanguage.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLanguage.java
@@ -14,24 +14,24 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Language</l> HTTP response header.
- *
+ *
* <p>
* The natural language or languages of the intended audience for the enclosed content.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Language: da
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Language entity-header field describes the natural language(s) of the intended audience for the
* enclosed entity.
* Note that this might not be equivalent to all the languages used within the entity-body.
* <p class='bcode'>
* Content-Language = "Content-Language" ":" 1#language-tag
* </p>
- *
+ *
* <p>
* Language tags are defined in section 3.10.
* The primary purpose of Content-Language is to allow a user to identify and differentiate entities according to the
@@ -40,12 +40,12 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Content-Language: da
* </p>
- *
+ *
* <p>
* If no Content-Language is specified, the default is that the content is intended for all language audiences.
* This might mean that the sender does not consider it to be specific to any natural language, or that the sender
* does not know for which language it is intended.
- *
+ *
* <p>
* Multiple languages MAY be listed for content that is intended for multiple audiences.
* For example, a rendition of the "Treaty of Waitangi," presented simultaneously in the original Maori and English
@@ -53,17 +53,17 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Content-Language: mi, en
* </p>
- *
+ *
* <p>
* However, just because multiple languages are present within an entity does not mean that it is intended for
* multiple linguistic audiences.
* An example would be a beginner's language primer, such as "A First Lesson in Latin," which is clearly intended to
* be used by an English-literate audience.
* In this case, the Content-Language would properly only include "en".
- *
+ *
* <p>
* Content-Language MAY be applied to any media type -- it is not limited to textual documents.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -77,7 +77,7 @@ public final class ContentLanguage extends HeaderStringArray {
/**
* Returns a parsed <code>Content-Language</code> header.
- *
+ *
* @param value The <code>Content-Language</code> header string.
* @return The parsed <code>Content-Language</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLength.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLength.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLength.java
index a0f3777..9c93965 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLength.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLength.java
@@ -14,44 +14,44 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Length</l> HTTP request/response header.
- *
+ *
* <p>
* The length of the response body in octets (8-bit bytes).
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Length: 348
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Length entity-header field indicates the size of the entity-body, in decimal number of OCTETs, sent to
* the recipient or, in the case of the HEAD method, the size of the entity-body that would have been sent had the
* request been a GET.
* <p class='bcode'>
* Content-Length = "Content-Length" ":" 1*DIGIT
* </p>
- *
+ *
* <p>
* An example is...
* <p class='bcode'>
* Content-Length: 3495
* </p>
- *
+ *
* <p>
* Applications SHOULD use this field to indicate the transfer-length of the message-body, unless this is prohibited by
* the rules in section 4.4.
- *
+ *
* <p>
* Any Content-Length greater than or equal to zero is a valid value.
* Section 4.4 describes how to determine the length of a message-body if a Content-Length is not given.
- *
+ *
* <p>
* Note that the meaning of this field is significantly different from the corresponding definition in MIME, where it is
* an optional field used within the "message/external-body" content-type.
* In HTTP, it SHOULD be sent whenever the message's length can be determined prior to being transferred, unless this is
* prohibited by the rules in section 4.4.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -65,7 +65,7 @@ public final class ContentLength extends HeaderInteger {
/**
* Returns a parsed <code>Content-Length</code> header.
- *
+ *
* @param value The <code>Content-Length</code> header string.
* @return The parsed <code>Content-Length</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLocation.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLocation.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLocation.java
index f222af0..69b81f8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLocation.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLocation.java
@@ -14,17 +14,17 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Location</l> HTTP response header.
- *
+ *
* <p>
* An alternate location for the returned data.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Location: /index.htm
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Location entity-header field MAY be used to supply the resource location for the entity enclosed in the
* message when that entity is accessible from a location separate from the requested resource's URI.
* A server SHOULD provide a Content-Location for the variant corresponding to the response entity; especially in the
@@ -35,29 +35,29 @@ package org.apache.juneau.http;
* Content-Location = "Content-Location" ":"
* ( absoluteURI | relativeURI )
* </p>
- *
+ *
* <p>
* The value of Content-Location also defines the base URI for the entity.
- *
+ *
* <p>
* The Content-Location value is not a replacement for the original requested URI; it is only a statement of the
* location of the resource corresponding to this particular entity at the time of the request.
* Future requests MAY specify the Content-Location URI as the request- URI if the desire is to identify the source of
* that particular entity.
- *
+ *
* <p>
* A cache cannot assume that an entity with a Content-Location different from the URI used to retrieve it can be used
* to respond to later requests on that Content-Location URI.
* However, the Content- Location can be used to differentiate between multiple entities retrieved from a single
* requested resource, as described in section 13.6.
- *
+ *
* <p>
* If the Content-Location is a relative URI, the relative URI is interpreted relative to the Request-URI.
- *
+ *
* <p>
* The meaning of the Content-Location header in PUT or POST requests is undefined; servers are free to ignore it in
* those cases.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -71,7 +71,7 @@ public final class ContentLocation extends HeaderUri {
/**
* Returns a parsed <code>Content-Location</code> header.
- *
+ *
* @param value The <code>Content-Location</code> header string.
* @return The parsed <code>Content-Location</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentRange.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentRange.java
index dc7ef18..b688c87 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentRange.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentRange.java
@@ -14,17 +14,17 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Range</l> HTTP response header.
- *
+ *
* <p>
* Where in a full body message this partial message belongs.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Range: bytes 21010-47021/47022
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Range entity-header is sent with a partial entity-body to specify where in the full entity-body the
* partial body should be applied.
* Range units are defined in section 3.12.
@@ -38,28 +38,28 @@ package org.apache.juneau.http;
* | "*"
* instance-length = 1*DIGIT
* </p>
- *
+ *
* <p>
* The header SHOULD indicate the total length of the full entity-body, unless this length is unknown or difficult to
* determine.
* The asterisk "*" character means that the instance-length is unknown at the time when the response was generated.
- *
+ *
* <p>
* Unlike byte-ranges-specifier values (see section 14.35.1), a byte- range-resp-spec MUST only specify one range, and
* MUST contain absolute byte positions for both the first and last byte of the range.
- *
+ *
* <p>
* A byte-content-range-spec with a byte-range-resp-spec whose last- byte-pos value is less than its first-byte-pos
* value, or whose instance-length value is less than or equal to its last-byte-pos value, is invalid.
* The recipient of an invalid byte-content-range- spec MUST ignore it and any content transferred along with it.
- *
+ *
* <p>
* A server sending a response with status code 416 (Requested range not satisfiable) SHOULD include a Content-Range
* field with a byte-range- resp-spec of "*".
* The instance-length specifies the current length of the selected resource.
* A response with status code 206 (Partial Content) MUST NOT include a Content-Range field with a byte-range-resp-spec
* of "*".
- *
+ *
* <p>
* Examples of byte-content-range-spec values, assuming that the entity contains a total of 1234 bytes:
* <p class='bcode'>
@@ -72,7 +72,7 @@ package org.apache.juneau.http;
* The last 500 bytes:
* bytes 734-1233/1234
* </p>
- *
+ *
* <p>
* When an HTTP message includes the content of a single range (for example, a response to a request for a single range,
* or to a request for a set of ranges that overlap without any holes), this content is transmitted with a Content-Range
@@ -86,40 +86,40 @@ package org.apache.juneau.http;
* Content-Length: 26012
* Content-Type: image/gif
* </p>
- *
+ *
* <p>
* When an HTTP message includes the content of multiple ranges (for example, a response to a request for multiple
* non-overlapping ranges), these are transmitted as a multipart message.
* The multipart media type used for this purpose is "multipart/byteranges" as defined in appendix 19.2.
* See appendix 19.6.3 for a compatibility issue.
- *
+ *
* <p>
* A response to a request for a single range MUST NOT be sent using the multipart/byteranges media type.
* A response to a request for multiple ranges, whose result is a single range, MAY be sent as a multipart/byteranges
* media type with one part.
* A client that cannot decode a multipart/byteranges message MUST NOT ask for multiple byte-ranges in a single request.
- *
+ *
* <p>
* When a client requests multiple byte-ranges in one request, the server SHOULD return them in the order that they
* appeared in the request.
- *
+ *
* <p>
* If the server ignores a byte-range-spec because it is syntactically invalid, the server SHOULD treat the request as
* if the invalid Range header field did not exist.
* (Normally, this means return a 200 response containing the full entity).
- *
+ *
* <p>
* If the server receives a request (other than one including an If- Range request-header field) with an unsatisfiable
* Range request- header field
* (that is, all of whose byte-range-spec values have a first-byte-pos value greater than the current length of the
* selected resource),
* it SHOULD return a response code of 416 (Requested range not satisfiable) (section 10.4.17).
- *
+ *
* <p>
* Note: clients cannot depend on servers to send a 416 (Requested range not satisfiable) response instead of a 200 (OK)
* response for
* an unsatisfiable Range request-header, since not all servers implement this request-header.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -133,7 +133,7 @@ public final class ContentRange extends HeaderString {
/**
* Returns a parsed <code>Content-Range</code> header.
- *
+ *
* @param value The <code>Content-Range</code> header string.
* @return The parsed <code>Content-Range</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentType.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentType.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentType.java
index 062a199..3a5bb79 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentType.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentType.java
@@ -18,30 +18,30 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Content-Type</l> HTTP request/response header.
- *
+ *
* <p>
* The MIME type of this content.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Type: text/html; charset=utf-8
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Type entity-header field indicates the media type of the entity-body sent to the recipient or, in the
* case of the HEAD method, the media type that would have been sent had the request been a GET.
* <p class='bcode'>
* Content-Type = "Content-Type" ":" media-type
* </p>
- *
+ *
* <p>
* Media types are defined in section 3.7.
* An example of the field is...
* <p class='bcode'>
* Content-Type: text/html; charset=ISO-8859-4
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -57,7 +57,7 @@ public class ContentType extends MediaType {
/**
* Returns a parsed <code>Content-Type</code> header.
- *
+ *
* @param value The <code>Content-Type</code> header string.
* @return The parsed <code>Content-Type</code> header, or <jk>null</jk> if the string was null.
*/
@@ -77,7 +77,7 @@ public class ContentType extends MediaType {
/**
* Given a list of media types, returns the best match for this <code>Content-Type</code> header.
- *
+ *
* <p>
* Note that fuzzy matching is allowed on the media types where the <code>Content-Types</code> header may
* contain additional subtype parts.
@@ -86,7 +86,7 @@ public class ContentType extends MediaType {
* isn't found.
* <br>The purpose for this is to allow parsers to match when artifacts such as <code>id</code> properties are
* present in the header.
- *
+ *
* @param mediaTypes The media types to match against.
* @return The index into the array of the best match, or <code>-1</code> if no suitable matches could be found.
*/