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/08 02:00:53 UTC
[4/4] juneau git commit: Javadoc updates.
Javadoc updates.
Project: http://git-wip-us.apache.org/repos/asf/juneau/repo
Commit: http://git-wip-us.apache.org/repos/asf/juneau/commit/7780e6fe
Tree: http://git-wip-us.apache.org/repos/asf/juneau/tree/7780e6fe
Diff: http://git-wip-us.apache.org/repos/asf/juneau/diff/7780e6fe
Branch: refs/heads/master
Commit: 7780e6fe3f352fbf822dd292deda8ad5507d37c4
Parents: 45640a1
Author: JamesBognar <ja...@apache.org>
Authored: Sun Jan 7 21:00:45 2018 -0500
Committer: JamesBognar <ja...@apache.org>
Committed: Sun Jan 7 21:00:45 2018 -0500
----------------------------------------------------------------------
.../urlencoding/UrlEncodingSerializerTest.java | 2 +-
.../apache/juneau/jena/RdfParserBuilder.java | 70 +-
.../juneau/jena/RdfSerializerBuilder.java | 93 ++-
.../java/org/apache/juneau/BeanContext.java | 37 +-
.../org/apache/juneau/BeanContextBuilder.java | 429 +++++------
.../main/java/org/apache/juneau/Visibility.java | 20 +-
.../juneau/html/HtmlSerializerBuilder.java | 35 +-
.../SimpleUonPartSerializerBuilder.java | 11 +-
.../juneau/httppart/UonPartParserBuilder.java | 4 +-
.../juneau/httppart/UonPartSerializer.java | 2 +-
.../httppart/UonPartSerializerBuilder.java | 54 +-
.../juneau/json/JsonSerializerBuilder.java | 19 +-
.../org/apache/juneau/parser/ParserBuilder.java | 39 +-
.../juneau/parser/ParserGroupBuilder.java | 30 +-
.../juneau/serializer/SerializerBuilder.java | 140 ++--
.../serializer/SerializerGroupBuilder.java | 124 +++-
.../juneau/soap/SoapXmlSerializerBuilder.java | 9 +-
.../java/org/apache/juneau/uon/UonParser.java | 10 +-
.../org/apache/juneau/uon/UonParserBuilder.java | 18 +-
.../org/apache/juneau/uon/UonParserSession.java | 4 +-
.../org/apache/juneau/uon/UonSerializer.java | 10 +-
.../apache/juneau/uon/UonSerializerBuilder.java | 36 +-
.../apache/juneau/uon/UonSerializerSession.java | 4 +-
.../juneau/urlencoding/UrlEncodingParser.java | 2 +-
.../urlencoding/UrlEncodingParserBuilder.java | 19 +-
.../urlencoding/UrlEncodingSerializer.java | 2 +-
.../UrlEncodingSerializerBuilder.java | 58 +-
.../UrlEncodingSerializerSession.java | 2 +-
.../org/apache/juneau/xml/XmlParserBuilder.java | 35 +-
.../apache/juneau/xml/XmlSerializerBuilder.java | 47 +-
.../yaml/proto/YamlSerializerBuilder.java | 19 +-
juneau-doc/src/main/javadoc/overview.html | 4 +-
.../juneau/rest/client/RestClientBuilder.java | 724 ++++++++++++-------
.../apache/juneau/rest/RestContextBuilder.java | 449 +++++++++---
.../juneau/rest/annotation/RestMethod.java | 86 ++-
.../juneau/rest/annotation/RestResource.java | 228 ++++--
36 files changed, 1753 insertions(+), 1122 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/urlencoding/UrlEncodingSerializerTest.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/urlencoding/UrlEncodingSerializerTest.java b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/urlencoding/UrlEncodingSerializerTest.java
index 4c657d0..81a85d8 100755
--- a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/urlencoding/UrlEncodingSerializerTest.java
+++ b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/urlencoding/UrlEncodingSerializerTest.java
@@ -452,7 +452,7 @@ public class UrlEncodingSerializerTest {
//====================================================================================================
@Test
public void testPlainTextParams() throws Exception {
- WriterSerializer s = UrlEncodingSerializer.DEFAULT.builder().plainTextParams().build();
+ WriterSerializer s = UrlEncodingSerializer.DEFAULT.builder().paramFormatPlain().build();
assertEquals("_value=foo", s.serialize("foo"));
assertEquals("_value='foo'", s.serialize("'foo'"));
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
index d1bdf65..a49b597 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
@@ -81,13 +81,16 @@ public class RdfParserBuilder extends ParserBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_collectionFormat</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfParser#RDF_collectionFormat}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_collectionFormat
*/
public RdfParserBuilder collectionFormat(RdfCollectionFormat value) {
return set(RDF_collectionFormat, value);
@@ -96,14 +99,13 @@ public class RdfParserBuilder extends ParserBuilder {
/**
* Configuration property: Default XML namespace for bean properties.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_juneauBpNs</jsf>, value)</code>.
+ * <li class='jf'>{@link RdfParser#RDF_juneauBpNs}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_juneauBpNs
*/
public RdfParserBuilder juneauBpNs(Namespace value) {
return set(RDF_juneauBpNs, value);
@@ -112,14 +114,13 @@ public class RdfParserBuilder extends ParserBuilder {
/**
* Configuration property: XML namespace for Juneau properties.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_juneauNs</jsf>, value)</code>.
+ * <li class='jf'>{@link RdfParser#RDF_juneauNs}
* </ul>
*
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_juneauNs
*/
public RdfParserBuilder juneauNs(Namespace value) {
return set(RDF_juneauNs, value);
@@ -158,14 +159,13 @@ public class RdfParserBuilder extends ParserBuilder {
* http://www.dajobe.org/2004/01/turtle/
* </ul>
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_language</jsf>, value)</code>.
+ * <li class='jf'>{@link RdfParser#RDF_language}
* </ul>
*
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_language
*/
public RdfParserBuilder language(String value) {
return set(RDF_language, value);
@@ -209,14 +209,13 @@ public class RdfParserBuilder extends ParserBuilder {
* b = p.parse(rdfXml, MyBean[].<jk>class</jk>);
* </p>
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_looseCollections</jsf>, value)</code>.
+ * <li class='jf'>{@link RdfParser#RDF_looseCollections}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_looseCollections
*/
public RdfParserBuilder looseCollections(boolean value) {
return set(RDF_looseCollections, value);
@@ -225,6 +224,11 @@ public class RdfParserBuilder extends ParserBuilder {
/**
* Shortcut for calling <code>language(<jsf>LANG_N3</jsf>)</code>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfParser#RDF_language}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public RdfParserBuilder n3() {
@@ -234,6 +238,11 @@ public class RdfParserBuilder extends ParserBuilder {
/**
* Shortcut for calling <code>language(<jsf>LANG_NTRIPLE</jsf>)</code>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfParser#RDF_language}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public RdfParserBuilder ntriple() {
@@ -246,14 +255,13 @@ public class RdfParserBuilder extends ParserBuilder {
* <p>
* If <jk>true</jk>, whitespace in text elements will be automatically trimmed.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_trimWhitespace</jsf>, value)</code>.
+ * <li class='jf'>{@link RdfParser#RDF_trimWhitespace}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfParser#RDF_trimWhitespace
*/
public RdfParserBuilder trimWhitespace(boolean value) {
return set(RDF_trimWhitespace, value);
@@ -262,6 +270,11 @@ public class RdfParserBuilder extends ParserBuilder {
/**
* Shortcut for calling <code>language(<jsf>LANG_TURTLE</jsf>)</code>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfParser#RDF_language}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public RdfParserBuilder turtle() {
@@ -276,14 +289,13 @@ public class RdfParserBuilder extends ParserBuilder {
* inherited by the RDF parsers.
* Otherwise, namespaces will be defined using {@link RdfNs} and {@link Rdf}.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_useXmlNamespaces</jsf>, value)</code>.
+ * <li class='jf'>{@link RdfParser#RDF_useXmlNamespaces}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_useXmlNamespaces
*/
public RdfParserBuilder useXmlNamespaces(boolean value) {
return set(RDF_useXmlNamespaces, value);
@@ -292,6 +304,11 @@ public class RdfParserBuilder extends ParserBuilder {
/**
* Shortcut for calling <code>language(<jsf>LANG_RDF_XML</jsf>)</code>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfParser#RDF_language}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public RdfParserBuilder xml() {
@@ -301,6 +318,11 @@ public class RdfParserBuilder extends ParserBuilder {
/**
* Shortcut for calling <code>language(<jsf>LANG_RDF_XML_ABBREV</jsf>)</code>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfParser#RDF_language}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public RdfParserBuilder xmlabbrev() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
index af33ee5..e1adc68 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
@@ -64,9 +64,13 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_addLiteralTypes}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfSerializer#RDF_addLiteralTypes
*/
public RdfSerializerBuilder addLiteralTypes(boolean value) {
return set(RDF_addLiteralTypes, value);
@@ -86,13 +90,16 @@ public class RdfSerializerBuilder extends SerializerBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_addRootProperty</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_addRootProperty}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfSerializer#RDF_addRootProperty
*/
public RdfSerializerBuilder addRootProperty(boolean value) {
return set(RDF_addRootProperty, value);
@@ -110,13 +117,16 @@ public class RdfSerializerBuilder extends SerializerBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_autoDetectNamespaces</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_autoDetectNamespaces}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfSerializer#RDF_autoDetectNamespaces
*/
public RdfSerializerBuilder autoDetectNamespaces(boolean value) {
return set(RDF_autoDetectNamespaces, value);
@@ -148,13 +158,16 @@ public class RdfSerializerBuilder extends SerializerBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_collectionFormat</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_collectionFormat}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_collectionFormat
*/
public RdfSerializerBuilder collectionFormat(RdfCollectionFormat value) {
return set(RDF_collectionFormat, value);
@@ -165,13 +178,16 @@ public class RdfSerializerBuilder extends SerializerBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_juneauBpNs</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_juneauBpNs}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_juneauBpNs
*/
public RdfSerializerBuilder juneauBpNs(Namespace value) {
return set(RDF_juneauBpNs, value);
@@ -182,13 +198,16 @@ public class RdfSerializerBuilder extends SerializerBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_juneauNs</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_juneauNs}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_juneauNs
*/
public RdfSerializerBuilder juneauNs(Namespace value) {
return set(RDF_juneauNs, value);
@@ -229,13 +248,16 @@ public class RdfSerializerBuilder extends SerializerBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_language</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_language}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_language
*/
public RdfSerializerBuilder language(String value) {
return set(RDF_language, value);
@@ -279,14 +301,13 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* b = p.parse(rdfXml, MyBean[].<jk>class</jk>);
* </p>
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_looseCollections</jsf>, value)</code>.
+ * <li class='jf'>{@link RdfSerializer#RDF_looseCollections}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_looseCollections
*/
public RdfSerializerBuilder looseCollections(boolean value) {
return set(RDF_looseCollections, value);
@@ -295,6 +316,11 @@ public class RdfSerializerBuilder extends SerializerBuilder {
/**
* Shortcut for calling <code>language(<jsf>LANG_N3</jsf>)</code>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_language}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public RdfSerializerBuilder n3() {
@@ -313,9 +339,13 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_namespaces}
+ * </ul>
+ *
* @param values The new value for this property.
* @return This object (for method chaining).
- * @see RdfSerializer#RDF_namespaces
*/
public RdfSerializerBuilder namespaces(Namespace...values) {
return set(RDF_namespaces, values);
@@ -324,6 +354,11 @@ public class RdfSerializerBuilder extends SerializerBuilder {
/**
* Shortcut for calling <code>language(<jsf>LANG_NTRIPLE</jsf>)</code>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_language}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public RdfSerializerBuilder ntriple() {
@@ -333,6 +368,11 @@ public class RdfSerializerBuilder extends SerializerBuilder {
/**
* Shortcut for calling <code>language(<jsf>LANG_TURTLE</jsf>)</code>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_language}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public RdfSerializerBuilder turtle() {
@@ -349,13 +389,16 @@ public class RdfSerializerBuilder extends SerializerBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>RDF_useXmlNamespaces</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_useXmlNamespaces}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see RdfCommon#RDF_useXmlNamespaces
*/
public RdfSerializerBuilder useXmlNamespaces(boolean value) {
return set(RDF_useXmlNamespaces, value);
@@ -364,6 +407,11 @@ public class RdfSerializerBuilder extends SerializerBuilder {
/**
* Shortcut for calling <code>language(<jsf>LANG_RDF_XML</jsf>)</code>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_language}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public RdfSerializerBuilder xml() {
@@ -373,6 +421,11 @@ public class RdfSerializerBuilder extends SerializerBuilder {
/**
* Shortcut for calling <code>language(<jsf>LANG_RDF_XML_ABBREV</jsf>)</code>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RdfSerializer#RDF_language}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public RdfSerializerBuilder xmlabbrev() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/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 03e9f4e..c82c4dd 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
@@ -26,7 +26,6 @@ import org.apache.juneau.annotation.*;
import org.apache.juneau.http.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.json.*;
-import org.apache.juneau.parser.*;
import org.apache.juneau.serializer.*;
import org.apache.juneau.transform.*;
@@ -40,14 +39,11 @@ import org.apache.juneau.transform.*;
* Provides the ability to wrap beans inside {@link Map} interfaces.
* <li>
* Serves as a repository for metadata on POJOs, such as associated {@link BeanFilter beanFilters},
- * {@link PropertyNamer property namers}, etc... which are used to tailor how POJOs are serialized and parsed.
- * <li>
- * Serves as a common utility class for all {@link Serializer Serializers} and {@link Parser Parsers}
- * for serializing and parsing Java beans.
+ * {@link PropertyNamer propertyNamers}, etc... which are used to tailor how POJOs are serialized and parsed.
* </ul>
*
* <p>
- * All serializer and parser contexts extend from this context.
+ * All serializers and parsers extend from this context so that they can handle POJOs using a common framework.
*
* <h5 class='topic'>Bean Contexts</h5>
*
@@ -187,24 +183,6 @@ import org.apache.juneau.transform.*;
* <p>
* See {@link BeanConstructor @BeanConstructor} for more information.
*
- * <h5 class='topic'>BeanFilters and PojoSwaps</h5>
- *
- * {@link BeanFilter BeanFilters} and {@link PojoSwap PojoSwaps} are used to tailor how beans and POJOs are handled.
- * <ol class='spaced-list'>
- * <li>
- * {@link BeanFilter} - Allows you to tailor handling of bean classes.
- * This class can be considered a programmatic equivalent to the {@link Bean} annotation when
- * annotating classes are not possible (e.g. you don't have access to the source).
- * This includes specifying which properties are visible and the ability to programmatically override the
- * execution of properties.
- * <li>
- * {@link PojoSwap} - Allows you to swap out non-serializable objects with serializable replacements.
- * </ol>
- *
- * <p>
- * See <a class='doclink' href='transform/package-summary.html#TOC'>org.apache.juneau.transform</a> for more
- * information.
- *
* <h5 class='topic'>ClassMetas</h5>
*
* The {@link ClassMeta} class is a wrapper around {@link Class} object that provides cached information about that
@@ -225,8 +203,9 @@ public class BeanContext extends Context {
static final String PREFIX = "BeanContext.";
/**
+ *
* Configuration property: Look for bean classes with the specified minimum visibility.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanClassVisibility.s"</js>
@@ -238,12 +217,18 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beanClassVisibility(Visibility)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Classes are not considered beans unless they meet the minimum visibility requirements.
* For example, if the visibility is <code>PUBLIC</code> and the bean class is <jk>protected</jk>, then the class
* will not be interpreted as a bean class.
+ *
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
+ * <jc>// Create a serializer that serializes protected classes.</jc>
+ * WriterSerializer s = JsonSerializer.<jsm>create</jsm>().beanClassVisibility(<jsf>PROTECTED</jsf>).build();
+ * </p>
*/
public static final String BEAN_beanClassVisibility = PREFIX + "beanClassVisibility.s";
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/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 a73b80b..c58df6e 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
@@ -64,14 +64,12 @@ public class BeanContextBuilder extends ContextBuilder {
* For example, if the visibility is <code>PUBLIC</code> and the bean class is <jk>protected</jk>, then the class
* will not be interpreted as a bean class.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_beanClassVisibility</jsf>, value)</code>.
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beanClassVisibility
*/
public BeanContextBuilder beanClassVisibility(Visibility value) {
return set(BEAN_beanClassVisibility, value);
@@ -85,14 +83,13 @@ public class BeanContextBuilder extends ContextBuilder {
* For example, if the visibility is <code>PUBLIC</code> and the constructor is <jk>protected</jk>, then the
* constructor will be ignored.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_beanConstructorVisibility</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_beanConstructorVisibility}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beanConstructorVisibility
*/
public BeanContextBuilder beanConstructorVisibility(Visibility value) {
return set(BEAN_beanConstructorVisibility, value);
@@ -101,11 +98,9 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean lookup dictionary.
*
- * <h6 class='figure'>Example:</h6>
- *
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_beanDictionary</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_beanDictionary}
* </ul>
*
* @param append
@@ -122,7 +117,6 @@ public class BeanContextBuilder extends ContextBuilder {
* <li>Any array or collection of the types above:
* </ul>
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beanDictionary
*/
public BeanContextBuilder beanDictionary(boolean append, Object...values) {
return set(append, BEAN_beanDictionary, values);
@@ -134,6 +128,11 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* Same as calling {@link #beanDictionary(Object...)} but with an array of classes.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_beanDictionary}
+ * </ul>
+ *
* @param values The values to add to this property.
* @return This object (for method chaining).
*/
@@ -152,43 +151,11 @@ public class BeanContextBuilder extends ContextBuilder {
* through reflection.
* <br>The names are defined through the {@link Bean#typeName()} annotation defined on the bean class.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
- * BeanContext bc = BeanContext.<jsf>create</jsf>().beanDictionary(Bar.<jk>class</jk>, Baz.<jk>class</jk>).build();
- * </p>
- *
- * <p>
- * <h5 class='section'>Notes:</h5>
- * <ul class='spaced-list'>
- * <li>Properties:
- * <ul>
- * <li>{@link BeanContext#BEAN_beanDictionary}
- * <li>{@link BeanContext#BEAN_beanDictionary_add}
- * <li>{@link BeanContext#BEAN_beanDictionary_remove}
- * </ul>
- * <li>Annotations:
- * <ul>
- * <li>{@link Bean#beanDictionary()}
- * <li>{@link BeanProperty#beanDictionary()}
- * </ul>
- * <li>Methods:
- * <ul>
- * <li>{@link BeanContextBuilder#beanDictionary(Object...)}
- * <li>{@link BeanContextBuilder#beanDictionary(boolean,Object...)}
- * <li>{@link BeanContextBuilder#beanDictionaryRemove(Object...)}
- * </ul>
- * <li>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.
- * </ul>
- * <li>See <a class='doclink' href='../../../overview-summary.html#juneau-marshall.BeanDictionaries'>Bean Names and Dictionaries</a>
- * for more information.
- * </ul>
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_beanDictionary}
+ * </ul>
+ *
* @param values The values to add to this property.
* @return This object (for method chaining).
*/
@@ -205,10 +172,13 @@ public class BeanContextBuilder extends ContextBuilder {
* or <code>property(<jsf>BEAN_beanDictionary_remove</jsf>, values)</code>.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_beanDictionary}
+ * </ul>
+ *
* @param values The values to remove from this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beanDictionary
- * @see BeanContext#BEAN_beanDictionary_remove
*/
public BeanContextBuilder beanDictionaryRemove(Object...values) {
return removeFrom(BEAN_beanDictionary, values);
@@ -228,9 +198,13 @@ public class BeanContextBuilder extends ContextBuilder {
* <li>Use {@link Visibility#NONE} to prevent bean fields from being interpreted as bean properties altogether.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_beanFieldVisibility}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beanFieldVisibility
*/
public BeanContextBuilder beanFieldVisibility(Visibility value) {
return set(BEAN_beanFieldVisibility, value);
@@ -257,16 +231,15 @@ public class BeanContextBuilder extends ContextBuilder {
* All other bean properties will be ignored.
* </ul>
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_beanFilters</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_beanFilters}
* </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.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beanFilters
*/
public BeanContextBuilder beanFilters(boolean append, Object...values) {
return set(append, BEAN_beanFilters, values);
@@ -278,6 +251,11 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* Same as {@link #beanFilters(Object...)} but takes in an array of classes.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_beanFilters}
+ * </ul>
+ *
* @param values The values to add to this property.
* @return This object (for method chaining).
*/
@@ -294,10 +272,13 @@ public class BeanContextBuilder extends ContextBuilder {
* or <code>property(<jsf>BEAN_beanFilters_add</jsf>, values)</code>.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_beanFilters}
+ * </ul>
+ *
* @param values The values to add to this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beanFilters
- * @see BeanContext#BEAN_beanFilters_add
*/
public BeanContextBuilder beanFilters(Object...values) {
return addTo(BEAN_beanFilters, values);
@@ -312,10 +293,13 @@ public class BeanContextBuilder extends ContextBuilder {
* or <code>property(<jsf>BEAN_beanFilters_remove</jsf>, values)</code>.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_beanFilters}
+ * </ul>
+ *
* @param values The values to remove from this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beanFilters
- * @see BeanContext#BEAN_beanFilters_remove
*/
public BeanContextBuilder beanFiltersRemove(Object...values) {
return removeFrom(BEAN_beanFilters, values);
@@ -333,14 +317,13 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* Disabled by default because it introduces a slight performance penalty.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_beanMapPutReturnsOldValue</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_beanMapPutReturnsOldValue}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beanMapPutReturnsOldValue
*/
public BeanContextBuilder beanMapPutReturnsOldValue(boolean value) {
return set(BEAN_beanMapPutReturnsOldValue, value);
@@ -356,14 +339,13 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireDefaultConstructor</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_beansRequireDefaultConstructor}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beansRequireDefaultConstructor
*/
public BeanContextBuilder beansRequireDefaultConstructor(boolean value) {
return set(BEAN_beansRequireDefaultConstructor, value);
@@ -379,14 +361,13 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireSerializable</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_beansRequireSerializable}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beansRequireSerializable
*/
public BeanContextBuilder beansRequireSerializable(boolean value) {
return set(BEAN_beansRequireSerializable, value);
@@ -399,14 +380,13 @@ public class BeanContextBuilder extends ContextBuilder {
* If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean.
* Otherwise, they will be ignored.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireSettersForGetters</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_beansRequireSettersForGetters}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beansRequireSettersForGetters
*/
public BeanContextBuilder beansRequireSettersForGetters(boolean value) {
return set(BEAN_beansRequireSettersForGetters, value);
@@ -422,14 +402,13 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireSomeProperties</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_beansRequireSomeProperties}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beansRequireSomeProperties
*/
public BeanContextBuilder beansRequireSomeProperties(boolean value) {
return set(BEAN_beansRequireSomeProperties, value);
@@ -438,14 +417,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Name to use for the bean type properties used to represent a bean type.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_beanTypePropertyName</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_beanTypePropertyName}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_beanTypePropertyName
*/
public BeanContextBuilder beanTypePropertyName(String value) {
return set(BEAN_beanTypePropertyName, value);
@@ -472,13 +450,12 @@ public class BeanContextBuilder extends ContextBuilder {
* in order to determine how that method was invoked.
* </ul>
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_debug</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_debug}
* </ul>
- *
+ *
* @return This object (for method chaining).
- * @see BeanContext#BEAN_debug
*/
public BeanContextBuilder debug() {
return set(BEAN_debug, true);
@@ -487,16 +464,14 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Exclude specified properties from beans.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>putToProperty(<jsf>BEAN_excludeProperties</jsf>, beanClass.getName(), properties)</code>
- * or <code>property(<jsf>BEAN_excludeProperties_put</jsf>, beanClass.getName(), properties)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_excludeProperties}
* </ul>
- *
+ *
* @param beanClass The bean class.
* @param properties Comma-delimited list of property names.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_excludeProperties
*/
public BeanContextBuilder excludeProperties(Class<?> beanClass, String properties) {
return addTo(BEAN_excludeProperties, beanClass.getName(), properties);
@@ -508,23 +483,13 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* Specifies to exclude the specified list of properties for the specified bean classes.
*
- * <p>
- * The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property
- * names.
- * The key <js>"*"</js> means all bean classes.
- *
- * <p>
- * For example, <code>{Bean1:<js>"foo,bar"</js>}</code> means don't serialize the <code>foo</code> and <code>bar</code>
- * properties on the specified bean.
- *
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_excludeProperties</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_excludeProperties}
* </ul>
- *
+ *
* @param values The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_excludeProperties
*/
public BeanContextBuilder excludeProperties(Map<String,String> values) {
return set(BEAN_excludeProperties, values);
@@ -533,16 +498,14 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Exclude specified properties from beans.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>putToProperty(<jsf>BEAN_excludeProperties</jsf>, beanClassName, properties)</code>
- * or <code>property(<jsf>BEAN_excludeProperties_put</jsf>, beanClassName, properties)</code>.
+ * <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 properties Comma-delimited list of property names.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_excludeProperties
*/
public BeanContextBuilder excludeProperties(String beanClassName, String properties) {
return addTo(BEAN_excludeProperties, beanClassName, properties);
@@ -555,14 +518,13 @@ public class BeanContextBuilder extends ContextBuilder {
* If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreInvocationExceptionsOnGetters</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_ignoreInvocationExceptionsOnGetters}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_ignoreInvocationExceptionsOnGetters
*/
public BeanContextBuilder ignoreInvocationExceptionsOnGetters(boolean value) {
return set(BEAN_ignoreInvocationExceptionsOnGetters, value);
@@ -575,14 +537,13 @@ public class BeanContextBuilder extends ContextBuilder {
* If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreInvocationExceptionsOnSetters</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_ignoreInvocationExceptionsOnSetters}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_ignoreInvocationExceptionsOnSetters
*/
public BeanContextBuilder ignoreInvocationExceptionsOnSetters(boolean value) {
return set(BEAN_ignoreInvocationExceptionsOnSetters, value);
@@ -595,14 +556,13 @@ public class BeanContextBuilder extends ContextBuilder {
* 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.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_ignorePropertiesWithoutSetters</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_ignorePropertiesWithoutSetters}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_ignorePropertiesWithoutSetters
*/
public BeanContextBuilder ignorePropertiesWithoutSetters(boolean value) {
return set(BEAN_ignorePropertiesWithoutSetters, value);
@@ -615,14 +575,13 @@ public class BeanContextBuilder extends ContextBuilder {
* 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.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreUnknownBeanProperties</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_ignoreUnknownBeanProperties}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_ignoreUnknownBeanProperties
*/
public BeanContextBuilder ignoreUnknownBeanProperties(boolean value) {
return set(BEAN_ignoreUnknownBeanProperties, value);
@@ -635,14 +594,13 @@ public class BeanContextBuilder extends ContextBuilder {
* 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.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreUnknownNullBeanProperties</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_ignoreUnknownNullBeanProperties}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_ignoreUnknownNullBeanProperties
*/
public BeanContextBuilder ignoreUnknownNullBeanProperties(boolean value) {
return set(BEAN_ignoreUnknownNullBeanProperties, value);
@@ -651,17 +609,15 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Implementation classes for interfaces and abstract classes.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>putToProperty(<jsf>BEAN_implClasses</jsf>, interfaceClass, implClass)</code>
- * or <code>property(<jsf>BEAN_implClasses_put</jsf>, interfaceClass, implClass)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_implClasses}
* </ul>
- *
+ *
* @param interfaceClass The interface class.
* @param implClass The implementation class.
* @param <I> The class type of the interface.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_implClasses
*/
public <I> BeanContextBuilder implClass(Class<I> interfaceClass, Class<? extends I> implClass) {
return addTo(BEAN_implClasses, interfaceClass.getName(), implClass);
@@ -675,14 +631,13 @@ public class BeanContextBuilder extends ContextBuilder {
* interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a
* parse).
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_implClasses</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_implClasses}
* </ul>
- *
+ *
* @param values The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_implClasses
*/
public BeanContextBuilder implClasses(Map<String,Class<?>> values) {
return set(BEAN_implClasses, values);
@@ -691,16 +646,14 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Explicitly specify visible bean properties.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>putToProperty(<jsf>BEAN_includeProperties</jsf>, beanClass.getName(), properties)</code>
- * or <code>property(<jsf>BEAN_includeProperties_put</jsf>, beanClass.getName(), properties)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_includeProperties}
* </ul>
- *
+ *
* @param beanClass The bean class.
* @param properties Comma-delimited list of property names.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_includeProperties
*/
public BeanContextBuilder includeProperties(Class<?> beanClass, String properties) {
return addTo(BEAN_includeProperties, beanClass.getName(), properties);
@@ -712,23 +665,13 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* Specifies to only include the specified list of properties for the specified bean classes.
*
- * <p>
- * The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property
- * names.
- * The key <js>"*"</js> means all bean classes.
- *
- * <p>
- * For example, <code>{Bean1:<js>"foo,bar"</js>}</code> means only serialize the <code>foo</code> and <code>bar</code>
- * properties on the specified bean.
- *
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_includeProperties</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_includeProperties}
* </ul>
- *
+ *
* @param values The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_includeProperties
*/
public BeanContextBuilder includeProperties(Map<String,String> values) {
return set(BEAN_includeProperties, values);
@@ -737,16 +680,14 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Explicitly specify visible bean properties.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>putToProperty(<jsf>BEAN_includeProperties</jsf>, beanClassName, properties)</code>
- * or <code>property(<jsf>BEAN_includeProperties_put</jsf>, beanClassName, properties)</code>.
+ * <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 properties Comma-delimited list of property names.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_includeProperties
*/
public BeanContextBuilder includeProperties(String beanClassName, String properties) {
return addTo(BEAN_includeProperties, beanClassName, properties);
@@ -755,14 +696,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Locale.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_locale</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_locale}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_locale
*/
public BeanContextBuilder locale(Locale value) {
return set(BEAN_locale, value);
@@ -774,14 +714,13 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* Specifies a default media type value for serializer and parser sessions.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_mediaType</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_mediaType}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_mediaType
*/
public BeanContextBuilder mediaType(MediaType value) {
return set(BEAN_mediaType, value);
@@ -795,15 +734,13 @@ public class BeanContextBuilder extends ContextBuilder {
* For example, if the visibility is <code>PUBLIC</code> and the bean method is <jk>protected</jk>, then the method
* will not be interpreted as a bean getter or setter.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_methodVisibility</jsf>, value)</code>.
- * <li>Use {@link Visibility#NONE} to prevent bean methods from being interpreted as bean properties altogether.
+ * <li class='jf'>{@link BeanContext#BEAN_methodVisibility}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_methodVisibility
*/
public BeanContextBuilder methodVisibility(Visibility value) {
return set(BEAN_methodVisibility, value);
@@ -816,16 +753,15 @@ public class BeanContextBuilder extends ContextBuilder {
* Not-bean classes are typically converted to <code>Strings</code> during serialization even if they appear to be
* bean-like.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_notBeanClasses</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
* </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.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_notBeanClasses
*/
public BeanContextBuilder notBeanClasses(boolean append, Object...values) {
return set(append, BEAN_notBeanClasses, values);
@@ -834,16 +770,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Add to classes that should not be considered beans.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_notBeanClasses</jsf>, values)</code>
- * or <code>property(<jsf>BEAN_notBeanClasses_add</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
* </ul>
- *
+ *
* @param values The values to add to this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_notBeanClasses
- * @see BeanContext#BEAN_notBeanClasses_add
*/
public BeanContextBuilder notBeanClasses(Class<?>...values) {
return addTo(BEAN_notBeanClasses, values);
@@ -852,16 +785,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Add to classes that should not be considered beans.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_notBeanClasses</jsf>, values)</code>
- * or <code>property(<jsf>BEAN_notBeanClasses_add</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
* </ul>
- *
+ *
* @param values The values to add to this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_notBeanClasses
- * @see BeanContext#BEAN_notBeanClasses_add
*/
public BeanContextBuilder notBeanClasses(Object...values) {
return addTo(BEAN_notBeanClasses, values);
@@ -870,16 +800,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Remove from classes that should not be considered beans.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_notBeanClasses</jsf>, values)</code>
- * or <code>property(<jsf>BEAN_notBeanClasses_remove</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
* </ul>
- *
+ *
* @param values The values to remove from this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_notBeanClasses
- * @see BeanContext#BEAN_notBeanClasses_remove
*/
public BeanContextBuilder notBeanClassesRemove(Object...values) {
return removeFrom(BEAN_notBeanClasses, values);
@@ -891,22 +818,15 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* When specified, the current list of ignore packages are appended to.
*
- * <p>
- * Any classes within these packages will be serialized to strings using {@link Object#toString()}.
- *
- * <p>
- * Note that you can specify prefix patterns to include all subpackages.
- *
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_notBeanPackages</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
* </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.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_notBeanPackages
*/
public BeanContextBuilder notBeanPackages(boolean append, Object...values) {
return set(append, BEAN_notBeanPackages, values);
@@ -915,15 +835,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Add to packages whose classes should not be considered beans.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_notBeanPackages</jsf>, values)</code>
- * or <code>property(<jsf>BEAN_notBeanPackages_add</jsf>, s)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
* </ul>
- *
+ *
* @param values The values to add to this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_notBeanPackages_add
*/
public BeanContextBuilder notBeanPackages(Object...values) {
return addTo(BEAN_notBeanPackages, values);
@@ -932,15 +850,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Add to packages whose classes should not be considered beans.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_notBeanPackages</jsf>, values)</code>
- * or <code>property(<jsf>BEAN_notBeanPackages_add</jsf>, s)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
* </ul>
- *
+ *
* @param values The values to add to this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_notBeanPackages_add
*/
public BeanContextBuilder notBeanPackages(String...values) {
return addTo(BEAN_notBeanPackages, values);
@@ -949,16 +865,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Remove from packages whose classes should not be considered beans.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_notBeanPackages</jsf>, values)</code>
- * or <code>property(<jsf>BEAN_notBeanPackages_remove</jsf>, s)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
* </ul>
- *
+ *
* @param values The values to remove from this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_notBeanPackages
- * @see BeanContext#BEAN_notBeanPackages_remove
*/
public BeanContextBuilder notBeanPackagesRemove(Object...values) {
return removeFrom(BEAN_notBeanPackages, values);
@@ -974,16 +887,15 @@ public class BeanContextBuilder extends ContextBuilder {
* <li>Implementations of {@link Surrogate}.
* </ul>
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_pojoSwaps</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
* </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.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_pojoSwaps
*/
public BeanContextBuilder pojoSwaps(boolean append, Object...values) {
return set(append, BEAN_pojoSwaps, values);
@@ -992,16 +904,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Add to POJO swaps.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_pojoSwaps</jsf>, values)</code>
- * or <code>property(<jsf>BEAN_pojoSwaps_add</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
* </ul>
- *
+ *
* @param values The values to add to this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_pojoSwaps
- * @see BeanContext#BEAN_pojoSwaps_add
*/
public BeanContextBuilder pojoSwaps(Class<?>...values) {
return addTo(BEAN_pojoSwaps, values);
@@ -1010,16 +919,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Add to POJO swaps.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_pojoSwaps</jsf>, values)</code>
- * or <code>property(<jsf>BEAN_pojoSwaps_add</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
* </ul>
- *
+ *
* @param values The values to add to this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_pojoSwaps
- * @see BeanContext#BEAN_pojoSwaps_add
*/
public BeanContextBuilder pojoSwaps(Object...values) {
return addTo(BEAN_pojoSwaps, values);
@@ -1028,16 +934,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Remove from POJO swaps.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_pojoSwaps</jsf>, values)</code>
- * or <code>property(<jsf>BEAN_pojoSwaps_remove</jsf>, values)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
* </ul>
- *
+ *
* @param values The values to remove from this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_pojoSwaps
- * @see BeanContext#BEAN_pojoSwaps_remove
*/
public BeanContextBuilder pojoSwapsRemove(Object...values) {
return removeFrom(BEAN_pojoSwaps, values);
@@ -1049,6 +952,11 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* The class to use for calculating bean property names.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_propertyNamer}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1062,22 +970,14 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order.
* Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
- * On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.
- * On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>
- * This is equivalent to calling <code>property(<jsf>BEAN_sortProperties</jsf>, value)</code>.
- * <li>
- * This property is disabled by default so that IBM JVM users don't have to use {@link Bean @Bean} annotations
- * to force bean properties to be in a particular order and can just alter the order of the fields/methods
- * in the Java file.
+ * <li class='jf'>{@link BeanContext#BEAN_sortProperties}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_sortProperties
*/
public BeanContextBuilder sortProperties(boolean value) {
return set(BEAN_sortProperties, value);
@@ -1086,14 +986,13 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: TimeZone.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_timeZone</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_timeZone}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_timeZone
*/
public BeanContextBuilder timeZone(TimeZone value) {
return set(BEAN_timeZone, value);
@@ -1106,14 +1005,13 @@ public class BeanContextBuilder extends ContextBuilder {
* 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.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_useInterfaceProxies</jsf>, value)</code>.
+ * <li class='jf'>{@link BeanContext#BEAN_useInterfaceProxies}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_useInterfaceProxies
*/
public BeanContextBuilder useInterfaceProxies(boolean value) {
return set(BEAN_useInterfaceProxies, value);
@@ -1127,13 +1025,16 @@ public class BeanContextBuilder extends ContextBuilder {
*
* <h5 class 'section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_useJavaBeanIntrospector</jsf>, value)</code>.
* <li>Most {@link Bean @Bean} annotations will be ignored if you enable this setting.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_useJavaBeanIntrospector}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see BeanContext#BEAN_useJavaBeanIntrospector
*/
public BeanContextBuilder useJavaBeanIntrospector(boolean value) {
return set(BEAN_useJavaBeanIntrospector, value);
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Visibility.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Visibility.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Visibility.java
index c9e1e47..27f4700 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Visibility.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Visibility.java
@@ -23,10 +23,10 @@ import java.lang.reflect.*;
* <p>
* Used in conjunction with the following bean context properties:
* <ul>
- * <li>{@link BeanContext#BEAN_beanConstructorVisibility}
- * <li>{@link BeanContext#BEAN_beanClassVisibility}
- * <li>{@link BeanContext#BEAN_beanFieldVisibility}
- * <li>{@link BeanContext#BEAN_methodVisibility}
+ * <li class='jf'>{@link BeanContext#BEAN_beanConstructorVisibility}
+ * <li class='jf'>{@link BeanContext#BEAN_beanClassVisibility}
+ * <li class='jf'>{@link BeanContext#BEAN_beanFieldVisibility}
+ * <li class='jf'>{@link BeanContext#BEAN_methodVisibility}
* </ul>
*/
public enum Visibility {
@@ -50,12 +50,12 @@ public enum Visibility {
* Identifies if the specified mod matches this visibility.
*
* <h5 class='section'>Example:</h5>
- * <code>
- * <jsf>PUBLIC</jsf>.isVisible(MyPublicClass.<jk>class</jk>.getModifiers()); <jc>//true</jk>
- * <jsf>PUBLIC</jsf>.isVisible(MyPrivateClass.<jk>class</jk>.getModifiers()); <jc>//false</jk>
- * <jsf>PRIVATE</jsf>.isVisible(MyPrivateClass.<jk>class</jk>.getModifiers()); <jc>//true</jk>
- * <jsf>NONE</jsf>.isVisible(MyPublicClass.<jk>class</jk>.getModifiers()); <jc>//false</jk>
- * </code>
+ * <p class='bcode'>
+ * <jsf>PUBLIC</jsf>.isVisible(MyPublicClass.<jk>class</jk>.getModifiers()); <jc>//true</jc>
+ * <jsf>PUBLIC</jsf>.isVisible(MyPrivateClass.<jk>class</jk>.getModifiers()); <jc>//false</jc>
+ * <jsf>PRIVATE</jsf>.isVisible(MyPrivateClass.<jk>class</jk>.getModifiers()); <jc>//true</jc>
+ * <jsf>NONE</jsf>.isVisible(MyPublicClass.<jk>class</jk>.getModifiers()); <jc>//false</jc>
+ * </p>
*
* @param mod The modifier from the object being tested (e.g. results from {@link Class#getModifiers()}.
* @return <jk>true</jk> if this visibility matches the specified modifier attribute.
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/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 b823a86..e00be66 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
@@ -57,13 +57,16 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>HTML_addKeyValueTableHeaders</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link HtmlSerializer#HTML_addKeyValueTableHeaders}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see HtmlSerializer#HTML_addKeyValueTableHeaders
*/
public HtmlSerializerBuilder addKeyValueTableHeaders(boolean value) {
return set(HTML_addKeyValueTableHeaders, value);
@@ -78,13 +81,16 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>HTML_detectLinksInStrings</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link HtmlSerializer#HTML_detectLinksInStrings}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see HtmlSerializer#HTML_detectLinksInStrings
*/
public HtmlSerializerBuilder detectLinksInStrings(boolean value) {
return set(HTML_detectLinksInStrings, value);
@@ -95,13 +101,16 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>HTML_labelParameter</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link HtmlSerializer#HTML_labelParameter}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see HtmlSerializer#HTML_labelParameter
*/
public HtmlSerializerBuilder labelParameter(String value) {
return set(HTML_labelParameter, value);
@@ -118,13 +127,16 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>HTML_lookForLabelParameters</jsf>, value)</code>.
* <li>This introduces a slight performance penalty.
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link HtmlSerializer#HTML_lookForLabelParameters}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see HtmlSerializer#HTML_lookForLabelParameters
*/
public HtmlSerializerBuilder lookForLabelParameters(boolean value) {
return set(HTML_lookForLabelParameters, value);
@@ -140,14 +152,13 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
* <p>
* See the {@link AnchorText} enum for possible values.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>HTML_uriAnchorText</jsf>, value)</code>.
+ * <li class='jf'>{@link HtmlSerializer#HTML_uriAnchorText}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see HtmlSerializer#HTML_uriAnchorText
*/
public HtmlSerializerBuilder uriAnchorText(AnchorText value) {
return set(HTML_uriAnchorText, value);
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
index 9454356..49675a8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
@@ -17,6 +17,7 @@ import java.util.*;
import org.apache.juneau.*;
import org.apache.juneau.http.*;
import org.apache.juneau.serializer.*;
+import org.apache.juneau.uon.*;
/**
* Builder class for building instances of {@link SimpleUonPartSerializer}.
@@ -50,20 +51,20 @@ public class SimpleUonPartSerializerBuilder extends UonPartSerializerBuilder {
//--------------------------------------------------------------------------------
@Override /* UonPartSerializerBuilder */
- public SimpleUonPartSerializerBuilder paramFormat(String value) {
+ public SimpleUonPartSerializerBuilder paramFormat(ParamFormat value) {
super.paramFormat(value);
return this;
}
@Override /* UonPartSerializerBuilder */
- public SimpleUonPartSerializerBuilder plainTextParams() {
- super.plainTextParams();
+ public SimpleUonPartSerializerBuilder paramFormatPlain() {
+ super.paramFormatPlain();
return this;
}
@Override /* UonSerializerBuilder */
- public SimpleUonPartSerializerBuilder encodeChars(boolean value) {
- super.encodeChars(value);
+ public SimpleUonPartSerializerBuilder encoding(boolean value) {
+ super.encoding(value);
return this;
}
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
index 8d13857..2d25ff8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
@@ -53,8 +53,8 @@ public class UonPartParserBuilder extends UonParserBuilder {
//--------------------------------------------------------------------------------
@Override /* UonParserBuilder */
- public UonPartParserBuilder decodeChars(boolean value) {
- return set(UON_decodeChars, value);
+ public UonPartParserBuilder decoding(boolean value) {
+ return set(UON_decoding, value);
}
@Override /* ParserBuilder */
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
index fd85c76..dec921a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
@@ -48,7 +48,7 @@ public class UonPartSerializer extends UonSerializer implements HttpPartSerializ
public UonPartSerializer(PropertyStore ps) {
super(
ps.builder()
- .set(UON_encodeChars, false)
+ .set(UON_encoding, false)
.build()
);
}
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
index cb50074..c9aecae 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
@@ -12,8 +12,6 @@
// ***************************************************************************************************************************
package org.apache.juneau.httppart;
-import static org.apache.juneau.uon.UonSerializer.*;
-
import java.util.*;
import org.apache.juneau.*;
@@ -52,55 +50,27 @@ public class UonPartSerializerBuilder extends UonSerializerBuilder {
// Properties
//--------------------------------------------------------------------------------
- /**
- * Configuration property: Format to use for top-level query names and simple parameters.
- *
- * <p>
- * Specifies the format to use for URL GET parameter keys and values.
- *
- * <p>
- * The possible values are:
- * <ul class='spaced-list'>
- * <li>
- * <js>"UON"</js> (default) - Use UON notation for values.
- * <br>String values such as <js>"(foo='bar')"</js> will end up being quoted and escaped to <js>"'(foo=bar~'baz~')'"</js>.
- * <br>Similarly, boolean and numeric values will also end up quoted.
- * <li>
- * <js>"PLAINTEXT"</js> (default) - Serialize as plain text.
- * <br>Strings will never be quoted or escaped.
- * <br>Note that this can cause errors during parsing if you're using the URL-encoding parser to parse
- * the results since UON constructs won't be differentiable.
- * <br>However, this is not an issue if you're simply creating queries or form posts against 3rd-party interfaces.
- * </ul>
- *
- * @param paramFormat The new value for this property.
- * @return This object (for method chaining).
- * @see UonSerializer#UON_paramFormat
- */
- public UonPartSerializerBuilder paramFormat(String paramFormat) {
- return set(UON_paramFormat, paramFormat);
+ @Override /* UonSerializerBuilder */
+ public UonPartSerializerBuilder encoding(boolean value) {
+ super.encoding(value);
+ return this;
}
- /**
- * Shortcut for calling <code>paramFormat(<js>"PLAINTEXT"</js>)</code>.
- *
- * @return This object (for method chaining).
- * @see UonSerializer#UON_paramFormat
- */
- public UonPartSerializerBuilder plainTextParams() {
- return paramFormat("PLAINTEXT");
+ @Override /* UonSerializerBuilder */
+ public UonPartSerializerBuilder encoding() {
+ super.encoding();
+ return this;
}
@Override /* UonSerializerBuilder */
- public UonPartSerializerBuilder encodeChars(boolean value) {
- super.encodeChars(value);
+ public UonPartSerializerBuilder paramFormat(ParamFormat paramFormat) {
+ super.paramFormat(paramFormat);
return this;
}
@Override /* UonSerializerBuilder */
- public UonPartSerializerBuilder encoding() {
- super.encoding();
- return this;
+ public UonPartSerializerBuilder paramFormatPlain() {
+ return paramFormat(ParamFormat.PLAINTEXT);
}
@Override /* SerializerBuilder */
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
index 2101fd4..d2c4928 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
@@ -60,14 +60,13 @@ public class JsonSerializerBuilder extends SerializerBuilder {
* However, if you're embedding JSON in an HTML script tag, this setting prevents confusion when trying to
* serialize <xt><\/script></xt>.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>JSON_escapeSolidus</jsf>, value)</code>.
+ * <li class='jf'>{@link JsonSerializer#JSON_escapeSolidus}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see JsonSerializer#JSON_escapeSolidus
*/
public JsonSerializerBuilder escapeSolidus(boolean value) {
return set(JSON_escapeSolidus, value);
@@ -76,6 +75,11 @@ public class JsonSerializerBuilder extends SerializerBuilder {
/**
* Shortcut for calling <code>setSimpleMode(<jk>true</jk>).sq()</code>.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link JsonSerializer#JSON_simpleMode}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public JsonSerializerBuilder simple() {
@@ -89,14 +93,13 @@ public class JsonSerializerBuilder extends SerializerBuilder {
* If <jk>true</jk>, JSON attribute names will only be quoted when necessary.
* Otherwise, they are always quoted.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>JSON_simpleMode</jsf>, value)</code>.
+ * <li class='jf'>{@link JsonSerializer#JSON_simpleMode}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see JsonSerializer#JSON_simpleMode
*/
public JsonSerializerBuilder simple(boolean value) {
return set(JSON_simpleMode, value);
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
index 411239a..9f94bbf 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
@@ -57,14 +57,13 @@ public class ParserBuilder extends BeanContextBuilder {
* <p>
* <js>"default"</js> can be used to indicate the JVM default file system charset.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>PARSER_fileCharset</jsf>,value)</code>.
+ * <li class='jf'>{@link Parser#PARSER_fileCharset}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Parser#PARSER_fileCharset
*/
public ParserBuilder fileCharset(String value) {
return set(PARSER_fileCharset, value);
@@ -79,14 +78,13 @@ public class ParserBuilder extends BeanContextBuilder {
* <p>
* Used when passing in input streams and byte arrays to {@link Parser#parse(Object, Class)}.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>PARSER_inputStreamCharset</jsf>, value)</code>.
+ * <li class='jf'>{@link Parser#PARSER_inputStreamCharset}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Parser#PARSER_inputStreamCharset
*/
public ParserBuilder inputStreamCharset(String value) {
return set(PARSER_inputStreamCharset, value);
@@ -98,9 +96,13 @@ public class ParserBuilder extends BeanContextBuilder {
* <p>
* Class used to listen for errors and warnings that occur during parsing.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Parser#PARSER_listener}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Parser#PARSER_listener
*/
public ParserBuilder listener(Class<? extends ParserListener> value) {
return set(PARSER_listener, value);
@@ -109,6 +111,11 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Shortcut for calling <code>strict(<jk>true</jk>)</code>.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Parser#PARSER_strict}
+ * </ul>
+ *
* @return This object (for method chaining).
*/
public ParserBuilder strict() {
@@ -149,14 +156,13 @@ public class ParserBuilder extends BeanContextBuilder {
* </tr>
* </table>
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>PARSER_strict</jsf>,value)</code>.
+ * <li class='jf'>{@link Parser#PARSER_strict}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Parser#PARSER_strict
*/
public ParserBuilder strict(boolean value) {
return set(PARSER_strict, value);
@@ -169,14 +175,13 @@ public class ParserBuilder extends BeanContextBuilder {
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
*
- * <h5 class='section'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>PARSER_trimStrings</jsf>, value)</code>.
+ * <li class='jf'>{@link Parser#PARSER_trimStrings}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Parser#PARSER_trimStrings
*/
public ParserBuilder trimStrings(boolean value) {
return set(PARSER_trimStrings, value);