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/13 22:12:03 UTC
[4/4] juneau git commit: Update javadocs.
Update javadocs.
Project: http://git-wip-us.apache.org/repos/asf/juneau/repo
Commit: http://git-wip-us.apache.org/repos/asf/juneau/commit/0ab0b231
Tree: http://git-wip-us.apache.org/repos/asf/juneau/tree/0ab0b231
Diff: http://git-wip-us.apache.org/repos/asf/juneau/diff/0ab0b231
Branch: refs/heads/master
Commit: 0ab0b23102b9b0fb56d3d7c14e262f7eb5c1d74d
Parents: 56e22ce
Author: JamesBognar <ja...@apache.org>
Authored: Sat Jan 13 17:11:12 2018 -0500
Committer: JamesBognar <ja...@apache.org>
Committed: Sat Jan 13 17:11:12 2018 -0500
----------------------------------------------------------------------
.../java/org/apache/juneau/ini/ConfigFile.java | 2 +-
.../juneau/a/rttests/RoundTripBeanMapsTest.java | 2 +-
.../apache/juneau/dto/jsonschema/Sample.java | 1 +
.../java/org/apache/juneau/jena/RdfCommon.java | 120 ++---
.../java/org/apache/juneau/jena/RdfParser.java | 4 +-
.../org/apache/juneau/jena/RdfSerializer.java | 18 +-
.../java/org/apache/juneau/BeanContext.java | 357 +++++++------
.../org/apache/juneau/BeanContextBuilder.java | 139 ++++-
.../java/org/apache/juneau/BeanSession.java | 4 +-
.../java/org/apache/juneau/BeanSessionArgs.java | 66 ++-
.../java/org/apache/juneau/SessionArgs.java | 26 +-
.../apache/juneau/annotation/BeanProperty.java | 2 +-
.../java/org/apache/juneau/annotation/Swap.java | 16 +-
.../apache/juneau/html/HtmlDocSerializer.java | 48 +-
.../juneau/html/HtmlDocSerializerSession.java | 4 +-
.../org/apache/juneau/html/HtmlSerializer.java | 20 +-
.../apache/juneau/internal/JuneauLogger.java | 2 +-
.../org/apache/juneau/json/JsonSerializer.java | 12 +-
.../juneau/msgpack/MsgPackSerializer.java | 4 +-
.../main/java/org/apache/juneau/package.html | 177 -------
.../java/org/apache/juneau/parser/Parser.java | 169 +++++--
.../org/apache/juneau/parser/ParserBuilder.java | 41 ++
.../org/apache/juneau/parser/ParserSession.java | 20 +
.../apache/juneau/parser/ParserSessionArgs.java | 71 ++-
.../apache/juneau/serializer/Serializer.java | 507 ++++++++++++++++---
.../juneau/serializer/SerializerBuilder.java | 82 +++
.../juneau/serializer/SerializerSession.java | 27 +-
.../serializer/SerializerSessionArgs.java | 73 ++-
.../apache/juneau/soap/SoapXmlSerializer.java | 2 +-
.../transform/AnnotationBeanFilterBuilder.java | 2 +-
.../juneau/transform/BeanFilterBuilder.java | 16 +-
.../transform/InterfaceBeanFilterBuilder.java | 2 +-
.../org/apache/juneau/transform/PojoSwap.java | 28 +-
.../apache/juneau/transform/PropertyFilter.java | 46 +-
.../java/org/apache/juneau/uon/UonParser.java | 4 +-
.../org/apache/juneau/uon/UonSerializer.java | 12 +-
.../juneau/urlencoding/UrlEncodingParser.java | 4 +-
.../urlencoding/UrlEncodingSerializer.java | 4 +-
.../org/apache/juneau/utils/MessageBundle.java | 4 +-
.../java/org/apache/juneau/xml/XmlParser.java | 22 +-
.../org/apache/juneau/xml/XmlSerializer.java | 28 +-
.../juneau/yaml/proto/YamlSerializer.java | 12 +-
juneau-doc/src/main/javadoc/overview.html | 301 +++++++----
.../org/apache/juneau/rest/client/RestCall.java | 12 +-
.../apache/juneau/rest/client/RestClient.java | 60 +--
.../org/apache/juneau/rest/ReaderResource.java | 4 +-
.../org/apache/juneau/rest/RestContext.java | 204 ++++----
.../org/apache/juneau/rest/StreamResource.java | 6 +-
.../juneau/rest/annotation/RestMethod.java | 14 +-
.../juneau/rest/annotation/RestResource.java | 2 +-
50 files changed, 1860 insertions(+), 943 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/juneau/blob/0ab0b231/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFile.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFile.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFile.java
index 914f106..69aec1e 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFile.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFile.java
@@ -344,7 +344,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param type
* The object type to create.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
+ * {@link GenericArrayType}
* @param args
* The type arguments of the class if it's a collection or map.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
http://git-wip-us.apache.org/repos/asf/juneau/blob/0ab0b231/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/a/rttests/RoundTripBeanMapsTest.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/a/rttests/RoundTripBeanMapsTest.java b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/a/rttests/RoundTripBeanMapsTest.java
index 20d6091..982ec2c 100755
--- a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/a/rttests/RoundTripBeanMapsTest.java
+++ b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/a/rttests/RoundTripBeanMapsTest.java
@@ -520,7 +520,7 @@ public class RoundTripBeanMapsTest extends RoundTripTest {
}
public static class D2Filter extends BeanFilterBuilder<D2> {
public D2Filter() {
- includeProperties("f3,f2");
+ properties("f3,f2");
}
}
http://git-wip-us.apache.org/repos/asf/juneau/blob/0ab0b231/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/Sample.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/Sample.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/Sample.java
index 728cf18..1d6c176 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/Sample.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/Sample.java
@@ -48,6 +48,7 @@ class Sample {
};
// Get schema from the schema map.
+ @SuppressWarnings("unlikely-arg-type")
Schema purchaseOrderSchema = schemaMap.get("http://www.apache.org/purchase-order/PurchaseOrder#");
JsonType streetType = purchaseOrderSchema
http://git-wip-us.apache.org/repos/asf/juneau/blob/0ab0b231/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfCommon.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfCommon.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfCommon.java
index f5b312b..c962179 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfCommon.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfCommon.java
@@ -45,7 +45,7 @@ public interface RdfCommon {
/**
* Configuration property: RDF language.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.language.s"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -66,7 +66,7 @@ public interface RdfCommon {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Can be any of the following:
* <ul class='spaced-list'>
@@ -102,7 +102,7 @@ public interface RdfCommon {
/**
* Configuration property: XML namespace for Juneau properties.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.juneauNs.s"</js>
* <li><b>Data type:</b> {@link Namespace}
@@ -119,7 +119,7 @@ public interface RdfCommon {
/**
* Configuration property: Default XML namespace for bean properties.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.juneauBpNs.s"</js>
* <li><b>Data type:</b> {@link Namespace}
@@ -136,7 +136,7 @@ public interface RdfCommon {
/**
* Configuration property: Reuse XML namespaces when RDF namespaces not specified.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.useXmlNamespaces.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -148,7 +148,7 @@ public interface RdfCommon {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* When specified, namespaces defined using {@link XmlNs @XmlNs} and {@link Xml @Xml} will be inherited by the RDF serializers.
* Otherwise, namespaces will be defined using {@link RdfNs @RdfNs} and {@link Rdf @Rdf}.
@@ -158,14 +158,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML property: <code>iri_rules</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.iri-rules.s"</js>
* <li><b>Data type:</b> <code>String</code>
* <li><b>Default:</b> <js>"lax"</js>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Set the engine for checking and resolving.
*
@@ -189,14 +189,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML ARP property: <code>error-mode</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.error-mode.s"</js>
* <li><b>Data type:</b> <code>String</code>
* <li><b>Default:</b> <js>"lax"</js>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* This allows a coarse-grained approach to control of error handling.
*
@@ -230,14 +230,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML ARP property: <code>embedding</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.embedding.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
* <li><b>Default:</b> <jk>false</jk>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Sets ARP to look for RDF embedded within an enclosing XML document.
*
@@ -253,13 +253,13 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML ARP property: <code>ERR_xxx</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.ERR_"</js>
* <li><b>Data type:</b> <code>String</code>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Provides fine-grained control over detected error conditions.
*
@@ -286,13 +286,13 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML ARP property: <code>WARN_xxx</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.WARN_"</js>
* <li><b>Data type:</b> <code>String</code>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* See {@link #RDF_arp_err_} for details.
*/
@@ -301,13 +301,13 @@ public interface RdfCommon {
/**
* RDF/XML ARP property: <code>IGN_xxx</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.IGN_"</js>
* <li><b>Data type:</b> <code>String</code>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* See {@link #RDF_arp_err_} for details.
*/
@@ -316,14 +316,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML property: <code>xmlbase</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.xmlbase.s"</js>
* <li><b>Data type:</b> <code>String</code>
* <li><b>Default:</b> <jk>null</jk>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* The value to be included for an <xa>xml:base</xa> attribute on the root element in the file.
*/
@@ -332,14 +332,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML property: <code>longId</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.longId.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
* <li><b>Default:</b> <jk>false</jk>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Whether to use long ID's for anon resources.
* Short ID's are easier to read, but can run out of memory on very large models.
@@ -349,14 +349,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML property: <code>allowBadURIs</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.allowBadURIs.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
* <li><b>Default:</b> <jk>false</jk>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* URIs in the graph are, by default, checked prior to serialization.
*/
@@ -365,14 +365,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML property: <code>relativeURIs</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.relativeURIs.s"</js>
* <li><b>Data type:</b> <code>String</code>
* <li><b>Default:</b> <js>"same-document, absolute, relative, parent"</js>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* What sort of relative URIs should be used.
*
@@ -403,14 +403,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML property: <code>showXmlDeclaration</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.showXmlDeclaration.s"</js>
* <li><b>Data type:</b> <code>String</code>
* <li><b>Default:</b> <js>"default"</js>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Possible values:
* <ul class='spaced-list'>
@@ -429,14 +429,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML property: <code>showDoctypeDeclaration</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.showDoctypeDeclaration.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
* <li><b>Default:</b> <jk>true</jk>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If true, an XML doctype declaration is included in the output.
* This declaration includes a <code>!ENTITY</code> declaration for each prefix mapping in the model, and any
@@ -448,14 +448,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML property: <code>tab</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.tab.i"</js>
* <li><b>Data type:</b> <code>Integer</code>
* <li><b>Default:</b> <code>2</code>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* The number of spaces with which to indent XML child elements.
*/
@@ -464,14 +464,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML property: <code>attributeQuoteChar</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.attributeQuoteChar.s"</js>
* <li><b>Data type:</b> <code>Character</code>
* <li><b>Default:</b> <js>'"'</js>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* The XML attribute quote character.
*/
@@ -480,14 +480,14 @@ public interface RdfCommon {
/**
* Configuration property: RDF/XML property: <code>blockRules</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.rdfXml.blockRules.s"</js>
* <li><b>Data type:</b> <code>String</code>
* <li><b>Default:</b> <js>""</js>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* A list of <code>Resource</code> or a <code>String</code> being a comma separated list of fragment IDs from
* <a class="doclink" href="http://www.w3.org/TR/rdf-syntax-grammar">RDF Syntax Grammar</a> indicating grammar
@@ -498,14 +498,14 @@ public interface RdfCommon {
/**
* Configuration property: N3/Turtle property: <code>minGap</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.n3.minGap.i"</js>
* <li><b>Data type:</b> <code>Integer</code>
* <li><b>Default:</b> <code>1</code>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Minimum gap between items on a line.
*/
@@ -514,14 +514,14 @@ public interface RdfCommon {
/**
* Configuration property: N3/Turtle property: <code>objectLists</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.n3.objectLists.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
* <li><b>Default:</b> <jk>true</jk>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Print object lists as comma separated lists.
*/
@@ -530,14 +530,14 @@ public interface RdfCommon {
/**
* Configuration property: N3/Turtle property: <code>subjectColumn</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.n3.subjectColumn.i"</js>
* <li><b>Data type:</b> <code>Integer</code>
* <li><b>Default:</b> indentProperty
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If the subject is shorter than this value, the first property may go on the same line.
*/
@@ -546,14 +546,14 @@ public interface RdfCommon {
/**
* Configuration property: N3/Turtle property: <code>propertyColumn</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.n3.propertyColumn.i"</js>
* <li><b>Data type:</b> <code>Integer</code>
* <li><b>Default:</b> <code>8</code>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Width of the property column.
*/
@@ -562,14 +562,14 @@ public interface RdfCommon {
/**
* Configuration property: N3/Turtle property: <code>indentProperty</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.n3.indentProperty.i"</js>
* <li><b>Data type:</b> <code>Integer</code>
* <li><b>Default:</b> <code>6</code>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Width to indent properties.
*/
@@ -578,14 +578,14 @@ public interface RdfCommon {
/**
* Configuration property: N3/Turtle property: <code>widePropertyLen</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.n3.widePropertyLen.i"</js>
* <li><b>Data type:</b> <code>Integer</code>
* <li><b>Default:</b> <code>20</code>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Width of the property column.
* Must be longer than <code>propertyColumn</code>.
@@ -595,14 +595,14 @@ public interface RdfCommon {
/**
* Configuration property: N3/Turtle property: <code>abbrevBaseURI</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.n3.abbrevBaseURI.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
* <li><b>Default:</b> <jk>true</jk>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Control whether to use abbreviations <code><></code> or <code><#></code>.
*/
@@ -611,14 +611,14 @@ public interface RdfCommon {
/**
* Configuration property: N3/Turtle property: <code>usePropertySymbols</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.n3.usePropertySymbols.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
* <li><b>Default:</b> <jk>true</jk>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Control whether to use <code>a</code>, <code>=</code> and <code>=></code> in output
*/
@@ -627,14 +627,14 @@ public interface RdfCommon {
/**
* Configuration property: N3/Turtle property: <code>useTripleQuotedStrings</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.n3.useTripleQuotedStrings.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
* <li><b>Default:</b> <jk>true</jk>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Allow the use of <code>"""</code> to delimit long strings.
*/
@@ -643,14 +643,14 @@ public interface RdfCommon {
/**
* Configuration property: N3/Turtle property: <code>useDoubles</code>.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.jena.n3.useDoubles.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
* <li><b>Default:</b> <jk>true</jk>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Allow the use doubles as <code>123.456</code>.
*/
@@ -659,7 +659,7 @@ public interface RdfCommon {
/**
* Configuration property: RDF format for representing collections and arrays.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.collectionFormat.s"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -671,7 +671,7 @@ public interface RdfCommon {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Possible values:
* <ul class='spaced-list'>
@@ -698,7 +698,7 @@ public interface RdfCommon {
/**
* Configuration property: Collections should be serialized and parsed as loose collections.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Rdf.looseCollections.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -712,7 +712,7 @@ public interface RdfCommon {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* When specified, collections of resources are handled as loose collections of resources in RDF instead of
* resources that are children of an RDF collection (e.g. Sequence, Bag).
http://git-wip-us.apache.org/repos/asf/juneau/blob/0ab0b231/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
index 2fa67eb..8680794 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
@@ -56,7 +56,7 @@ public class RdfParser extends ReaderParser implements RdfCommon {
/**
* Configuration property: Trim whitespace from text elements.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RdfParser.trimWhitespace.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -69,7 +69,7 @@ public class RdfParser extends ReaderParser implements RdfCommon {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, whitespace in text elements will be automatically trimmed.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/0ab0b231/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializer.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializer.java
index db02826..9b8c3e2 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializer.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializer.java
@@ -54,7 +54,7 @@ public class RdfSerializer extends WriterSerializer implements RdfCommon {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RdfSerializer.addBeanTypeProperties.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -66,7 +66,7 @@ public class RdfSerializer extends WriterSerializer implements RdfCommon {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <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.
@@ -83,7 +83,7 @@ public class RdfSerializer extends WriterSerializer implements RdfCommon {
/**
* Configuration property: Add XSI data types to non-<code>String</code> literals.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RdfSerializer.addLiteralTypes.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -101,7 +101,7 @@ public class RdfSerializer extends WriterSerializer implements RdfCommon {
/**
* Configuration property: Add RDF root identifier property to root node.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RdfSerializer.addRootProperty.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -114,7 +114,7 @@ public class RdfSerializer extends WriterSerializer implements RdfCommon {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* When enabled an RDF property <code>http://www.apache.org/juneau/root</code> is added with a value of <js>"true"</js>
* to identify the root node in the graph.
@@ -129,7 +129,7 @@ public class RdfSerializer extends WriterSerializer implements RdfCommon {
/**
* Configuration property: Auto-detect namespace usage.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RdfSerializer.autoDetectNamespaces.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -141,7 +141,7 @@ public class RdfSerializer extends WriterSerializer implements RdfCommon {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Detect namespace usage before serialization.
*
@@ -154,7 +154,7 @@ public class RdfSerializer extends WriterSerializer implements RdfCommon {
/**
* Configuration property: Default namespaces.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RdfSerializer.namespaces.ls"</js>
* <li><b>Data type:</b> <code>List<String></code> (serialized {@link Namespace} objects)
@@ -170,7 +170,7 @@ public class RdfSerializer extends WriterSerializer implements RdfCommon {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* The default list of namespaces associated with this serializer.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/0ab0b231/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
index 230be65..ae50c93 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
@@ -151,7 +151,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Minimum bean class visibility.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanClassVisibility.s"</js>
* <li><b>Data type:</b> <code>String</code> ({@link Visibility})
@@ -163,7 +163,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Classes are not considered beans unless they meet the minimum visibility requirements.
*
@@ -172,8 +172,8 @@ public class BeanContext extends Context {
* will not be interpreted as a bean class and be serialized as a string.
* <br>Use this setting to reduce the visibility requirement.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that serializes protected classes.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -185,14 +185,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_beanClassVisibility</jsf>, <js>"PROTECTED"</js>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_beanClassVisibility = PREFIX + "beanClassVisibility.s";
/**
* Configuration property: Minimum bean constructor visibility.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanConstructorVisibility.s"</js>
* <li><b>Data type:</b> <code>String</code> ({@link Visibility})
@@ -204,7 +204,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Only look for constructors with the specified minimum visibility.
*
@@ -213,8 +213,8 @@ public class BeanContext extends Context {
* <br>Normally, only <jk>public</jk> no-arg constructors are used.
* <br>Use this setting if you want to reduce the visibility requirement.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that looks for protected no-arg constructors.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -226,14 +226,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_beanConstructorVisibility</jsf>, <js>"PROTECTED"</js>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_beanConstructorVisibility = PREFIX + "beanConstructorVisibility.s";
/**
* Configuration property: Bean dictionary.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanDictionary.lc"</js>
* <li><b>Data type:</b> <code>List<Class></code>
@@ -254,7 +254,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* The list of classes that make up the bean dictionary in this bean context.
*
@@ -270,15 +270,15 @@ public class BeanContext extends Context {
*
* <p>
* Values can consist of any of the following types:
- * <ul>
+ * <ul>
* <li>Any bean class that specifies a value for {@link Bean#typeName() @Bean.typeName()}.
* <li>Any subclass of {@link BeanDictionaryList} containing a collection of bean classes with type name annotations.
* <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name annotations.
* <li>Any array or collection of the objects above.
* </ul>
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a parser and tell it which classes to try to resolve.</jc>
* ReaderParser p = JsonParser
* .<jsm>create</jsm>()
@@ -304,10 +304,10 @@ public class BeanContext extends Context {
* .build();
* </p>
*
- * <h5 class='section'>Documentation:</h5>
- * <ul>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.BeanDictionaries">Overview > Bean Names and Dictionaries</a>
- * </ul>
+ * <h5 class='section'>Documentation:</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.BeanDictionaries">Overview > Bean Names and Dictionaries</a>
+ * </ul>
*/
public static final String BEAN_beanDictionary = PREFIX + "beanDictionary.lc";
@@ -324,7 +324,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Minimum bean field visibility.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFieldVisibility.s"</js>
* <li><b>Data type:</b> <code>String</code> ({@link Visibility})
@@ -336,7 +336,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Only look for bean fields with the specified minimum visibility.
*
@@ -345,8 +345,8 @@ public class BeanContext extends Context {
* <br>Normally only <jk>public</jk> fields are considered.
* <br>Use this setting if you want to reduce the visibility requirement.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that looks for protected fields.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -364,14 +364,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .beanFieldVisibility(<jsf>NONE</jsf>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_beanFieldVisibility = PREFIX + "beanFieldVisibility.s";
/**
* Configuration property: Bean filters.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFilters.lc"</js>
* <li><b>Data type:</b> <code>List<Class></code>
@@ -386,7 +386,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* This is a programmatic equivalent to the {@link Bean @Bean} annotation.
* <br>It's useful when you want to use the <code>@Bean</code> annotation functionality, but you don't have the ability to alter
@@ -404,7 +404,7 @@ public class BeanContext extends Context {
* <li>Any array or collection of the objects above.
* </ul>
*
- * <h5 class='section'>Example:</h5>
+ * <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a bean filter for the MyBean class.</jc>
* <jk>public class</jk> MyBeanFilter <jk>extends</jk> BeanFilterBuilder<MyBean> {
@@ -428,11 +428,11 @@ public class BeanContext extends Context {
* .build();
* </p>
*
- * <h5 class='section'>Documentation:</h5>
- * <ul>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.BeanFilters">Overview > BeanFilters</a>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.StopClasses">Overview > Stop Classes</a>
- * </ul>
+ * <h5 class='section'>Documentation:</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.BeanFilters">Overview > BeanFilters</a>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.InterfaceFilters">Overview > Interface Filters</a>
+ * </ul>
*/
public static final String BEAN_beanFilters = PREFIX + "beanFilters.lc";
@@ -449,7 +449,7 @@ public class BeanContext extends Context {
/**
* Configuration property: BeanMap.put() returns old property value.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMapPutReturnsOldValue.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -462,7 +462,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
*
* <p>
* If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
@@ -470,10 +470,10 @@ public class BeanContext extends Context {
* <br>Otherwise, it returns <jk>null</jk>.
*
* <p>
- * Disabled by default because it introduces a slight performance penalty during serilalization.
+ * Disabled by default because it introduces a slight performance penalty during serialization.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that creates BeanMaps with normal put() behavior.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -489,14 +489,14 @@ public class BeanContext extends Context {
* BeanMap<MyBean> bm = s.createSession().toBeanMap(<jk>new</jk> MyBean());
* bm.put(<js>"foo"</js>, <js>"bar"</js>);
* Object oldValue = bm.put(<js>"foo"</js>, <js>"baz"</js>); <jc>// oldValue == "bar"</jc>
- * </p>
+ * </p>
*/
public static final String BEAN_beanMapPutReturnsOldValue = PREFIX + "beanMapPutReturnsOldValue.b";
/**
* Configuration property: Minimum bean method visibility.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMethodVisibility.s"</js>
* <li><b>Data type:</b> <code>String</code> ({@link Visibility})
@@ -508,7 +508,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Only look for bean methods with the specified minimum visibility.
*
@@ -517,8 +517,8 @@ public class BeanContext extends Context {
* <br>Normally only <jk>public</jk> getters and setters are considered.
* <br>Use this setting if you want to reduce the visibility requirement.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that looks for protected getters and setters.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -530,14 +530,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_beanMethodVisibility</jsf>, <js>"PROTECTED"</js>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_beanMethodVisibility = PREFIX + "beanMethodVisibility.s";
/**
* Configuration property: Beans require no-arg constructors.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireDefaultConstructor.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -550,7 +550,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, a Java class must implement a default no-arg constructor to be considered a bean.
* <br>Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.
@@ -558,8 +558,8 @@ public class BeanContext extends Context {
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that ignores beans without default constructors.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -571,14 +571,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_beansRequireDefaultConstructor</jsf>, <jk>true</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_beansRequireDefaultConstructor = PREFIX + "beansRequireDefaultConstructor.b";
/**
* Configuration property: Beans require Serializable interface.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSerializable.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -591,7 +591,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, a Java class must implement the {@link Serializable} interface to be considered a bean.
* <br>Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.
@@ -599,8 +599,8 @@ public class BeanContext extends Context {
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that ignores beans not implementing Serializable.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -612,14 +612,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_beansRequireSerializable</jsf>, <jk>true</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_beansRequireSerializable = PREFIX + "beansRequireSerializable.b";
/**
* Configuration property: Beans require setters for getters.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSettersForGetters.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -632,13 +632,13 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean.
* <br>Otherwise, they will be ignored.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that ignores bean properties without setters.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -650,14 +650,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_beansRequireSettersForGetters</jsf>, <jk>true</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_beansRequireSettersForGetters = PREFIX + "beansRequireSettersForGetters.b";
/**
* Configuration property: Beans require at least one property.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSomeProperties.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -669,7 +669,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then a Java class must contain at least 1 property to be considered a bean.
* <br>Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.
@@ -677,8 +677,8 @@ public class BeanContext extends Context {
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that serializes beans even if they have zero properties.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -690,14 +690,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_beansRequireSomeProperties</jsf>, <jk>false</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_beansRequireSomeProperties = PREFIX + "beansRequireSomeProperties.b";
/**
* Configuration property: Bean type property name.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanTypePropertyName.s"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -717,8 +717,8 @@ public class BeanContext extends Context {
* This specifies the name of the bean property used to store the dictionary name of a bean type so that the
* parser knows the data type to reconstruct.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that uses 'type' instead of '_type' for dictionary names.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -730,19 +730,19 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_beanTypePropertyName</jsf>, <js>"type"</js>)
* .build();
- * </p>
+ * </p>
*
- * <h5 class='section'>Documentation:</h5>
- * <ul>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.BeanDictionaries">Overview > Bean Names and Dictionaries</a>
- * </ul>
+ * <h5 class='section'>Documentation:</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.BeanDictionaries">Overview > Bean Names and Dictionaries</a>
+ * </ul>
*/
public static final String BEAN_beanTypePropertyName = PREFIX + "beanTypePropertyName.s";
/**
* Configuration property: Debug mode.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.debug.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -755,7 +755,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Enables the following additional information during serialization:
* <ul class='spaced-list'>
@@ -774,8 +774,8 @@ public class BeanContext extends Context {
* in order to determine how that method was invoked.
* </ul>
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer with debug enabled.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -787,14 +787,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_debug</jsf>, <jk>true</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_debug = PREFIX + "debug.b";
/**
* Configuration property: Bean property excludes.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.excludeProperties.sms"</js>
* <li><b>Data type:</b> <code>Map<String,String></code>
@@ -813,7 +813,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Specifies to exclude the specified list of properties for the specified bean class.
*
@@ -829,8 +829,8 @@ public class BeanContext extends Context {
* <p>
* Setting applies to specified class and all subclasses.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that excludes the 'foo' and 'bar' properties on the MyBean class.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -848,14 +848,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .addTo(<jsf>BEAN_excludeProperties</jsf>, <js>"{'org.apache.MyBean':'foo,bar'}"</js>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_excludeProperties = PREFIX + "excludeProperties.sms";
/**
* Configuration property: Ignore invocation errors on getters.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnGetters.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -868,13 +868,13 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.
* <br>Otherwise, a {@code BeanRuntimeException} is thrown.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that ignores bean getter exceptions.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -886,14 +886,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_ignoreInvocationExceptionsOnGetters</jsf>, <jk>true</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_ignoreInvocationExceptionsOnGetters = PREFIX + "ignoreInvocationExceptionsOnGetters.b";
/**
* Configuration property: Ignore invocation errors on setters.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnSetters.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -906,13 +906,13 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.
* <br>Otherwise, a {@code BeanRuntimeException} is thrown.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a parser that ignores bean setter exceptions.</jc>
* ReaderParser p = JsonParser
* .<jsm>create</jsm>()
@@ -924,14 +924,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_ignoreInvocationExceptionsOnSetters</jsf>, <jk>true</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_ignoreInvocationExceptionsOnSetters = PREFIX + "ignoreInvocationExceptionsOnSetters.b";
/**
* Configuration property: Ignore properties without setters.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignorePropertiesWithoutSetters.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -943,13 +943,13 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, trying to set a value on a bean property without a setter will silently be ignored.
* <br>Otherwise, a {@code RuntimeException} is thrown.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a parser that throws an exception if a setter is not found but a getter is.</jc>
* ReaderParser p = JsonParser
* .<jsm>create</jsm>()
@@ -961,14 +961,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_ignorePropertiesWithoutSetters</jsf>, <jk>false</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_ignorePropertiesWithoutSetters = PREFIX + "ignorePropertiesWithoutSetters.b";
/**
* Configuration property: Ignore unknown properties.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownBeanProperties.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -981,13 +981,13 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored.
* <br>Otherwise, a {@code RuntimeException} is thrown.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a parser that ignores missing bean properties.</jc>
* ReaderParser p = JsonParser
* .<jsm>create</jsm>()
@@ -999,14 +999,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_ignoreUnknownBeanProperties</jsf>, <jk>true</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_ignoreUnknownBeanProperties = PREFIX + "ignoreUnknownBeanProperties.b";
/**
* Configuration property: Ignore unknown properties with null values.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownNullBeanProperties.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -1018,13 +1018,13 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, trying to set a <jk>null</jk> value on a non-existent bean property will silently be ignored.
* <br>Otherwise, a {@code RuntimeException} is thrown.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a parser that throws an exception on an unknown property even if the value being set is null.</jc>
* ReaderParser p = JsonParser
* .<jsm>create</jsm>()
@@ -1036,14 +1036,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_ignoreUnknownNullBeanProperties</jsf>, <jk>false</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_ignoreUnknownNullBeanProperties = PREFIX + "ignoreUnknownNullBeanProperties.b";
/**
* Configuration property: Implementation classes.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.implClasses.smc"</js>
* <li><b>Data type:</b> <code>Map<String,Class></code>
@@ -1056,14 +1056,14 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* For interfaces and abstract classes this method can be used to specify an implementation class for the
* interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a
* parse).
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a parser that instantiates MyBeanImpls when parsing MyBeanInterfaces.</jc>
* ReaderParser p = JsonParser
* .<jsm>create</jsm>()
@@ -1075,14 +1075,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .addTo(<jsf>BEAN_implClasses</jsf>, MyBeanInterface.<jk>class</jk>.getName(), MyBeanImpl.<jk>class</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_implClasses = PREFIX + "implClasses.smc";
/**
* Configuration property: Bean property includes.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.properties.sms"</js>
* <li><b>Data type:</b> <code>Map<String,String></code>
@@ -1098,17 +1098,17 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#includeProperties(Class, String)}
* <li class='jm'>{@link BeanContextBuilder#includeProperties(String, String)}
* <li class='jm'>{@link BeanContextBuilder#includeProperties(Map)}
- * <li class='jm'>{@link BeanFilterBuilder#includeProperties(String...)}
+ * <li class='jm'>{@link BeanFilterBuilder#properties(String...)}
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Specifies the set and order of names of properties associated with the bean class.
*
* <p>
* The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property
- * names.
+ * names.
* The key <js>"*"</js> means all bean classes.
*
* <p>
@@ -1118,8 +1118,8 @@ public class BeanContext extends Context {
* <p>
* Setting applies to specified class and all subclasses.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that includes only the 'foo' and 'bar' properties on the MyBean class.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -1137,14 +1137,14 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .addTo(<jsf>BEAN_includeProperties</jsf>, <js>"{'org.apache.MyBean':'foo,bar'}"</js>)
* .build();
- * </p>
+ * </p>
*/
- public static final String BEAN_includeProperties = PREFIX + "properties.sms";
+ public static final String BEAN_includeProperties = PREFIX + "includeProperties.sms";
/**
* Configuration property: Locale.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.locale.s"</js>
* <li><b>Data type:</b> <code>String</code> ({@link Locale})
@@ -1153,11 +1153,12 @@ public class BeanContext extends Context {
* <li><b>Methods:</b>
* <ul>
* <li class='jm'>{@link BeanContextBuilder#locale(Locale)}
+ * <li class='jm'>{@link BeanSessionArgs#locale(Locale)}
* </ul>
* </ul>
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that uses the specified locale if it's not passed in through session args.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -1169,14 +1170,20 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_locale</jsf>, Locale.<jsf>UK</jsf>)
* .build();
- * </p>
+ *
+ * <jc>// Define on session-args instead.</jc>
+ * SerializerSessionArgs sessionArgs = <jk>new</jk> SerializerSessionArgs().locale(Locale.<jsf>UK</jsf>);
+ * <jk>try</jk> (WriterSerializerSession session = s.createSession(sessionArgs)) {
+ * ...
+ * }
+ * </p>
*/
public static final String BEAN_locale = PREFIX + "locale.s";
/**
* Configuration property: Media type.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.mediaType.s"</js>
* <li><b>Data type:</b> <code>String</code> ({@link MediaType})
@@ -1185,15 +1192,16 @@ public class BeanContext extends Context {
* <li><b>Methods:</b>
* <ul>
* <li class='jm'>{@link BeanContextBuilder#mediaType(MediaType)}
+ * <li class='jm'>{@link BeanSessionArgs#mediaType(MediaType)}
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Specifies a default media type value for serializer and parser sessions.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that uses the specified media type if it's not passed in through session args.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -1205,14 +1213,20 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_mediaType</jsf>, MediaType.<jsf>JSON</jsf>)
* .build();
- * </p>
+ *
+ * <jc>// Define on session-args instead.</jc>
+ * SerializerSessionArgs sessionArgs = <jk>new</jk> SerializerSessionArgs().mediaType(MediaType.<jsf>JSON</jsf>);
+ * <jk>try</jk> (WriterSerializerSession session = s.createSession(sessionArgs)) {
+ * ...
+ * }
+ * </p>
*/
public static final String BEAN_mediaType = PREFIX + "mediaType.s";
/**
* Configuration property: Bean class exclusions.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanClasses.sc"</js>
* <li><b>Data type:</b> <code>Set<Class></code>
@@ -1231,13 +1245,20 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
- * Not-bean classes are converted to <code>Strings</code> during serialization even if they appear to be
- * bean-like.
+ * List of classes that should not be treated as beans even if they appear to be bean-like.
+ * <br>Not-bean classes are converted to <code>Strings</code> during serialization.
+ *
+ * <p>
+ * Values can consist of any of the following types:
+ * <ul>
+ * <li>Classes.
+ * <li>Arrays and collections of classes.
+ * </ul>
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that doesn't treat MyBean as a bean class.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -1249,7 +1270,7 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .addTo(<jsf>BEAN_notBeanClasses</jsf>, MyBean.<jk>class</jk>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_notBeanClasses = PREFIX + "notBeanClasses.sc";
@@ -1266,7 +1287,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean package exclusions.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanPackages.ss"</js>
* <li><b>Data type:</b> <code>Set<String></code>
@@ -1291,7 +1312,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* When specified, the current list of ignore packages are appended to.
*
@@ -1301,8 +1322,15 @@ public class BeanContext extends Context {
* <p>
* Note that you can specify suffix patterns to include all subpackages.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
+ * <p>
+ * Values can consist of any of the following types:
+ * <ul>
+ * <li>Strings.
+ * <li>Arrays and collections of strings.
+ * </ul>
+ *
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
* <jc>// Create a serializer that ignores beans in the specified packages.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -1315,7 +1343,7 @@ public class BeanContext extends Context {
* .addTo(<jsf>BEAN_notBeanPackages</jsf>, <js>"org.apache.foo"</js>)
* .addTo(<jsf>BEAN_notBeanPackages</jsf>, <js>"org.apache.bar.*"</js>)
* .build();
- * </p>
+ * </p>
*/
public static final String BEAN_notBeanPackages = PREFIX + "notBeanPackages.ss";
@@ -1332,7 +1360,7 @@ public class BeanContext extends Context {
/**
* Configuration property: POJO swaps.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.pojoSwaps.lc"</js>
* <li><b>Data type:</b> <code>List<Class></code>
@@ -1352,7 +1380,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* POJO swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization,
* and "swap in" the non-serializable class during parsing.
@@ -1373,7 +1401,7 @@ public class BeanContext extends Context {
* <li>Any array or collection of the objects above.
* </ul>
*
- * <h5 class='section'>Example:</h5>
+ * <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Sample swap for converting Dates to ISO8601 strings.</jc>
* <jk>public class</jk> MyDateSwap <jk>extends</jk> StringSwap<Date> {
@@ -1421,15 +1449,15 @@ public class BeanContext extends Context {
* MyBean bean = p.parse(json, MyBean.<jk>class</jk>);
* </p>
*
- * <h5 class='section'>Documentation:</h5>
- * <ul>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.PojoSwaps">Overview > PojoSwaps</a>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.PerMediaTypePojoSwaps">Overview > Per-media-type PojoSwaps</a>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.OneWayPojoSwaps">Overview > One-way PojoSwaps</a>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.SwapMethods">Overview > Swap Methods</a>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.SurrogateClasses">Overview > Surrogate Classes</a>
- * </ul>
+ * <h5 class='section'>Documentation:</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.PojoSwaps">Overview > PojoSwaps</a>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.PerMediaTypePojoSwaps">Overview > Per-media-type PojoSwaps</a>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.OneWayPojoSwaps">Overview > One-way PojoSwaps</a>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.SwapMethods">Overview > Swap Methods</a>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.SurrogateClasses">Overview > Surrogate Classes</a>
+ * </ul>
*/
public static final String BEAN_pojoSwaps = PREFIX + "pojoSwaps.lc";
@@ -1446,7 +1474,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean property namer.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.propertyNamer.c"</js>
* <li><b>Data type:</b> <code>Class<? <jk>implements</jk> {@link PropertyNamer}></code>
@@ -1463,7 +1491,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* The class to use for calculating bean property names.
*
@@ -1496,7 +1524,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Sort bean properties.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.sortProperties.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -1515,7 +1543,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order.
* <br>Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
@@ -1547,7 +1575,7 @@ public class BeanContext extends Context {
/**
* Configuration property: TimeZone.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.timeZone.s"</js>
* <li><b>Data type:</b> <code>String</code> ({@link TimeZone})
@@ -1556,6 +1584,7 @@ public class BeanContext extends Context {
* <li><b>Methods:</b>
* <ul>
* <li class='jm'>{@link BeanContextBuilder#timeZone(TimeZone)}
+ * <li class='jm'>{@link BeanSessionArgs#timeZone(TimeZone)}
* </ul>
* </ul>
*
@@ -1572,6 +1601,12 @@ public class BeanContext extends Context {
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_timeZone</jsf>, TimeZone.<jsf>GMT</jsf>)
* .build();
+ *
+ * <jc>// Define on session-args instead.</jc>
+ * SerializerSessionArgs sessionArgs = <jk>new</jk> SerializerSessionArgs().timeZone(TimeZone.<jsf>GMT</jsf>);
+ * <jk>try</jk> (WriterSerializerSession ss = JsonSerializer.<jsf>DEFAULT</jsf>.createSession(sessionArgs)) {
+ * String json = s.serialize(<jk>new</jk> MyBean());
+ * }
* </p>
*/
public static final String BEAN_timeZone = PREFIX + "timeZone.s";
@@ -1579,7 +1614,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Use interface proxies.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useInterfaceProxies.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -1591,7 +1626,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an
* {@link InvocationHandler} if there is no other way of instantiating them.
@@ -1617,7 +1652,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Use Java Introspector.
*
- * <h5 class='section'>Property:</h5>
+ * <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useJavaBeanIntrospector.b"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -1630,7 +1665,7 @@ public class BeanContext extends Context {
* </ul>
* </ul>
*
- * <h5 class='section'>Description:</h5>
+ * <h5 class='section'>Description:</h5>
* <p>
* Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
* <br>Most {@link Bean @Bean} annotations will be ignored.
http://git-wip-us.apache.org/repos/asf/juneau/blob/0ab0b231/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContextBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContextBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContextBuilder.java
index f0620d2..bf815bf 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContextBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContextBuilder.java
@@ -21,6 +21,7 @@ import java.util.*;
import org.apache.juneau.annotation.*;
import org.apache.juneau.http.*;
import org.apache.juneau.serializer.*;
+import org.apache.juneau.transform.*;
/**
* Builder class for building instances of serializers, parsers, and bean contexts.
@@ -243,6 +244,13 @@ public class BeanContextBuilder extends ContextBuilder {
*
* @param values
* The values to add to this property.
+ * <br>Values can consist of any of the following types:
+ * <ul>
+ * <li>Any bean class that specifies a value for {@link Bean#typeName() @Bean.typeName()}.
+ * <li>Any subclass of {@link BeanDictionaryList} containing a collection of bean classes with type name annotations.
+ * <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name annotations.
+ * <li>Any array or collection of the objects above.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder beanFilters(Object...values) {
@@ -283,6 +291,13 @@ public class BeanContextBuilder extends ContextBuilder {
* If <jk>true</jk>, the previous value is appended to. Otherwise, the previous value is replaced.
* @param values
* The new values for this property.
+ * <br>Values can consist of any of the following types:
+ * <ul>
+ * <li>Any bean class that specifies a value for {@link Bean#typeName() @Bean.typeName()}.
+ * <li>Any subclass of {@link BeanDictionaryList} containing a collection of bean classes with type name annotations.
+ * <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name annotations.
+ * <li>Any array or collection of the objects above.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder beanFilters(boolean append, Object...values) {
@@ -302,6 +317,13 @@ public class BeanContextBuilder extends ContextBuilder {
*
* @param values
* The values to remove from this property.
+ * <br>Values can consist of any of the following types:
+ * <ul>
+ * <li>Any bean class that specifies a value for {@link Bean#typeName() @Bean.typeName()}.
+ * <li>Any subclass of {@link BeanDictionaryList} containing a collection of bean classes with type name annotations.
+ * <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name annotations.
+ * <li>Any array or collection of the objects above.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder beanFiltersRemove(Object...values) {
@@ -613,7 +635,9 @@ public class BeanContextBuilder extends ContextBuilder {
* <li class='jf'>{@link BeanContext#BEAN_excludeProperties}
* </ul>
*
- * @param beanClassName The bean class name. Can be a simple name, fully-qualified name, or <js>"*"</js>.
+ * @param beanClassName
+ * The bean class name.
+ * <br>Can be a simple name, fully-qualified name, or <js>"*"</js> for all bean classes.
* @param value Comma-delimited list of property names.
* @return This object (for method chaining).
*/
@@ -664,7 +688,7 @@ public class BeanContextBuilder extends ContextBuilder {
*
* <p>
* If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.
- * Otherwise, a {@code BeanRuntimeException} is thrown.
+ * <br>Otherwise, a {@code BeanRuntimeException} is thrown.
*
* <h5 class='section'>See Also:</h5>
* <ul>
@@ -702,7 +726,7 @@ public class BeanContextBuilder extends ContextBuilder {
*
* <p>
* If <jk>true</jk>, trying to set a value on a bean property without a setter will silently be ignored.
- * Otherwise, a {@code BeanRuntimeException} is thrown.
+ * <br>Otherwise, a {@code BeanRuntimeException} is thrown.
*
* <h5 class='section'>See Also:</h5>
* <ul>
@@ -723,7 +747,7 @@ public class BeanContextBuilder extends ContextBuilder {
*
* <p>
* If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored.
- * Otherwise, a {@code BeanRuntimeException} is thrown.
+ * <br>Otherwise, a {@code BeanRuntimeException} is thrown.
*
* <h5 class='section'>See Also:</h5>
* <ul>
@@ -761,7 +785,7 @@ public class BeanContextBuilder extends ContextBuilder {
*
* <p>
* If <jk>true</jk>, trying to set a <jk>null</jk> value on a non-existent bean property will silently be ignored.
- * Otherwise, a {@code BeanRuntimeException} is thrown.
+ * <br>Otherwise, a {@code BeanRuntimeException} is thrown.
*
* <h5 class='section'>See Also:</h5>
* <ul>
@@ -862,7 +886,9 @@ public class BeanContextBuilder extends ContextBuilder {
* <li class='jf'>{@link BeanContext#BEAN_includeProperties}
* </ul>
*
- * @param beanClassName The bean class name. Can be a simple name, fully-qualified name, or <js>"*"</js>.
+ * @param beanClassName
+ * The bean class name.
+ * <br>Can be a simple name, fully-qualified name, or <js>"*"</js> for all beans.
* @param value Comma-delimited list of property names.
* @return This object (for method chaining).
*/
@@ -873,6 +899,9 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Locale.
*
+ * <p>
+ * Specifies a default locale for serializer and parser sessions.
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_locale}
@@ -907,7 +936,7 @@ public class BeanContextBuilder extends ContextBuilder {
* Configuration property: Bean class exclusions.
*
* <p>
- * Not-bean classes are typically converted to <code>Strings</code> during serialization even if they appear to be
+ * Not-bean classes are converted to <code>Strings</code> during serialization even if they appear to be
* bean-like.
*
* <h5 class='section'>See Also:</h5>
@@ -916,8 +945,15 @@ public class BeanContextBuilder extends ContextBuilder {
* </ul>
*
* @param append
- * If <jk>true</jk>, the previous value is appended to. Otherwise, the previous value is replaced.
- * @param values The new value for this property.
+ * If <jk>true</jk>, the previous value is appended to.
+ * <br>Otherwise, the previous value is replaced.
+ * @param values
+ * The new value for this property.
+ * <br>Values can consist of any of the following types:
+ * <ul>
+ * <li>Classes.
+ * <li>Arrays and collections of classes.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder notBeanClasses(boolean append, Object...values) {
@@ -926,7 +962,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean class exclusions.
- *
+ *
+ * <p>
+ * List of classes that should not be treated as beans even if they appear to be bean-like.
+ * <br>Not-bean classes are converted to <code>Strings</code> during serialization.
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
@@ -941,13 +981,23 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean class exclusions.
+ *
+ * <p>
+ * List of classes that should not be treated as beans even if they appear to be bean-like.
+ * <br>Not-bean classes are converted to <code>Strings</code> during serialization.
*
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
* </ul>
*
- * @param values The values to add to this property.
+ * @param values
+ * The values to add to this property.
+ * <br>Values can consist of any of the following types:
+ * <ul>
+ * <li>Classes.
+ * <li>Arrays and collections of classes.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder notBeanClasses(Object...values) {
@@ -962,7 +1012,13 @@ public class BeanContextBuilder extends ContextBuilder {
* <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
* </ul>
*
- * @param values The values to remove from this property.
+ * @param values
+ * The values to remove from this property.
+ * <br>Values can consist of any of the following types:
+ * <ul>
+ * <li>Classes.
+ * <li>Arrays and collections of classes.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder notBeanClassesRemove(Object...values) {
@@ -981,8 +1037,15 @@ public class BeanContextBuilder extends ContextBuilder {
* </ul>
*
* @param append
- * If <jk>true</jk>, the previous value is appended to. Otherwise, the previous value is replaced.
- * @param values The new value for this property.
+ * If <jk>true</jk>, the previous value is appended to.
+ * <br>Otherwise, the previous value is replaced.
+ * @param values
+ * The new values for this property.
+ * <br>Values can consist of any of the following types:
+ * <ul>
+ * <li>Classes.
+ * <li>Arrays and collections of classes.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder notBeanPackages(boolean append, Object...values) {
@@ -997,7 +1060,13 @@ public class BeanContextBuilder extends ContextBuilder {
* <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
* </ul>
*
- * @param values The values to add to this property.
+ * @param values
+ * The values to add to this property.
+ * <br>Values can consist of any of the following types:
+ * <ul>
+ * <li>Strings.
+ * <li>Arrays and collections of strings.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder notBeanPackages(Object...values) {
@@ -1012,7 +1081,8 @@ public class BeanContextBuilder extends ContextBuilder {
* <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
* </ul>
*
- * @param values The values to add to this property.
+ * @param values
+ * The values to add to this property.
* @return This object (for method chaining).
*/
public BeanContextBuilder notBeanPackages(String...values) {
@@ -1027,7 +1097,13 @@ public class BeanContextBuilder extends ContextBuilder {
* <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
* </ul>
*
- * @param values The values to remove from this property.
+ * @param values
+ * <br>Values can consist of any of the following types:
+ * <br>Possible values are:
+ * <ul>
+ * <li>Strings.
+ * <li>Arrays and collections of strings.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder notBeanPackagesRemove(Object...values) {
@@ -1050,8 +1126,15 @@ public class BeanContextBuilder extends ContextBuilder {
* </ul>
*
* @param append
- * If <jk>true</jk>, the previous value is appended to. Otherwise, the previous value is replaced.
- * @param values The new value for this property.
+ * If <jk>true</jk>, the previous value is appended to.
+ * <br>Otherwise, the previous value is replaced.
+ * @param values
+ * The new value for this property.
+ * <br>Values can consist of any of the following types:
+ * <ul>
+ * <li>Strings.
+ * <li>Arrays and collections of strings.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder pojoSwaps(boolean append, Object...values) {
@@ -1081,7 +1164,14 @@ public class BeanContextBuilder extends ContextBuilder {
* <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
* </ul>
*
- * @param values The values to add to this property.
+ * @param values
+ * The values to add to this property.
+ * <br>Values can consist of any of the following types:
+ * <ul>
+ * <li>Any subclass of {@link PojoSwap}.
+ * <li>Any surrogate class. A shortcut for defining a {@link SurrogateSwap}.
+ * <li>Any array or collection of the objects above.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder pojoSwaps(Object...values) {
@@ -1096,7 +1186,14 @@ public class BeanContextBuilder extends ContextBuilder {
* <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
* </ul>
*
- * @param values The values to remove from this property.
+ * @param values
+ * The values to remove from this property.
+ * <br>Values can consist of any of the following types:
+ * <ul>
+ * <li>Any subclass of {@link PojoSwap}.
+ * <li>Any surrogate class. A shortcut for defining a {@link SurrogateSwap}.
+ * <li>Any array or collection of the objects above.
+ * </ul>
* @return This object (for method chaining).
*/
public BeanContextBuilder pojoSwapsRemove(Object...values) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/0ab0b231/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
index d7f4707..829e7a5 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
@@ -248,7 +248,7 @@ public class BeanSession extends Session {
* <br>{@code List<X[]>}
* <br>{@code List[]<X>}
* </td>
- * <td> </td>
+ * <td> </td>
* </tr>
* <tr>
* <td>
@@ -293,7 +293,7 @@ public class BeanSession extends Session {
* <br>
* </td>
* </tr>
- * </table>
+ * </table>
*
* @param <T> The class type to convert the value to.
* @param value The value to be converted.