You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2018/01/14 16:02:51 UTC
[23/32] juneau git commit: Javadoc updates.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/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 ae50c93..52ef3d2 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
@@ -30,7 +30,7 @@ import org.apache.juneau.transform.*;
/**
* Core class of the Juneau architecture.
- *
+ *
* <p>
* This class servers multiple purposes:
* <ul class='spaced-list'>
@@ -40,15 +40,16 @@ import org.apache.juneau.transform.*;
* Serves as a repository for metadata on POJOs, such as associated {@link BeanFilter BeanFilters},
* {@link PropertyNamer PropertyNamers}, etc... which are used to tailor how POJOs are serialized and parsed.
* </ul>
- *
+ *
* <p>
* All serializers and parsers extend from this context so that they can handle POJOs using a common framework.
- *
+ *
+ *
* <h5 class='topic'>Bean Contexts</h5>
- *
+ *
* Bean contexts are created through the {@link BeanContext#create() BeanContext.create()} and {@link BeanContextBuilder#build()} methods.
* <br>These context objects are read-only, reusable, and thread-safe.
- *
+ *
* <p>
* Each bean context maintains a cache of {@link ClassMeta} objects that describe information about classes encountered.
* These <code>ClassMeta</code> objects are time-consuming to construct.
@@ -56,39 +57,41 @@ import org.apache.juneau.transform.*;
* the same cache. This allows for efficient reuse of <code>ClassMeta</code> objects so that the information about
* classes only needs to be calculated once.
* Because of this, many of the properties defined on the {@link BeanContext} class cannot be overridden on the session.
- *
+ *
+ *
* <h5 class='topic'>Bean Sessions</h5>
- *
+ *
* Whereas <code>BeanContext</code> objects are permanent, unchangeable, cached, and thread-safe,
* {@link BeanSession} objects are ephemeral and not thread-safe.
* They are meant to be used as quickly-constructed scratchpads for creating bean maps.
* {@link BeanMap} objects can only be created through the session.
- *
+ *
+ *
* <h5 class='topic'>BeanContext configuration properties</h5>
- *
+ *
* <code>BeanContexts</code> have several configuration properties that can be used to tweak behavior on how beans are
* handled. These are denoted as the static <jsf>BEAN_*</jsf> fields on this class.
- *
+ *
* <p>
* Some settings (e.g. {@link #BEAN_beansRequireDefaultConstructor}) are used to differentiate between bean
* and non-bean classes.
* Attempting to create a bean map around one of these objects will throw a {@link BeanRuntimeException}.
* The purpose for this behavior is so that the serializers can identify these non-bean classes and convert them to
* plain strings using the {@link Object#toString()} method.
- *
+ *
* <p>
* Some settings (e.g. {@link #BEAN_beanFieldVisibility}) are used to determine what kinds of properties are
* detected on beans.
- *
+ *
* <p>
* Some settings (e.g. {@link #BEAN_beanMapPutReturnsOldValue}) change the runtime behavior of bean maps.
- *
+ *
* <p>
* Settings are specified using the {@link BeanContextBuilder#set(String, Object)} method and related convenience
* methods.
- *
+ *
* <h5 class='section'>Example:</h5>
- *
+ *
* <p class='bcode'>
* <jc>// Construct a context from scratch.</jc>
* BeanContext beanContext = BeanContext
@@ -97,12 +100,13 @@ import org.apache.juneau.transform.*;
* .notBeanClasses(Foo.<jk>class</jk>)
* .build();
* </p>
- *
+ *
+ *
* <h5 class='topic'>Bean Maps</h5>
- *
+ *
* {@link BeanMap BeanMaps} are wrappers around Java beans that allow properties to be retrieved and
* set using the common {@link Map#put(Object,Object)} and {@link Map#get(Object)} methods.
- *
+ *
* <p>
* Bean maps are created in two ways...
* <ol>
@@ -111,9 +115,9 @@ import org.apache.juneau.transform.*;
* <li>{@link BeanSession#newBeanMap(Class) BeanSession.newBeanMap()} - Create a new bean instance wrapped in a
* {@code Map} wrapper.
* </ol>
- *
+ *
* <h5 class='section'>Example:</h5>
- *
+ *
* <p class='bcode'>
* <jc>// A sample bean class</jc>
* <jk>public class</jk> Person {
@@ -122,26 +126,27 @@ import org.apache.juneau.transform.*;
* <jk>public int</jk> getAge();
* <jk>public void</jk> setAge(<jk>int</jk> age);
* }
- *
+ *
* <jc>// Create a new bean session</jc>
* BeanSession session = BeanContext.<jsf>DEFAULT</jsf>.createSession();
- *
+ *
* <jc>// Wrap an existing bean in a new bean map</jc>
* BeanMap<Person> m1 = session.toBeanMap(<jk>new</jk> Person());
* m1.put(<js>"name"</js>, <js>"John Smith"</js>);
* m1.put(<js>"age"</js>, 45);
- *
+ *
* <jc>// Create a new bean instance wrapped in a new bean map</jc>
* BeanMap<Person> m2 = session.newBeanMap(Person.<jk>class</jk>);
* m2.put(<js>"name"</js>, <js>"John Smith"</js>);
* m2.put(<js>"age"</js>, 45);
* Person p = m2.getBean(); <jc>// Get the bean instance that was created.</jc>
* </p>
- *
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.ContextsBuildersSessionsPropertyStores">Overview > Contexts, Builders, Sessions, and PropertyStores</a>
- * </ul>
+ *
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.ContextsBuildersSessionsPropertyStores">Overview > Contexts, Builders, Sessions, and PropertyStores</a>
+ * </ul>
*/
@SuppressWarnings({"unchecked","rawtypes"})
public class BeanContext extends Context {
@@ -191,7 +196,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Minimum bean constructor visibility.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanConstructorVisibility.s"</js>
@@ -232,7 +237,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean dictionary.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanDictionary.lc"</js>
@@ -276,7 +281,7 @@ public class BeanContext extends Context {
* <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'>
* <jc>// Create a parser and tell it which classes to try to resolve.</jc>
@@ -323,7 +328,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Minimum bean field visibility.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFieldVisibility.s"</js>
@@ -335,7 +340,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beanFieldVisibility(Visibility)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Only look for bean fields with the specified minimum visibility.
@@ -370,7 +375,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean filters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFilters.lc"</js>
@@ -385,13 +390,13 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beanFiltersRemove(Object...)}
* </ul>
* </ul>
- *
+ *
* <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
* the bean classes.
- *
+ *
* <p>
* Values can consist of any of the following types:
* <ul class='spaced-list'>
@@ -448,7 +453,7 @@ public class BeanContext extends Context {
/**
* Configuration property: BeanMap.put() returns old property value.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMapPutReturnsOldValue.b"</js>
@@ -461,9 +466,9 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beanMapPutReturnsOldValue()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
- *
+ *
* <p>
* If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
* values.
@@ -495,7 +500,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Minimum bean method visibility.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMethodVisibility.s"</js>
@@ -507,7 +512,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beanMethodVisibility(Visibility)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Only look for bean methods with the specified minimum visibility.
@@ -536,7 +541,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Beans require no-arg constructors.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireDefaultConstructor.b"</js>
@@ -549,12 +554,12 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beansRequireDefaultConstructor()}
* </ul>
* </ul>
- *
+ *
* <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.
- *
+ *
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*
@@ -577,7 +582,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Beans require Serializable interface.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSerializable.b"</js>
@@ -590,12 +595,12 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beansRequireSerializable()}
* </ul>
* </ul>
- *
+ *
* <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.
- *
+ *
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*
@@ -618,7 +623,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Beans require setters for getters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSettersForGetters.b"</js>
@@ -631,7 +636,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beansRequireSettersForGetters()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean.
@@ -656,7 +661,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Beans require at least one property.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSomeProperties.b"</js>
@@ -668,12 +673,12 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beansRequireSomeProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <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.
- *
+ *
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*
@@ -696,7 +701,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean type property name.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanTypePropertyName.s"</js>
@@ -731,7 +736,7 @@ public class BeanContext extends Context {
* .set(<jsf>BEAN_beanTypePropertyName</jsf>, <js>"type"</js>)
* .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>
@@ -741,7 +746,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Debug mode.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.debug.b"</js>
@@ -754,7 +759,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#debug()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Enables the following additional information during serialization:
@@ -765,7 +770,7 @@ public class BeanContext extends Context {
* <li>
* Enables {@link Serializer#SERIALIZER_detectRecursions}.
* </ul>
- *
+ *
* <p>
* Enables the following additional information during parsing:
* <ul class='spaced-list'>
@@ -793,7 +798,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean property excludes.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.excludeProperties.sms"</js>
@@ -812,20 +817,20 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanFilterBuilder#excludeProperties(String...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies to exclude the specified list of properties for the specified bean class.
- *
+ *
* <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 any beans whose simple class name is <code>Bean1</code>.
- *
+ *
* <p>
* Setting applies to specified class and all subclasses.
*
@@ -854,7 +859,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Ignore invocation errors on getters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnGetters.b"</js>
@@ -867,7 +872,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#ignoreInvocationExceptionsOnGetters()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.
@@ -892,7 +897,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Ignore invocation errors on setters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnSetters.b"</js>
@@ -905,7 +910,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#ignoreInvocationExceptionsOnSetters()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.
@@ -930,7 +935,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Ignore properties without setters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignorePropertiesWithoutSetters.b"</js>
@@ -942,7 +947,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#ignorePropertiesWithoutSetters(boolean)}
* </ul>
* </ul>
- *
+ *
* <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.
@@ -967,7 +972,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Ignore unknown properties.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownBeanProperties.b"</js>
@@ -980,7 +985,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#ignoreUnknownBeanProperties()}
* </ul>
* </ul>
- *
+ *
* <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.
@@ -1005,7 +1010,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Ignore unknown properties with null values.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownNullBeanProperties.b"</js>
@@ -1017,7 +1022,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#ignoreUnknownNullBeanProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <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.
@@ -1042,7 +1047,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Implementation classes.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.implClasses.smc"</js>
@@ -1055,7 +1060,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#implClass(Class, Class)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* For interfaces and abstract classes this method can be used to specify an implementation class for the
@@ -1081,7 +1086,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean property includes.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.properties.sms"</js>
@@ -1101,20 +1106,20 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanFilterBuilder#properties(String...)}
* </ul>
* </ul>
- *
+ *
* <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.
* 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.
- *
+ *
* <p>
* Setting applies to specified class and all subclasses.
*
@@ -1143,7 +1148,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Locale.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.locale.s"</js>
@@ -1182,7 +1187,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Media type.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.mediaType.s"</js>
@@ -1195,7 +1200,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanSessionArgs#mediaType(MediaType)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies a default media type value for serializer and parser sessions.
@@ -1225,7 +1230,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean class exclusions.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanClasses.sc"</js>
@@ -1244,7 +1249,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#notBeanClassesRemove(Object...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* List of classes that should not be treated as beans even if they appear to be bean-like.
@@ -1286,7 +1291,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean package exclusions.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanPackages.ss"</js>
@@ -1311,14 +1316,14 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#notBeanPackagesRemove(Object...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <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 suffix patterns to include all subpackages.
*
@@ -1359,7 +1364,7 @@ public class BeanContext extends Context {
/**
* Configuration property: POJO swaps.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.pojoSwaps.lc"</js>
@@ -1379,7 +1384,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#pojoSwapsRemove(Object...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* POJO swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization,
@@ -1473,7 +1478,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean property namer.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.propertyNamer.c"</js>
@@ -1523,7 +1528,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Sort bean properties.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.sortProperties.b"</js>
@@ -1542,14 +1547,14 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanFilterBuilder#sortProperties()}
* </ul>
* </ul>
- *
+ *
* <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.
* <br>On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.
* <br>On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).
- *
+ *
* <p>
* 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
@@ -1574,7 +1579,7 @@ public class BeanContext extends Context {
/**
* Configuration property: TimeZone.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.timeZone.s"</js>
@@ -1587,7 +1592,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanSessionArgs#timeZone(TimeZone)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a serializer that uses GMT if the timezone is not specified in the session args.</jc>
@@ -1613,7 +1618,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Use interface proxies.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useInterfaceProxies.b"</js>
@@ -1625,7 +1630,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#useInterfaceProxies(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an
@@ -1651,7 +1656,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Use Java Introspector.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useJavaBeanIntrospector.b"</js>
@@ -1664,7 +1669,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#useJavaBeanIntrospector()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
@@ -1776,10 +1781,10 @@ public class BeanContext extends Context {
/**
* Constructor.
- *
+ *
* <p>
* Typically only called from {@link ContextBuilder#build(Class)} method.
- *
+ *
* @param ps The property store containing the unmodifiable configuration for this bean context.
*/
public BeanContext(PropertyStore ps) {
@@ -1895,11 +1900,11 @@ public class BeanContext extends Context {
/**
* Create a new bean session based on the properties defined on this context.
- *
+ *
* <p>
* Use this method for creating sessions if you don't need to override any
* properties or locale/timezone currently set on this context.
- *
+ *
* @return A new session object.
*/
@Override /* Context */
@@ -1910,7 +1915,7 @@ public class BeanContext extends Context {
/**
* Create a new bean session based on the properties defined on this context combined with the specified
* runtime args.
- *
+ *
* <p>
* Use this method for creating sessions if you don't need to override any
* properties or locale/timezone currently set on this context.
@@ -1966,10 +1971,10 @@ public class BeanContext extends Context {
/**
* Returns <jk>true</jk> if the specified bean context shares the same cache as this bean context.
- *
+ *
* <p>
* Useful for testing purposes.
- *
+ *
* @param bc The bean context to compare to.
* @return <jk>true</jk> if the bean contexts have equivalent settings and thus share caches.
*/
@@ -1980,7 +1985,7 @@ public class BeanContext extends Context {
/**
* Determines whether the specified class is ignored as a bean class based on the various exclusion parameters
* specified on this context class.
- *
+ *
* @param c The class type being tested.
* @return <jk>true</jk> if the specified class matches any of the exclusion parameters.
*/
@@ -2004,7 +2009,7 @@ public class BeanContext extends Context {
/**
* Returns <jk>true</jk> if the specified object is a bean.
- *
+ *
* @param o The object to test.
* @return <jk>true</jk> if the specified object is a bean. <jk>false</jk> if the bean is <jk>null</jk>.
*/
@@ -2030,7 +2035,7 @@ public class BeanContext extends Context {
/**
* Returns the {@link BeanMeta} class for the specified class.
- *
+ *
* @param <T> The class type to get the meta-data on.
* @param c The class to get the meta-data on.
* @return
@@ -2045,7 +2050,7 @@ public class BeanContext extends Context {
/**
* Construct a {@code ClassMeta} wrapper around a {@link Class} object.
- *
+ *
* @param <T> The class type being wrapped.
* @param type The class to resolve.
* @return
@@ -2058,7 +2063,7 @@ public class BeanContext extends Context {
/**
* Construct a {@code ClassMeta} wrapper around a {@link Class} object.
- *
+ *
* @param <T> The class type being wrapped.
* @param type The class to resolve.
* @param waitForInit
@@ -2097,16 +2102,16 @@ public class BeanContext extends Context {
/**
* Used to resolve <code>ClassMetas</code> of type <code>Collection</code> and <code>Map</code> that have
* <code>ClassMeta</code> values that themselves could be collections or maps.
- *
+ *
* <p>
* <code>Collection</code> meta objects are assumed to be followed by zero or one meta objects indicating the element type.
- *
+ *
* <p>
* <code>Map</code> meta objects are assumed to be followed by zero or two meta objects indicating the key and value types.
- *
+ *
* <p>
* The array can be arbitrarily long to indicate arbitrarily complex data structures.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <ul>
* <li><code>getClassMeta(String.<jk>class</jk>);</code> - A normal type.
@@ -2122,7 +2127,7 @@ public class BeanContext extends Context {
* <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);</code> -
* A map containing string keys and values of lists containing beans.
* </ul>
- *
+ *
* @param type
* The class to resolve.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
@@ -2313,7 +2318,7 @@ public class BeanContext extends Context {
/**
* Shortcut for calling {@code getClassMeta(o.getClass())}.
- *
+ *
* @param <T> The class of the object being passed in.
* @param o The class to find the class type for.
* @return The ClassMeta object, or <jk>null</jk> if {@code o} is <jk>null</jk>.
@@ -2327,7 +2332,7 @@ public class BeanContext extends Context {
/**
* Used for determining the class type on a method or field where a {@code @BeanProperty} annotation may be present.
- *
+ *
* @param <T> The class type we're wrapping.
* @param p The property annotation on the type if there is one.
* @param t The type.
@@ -2386,7 +2391,7 @@ public class BeanContext extends Context {
/**
* Returns the {@link PojoSwap} associated with the specified class, or <jk>null</jk> if there is no POJO swap
* associated with the class.
- *
+ *
* @param <T> The class associated with the swap.
* @param c The class associated with the swap.
* @return The swap associated with the class, or null if there is no association.
@@ -2405,7 +2410,7 @@ public class BeanContext extends Context {
/**
* Checks whether a class has a {@link PojoSwap} associated with it in this bean context.
- *
+ *
* @param c The class to check.
* @return <jk>true</jk> if the specified class or one of its subclasses has a {@link PojoSwap} associated with it.
*/
@@ -2426,7 +2431,7 @@ public class BeanContext extends Context {
/**
* Returns the {@link BeanFilter} associated with the specified class, or <jk>null</jk> if there is no bean filter
* associated with the class.
- *
+ *
* @param <T> The class associated with the bean filter.
* @param c The class associated with the bean filter.
* @return The bean filter associated with the class, or null if there is no association.
@@ -2441,7 +2446,7 @@ public class BeanContext extends Context {
/**
* Returns the type property name as defined by {@link #BEAN_beanTypePropertyName}.
- *
+ *
* @return The type property name. Never <jk>null</jk>.
*/
protected final String getBeanTypePropertyName() {
@@ -2450,7 +2455,7 @@ public class BeanContext extends Context {
/**
* Returns the bean registry defined in this bean context defined by {@link #BEAN_beanDictionary}.
- *
+ *
* @return The bean registry defined in this bean context. Never <jk>null</jk>.
*/
protected final BeanRegistry getBeanRegistry() {
@@ -2459,7 +2464,7 @@ public class BeanContext extends Context {
/**
* Gets the no-arg constructor for the specified class.
- *
+ *
* @param <T> The class to check.
* @param c The class to check.
* @param v The minimum visibility for the constructor.
@@ -2503,7 +2508,7 @@ public class BeanContext extends Context {
/**
* Returns the {@link #BEAN_includeProperties} setting for the specified class.
- *
+ *
* @param c The class.
* @return The properties to include for the specified class, or <jk>null</jk> if it's not defined for the class.
*/
@@ -2525,7 +2530,7 @@ public class BeanContext extends Context {
/**
* Returns the {@link #BEAN_excludeProperties} setting for the specified class.
- *
+ *
* @param c The class.
* @return The properties to exclude for the specified class, or <jk>null</jk> if it's not defined for the class.
*/
@@ -2547,7 +2552,7 @@ public class BeanContext extends Context {
/**
* Creates an instance of the specified class.
- *
+ *
* @param c
* The class to cast to.
* @param c2
@@ -2564,7 +2569,7 @@ public class BeanContext extends Context {
/**
* Creates an instance of the specified class.
- *
+ *
* @param c
* The class to cast to.
* @param c2
@@ -2613,14 +2618,14 @@ public class BeanContext extends Context {
/**
* Returns a reusable {@link ClassMeta} representation for the class <code>Object</code>.
- *
+ *
* <p>
* This <code>ClassMeta</code> is often used to represent "any object type" when an object type is not known.
- *
+ *
* <p>
* This method is identical to calling <code>getClassMeta(Object.<jk>class</jk>)</code> but uses a cached copy to
* avoid a hashmap lookup.
- *
+ *
* @return The {@link ClassMeta} object associated with the <code>Object</code> class.
*/
protected final ClassMeta<Object> object() {
@@ -2629,14 +2634,14 @@ public class BeanContext extends Context {
/**
* Returns a reusable {@link ClassMeta} representation for the class <code>String</code>.
- *
+ *
* <p>
* This <code>ClassMeta</code> is often used to represent key types in maps.
- *
+ *
* <p>
* This method is identical to calling <code>getClassMeta(String.<jk>class</jk>)</code> but uses a cached copy to
* avoid a hashmap lookup.
- *
+ *
* @return The {@link ClassMeta} object associated with the <code>String</code> class.
*/
protected final ClassMeta<String> string() {
@@ -2645,14 +2650,14 @@ public class BeanContext extends Context {
/**
* Returns a reusable {@link ClassMeta} representation for the class <code>Class</code>.
- *
+ *
* <p>
* This <code>ClassMeta</code> is often used to represent key types in maps.
- *
+ *
* <p>
* This method is identical to calling <code>getClassMeta(Class.<jk>class</jk>)</code> but uses a cached copy to
* avoid a hashmap lookup.
- *
+ *
* @return The {@link ClassMeta} object associated with the <code>String</code> class.
*/
protected final ClassMeta<Class> _class() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/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 bf815bf..d5f54ed 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
@@ -53,10 +53,11 @@ import org.apache.juneau.transform.*;
* .build(); <jc>// Create a JsonSerializer</jc>
* </p>
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.ConfigurableProperties">Overview > Configurable Properties</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.ConfigurableProperties">Overview > Configurable Properties</a>
+ * </ul>
*/
public class BeanContextBuilder extends ContextBuilder {
@@ -71,7 +72,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public BeanContextBuilder(PropertyStore ps) {
@@ -89,14 +90,14 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Minimum bean class visibility.
- *
+ *
* <p>
* Classes are not considered beans unless they meet the minimum visibility requirements.
*
* <p>
* 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 and will be treated as a string.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanClassVisibility}
@@ -113,10 +114,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Minimum bean constructor visibility.
- *
+ *
* <p>
* Only look for constructors with the specified minimum visibility.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanConstructorVisibility}
@@ -133,7 +134,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean dictionary.
- *
+ *
* <p>
* Adds to the list of classes that make up the bean dictionary in this bean context.
*
@@ -152,10 +153,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean dictionary.
- *
+ *
* <p>
* Same as {@link #beanDictionary(Object...)} but takes in an array of classes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanDictionary}
@@ -195,7 +196,7 @@ public class BeanContextBuilder extends ContextBuilder {
*
* <p>
* Removes from the list of classes that make up the bean dictionary in this bean context.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanDictionary}
@@ -211,7 +212,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Minimum bean field visibility.
- *
+ *
* <p>
* Only look for bean fields with the specified minimum visibility.
*
@@ -231,12 +232,12 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean filters.
- *
+ *
* <p>
* This is a programmatic equivalent to the {@link Bean @Bean} annotation.
* <br>It's useful when you want to use the Bean annotation functionality, but you don't have the ability to alter
* the bean classes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanFilters}
@@ -262,7 +263,7 @@ 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}
@@ -281,7 +282,7 @@ public class BeanContextBuilder extends ContextBuilder {
*
* <p>
* Same as {@link #beanFilters(Object...)} but allows you to optionally overwrite the previous value.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanFilters}
@@ -306,10 +307,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean filters.
- *
+ *
* <p>
* Removes from the list of classes that make up the bean filters in this bean context.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanFilters}
@@ -332,12 +333,12 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: BeanMap.put() returns old property value.
- *
+ *
* <p>
* If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
* values.
* <br>Otherwise, it returns <jk>null</jk>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanMapPutReturnsOldValue}
@@ -354,10 +355,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: BeanMap.put() returns old property value.
- *
+ *
* <p>
* Shortcut for calling <code>beanMapPutReturnsOldValue(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanMapPutReturnsOldValue}
@@ -371,7 +372,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Minimum bean method visibility.
- *
+ *
* <p>
* Only look for bean methods with the specified minimum visibility.
*
@@ -391,11 +392,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require no-arg constructors.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireDefaultConstructor}
@@ -412,10 +413,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require no-arg constructors.
- *
+ *
* <p>
* Shortcut for calling <code>beansRequireDefaultConstructor(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireDefaultConstructor}
@@ -429,11 +430,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require Serializable interface.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireSerializable}
@@ -450,10 +451,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require Serializable interface.
- *
+ *
* <p>
* Shortcut for calling <code>beansRequireSerializable(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireSerializable}
@@ -467,11 +468,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require setters for getters.
- *
+ *
* <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'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireSettersForGetters}
@@ -488,10 +489,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require setters for getters.
- *
+ *
* <p>
* Shortcut for calling <code>beansRequireSettersForGetters(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireSettersForGetters}
@@ -505,11 +506,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require at least one property.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireSomeProperties}
@@ -526,7 +527,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean type property name.
- *
+ *
* <p>
* 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.
@@ -547,7 +548,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Debug mode.
- *
+ *
* <p>
* Enables the following additional information during serialization:
* <ul class='spaced-list'>
@@ -557,7 +558,7 @@ public class BeanContextBuilder extends ContextBuilder {
* <li>
* Enables {@link Serializer#SERIALIZER_detectRecursions}.
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_debug}
@@ -574,10 +575,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Debug mode.
- *
+ *
* <p>
* Shortcut for calling <code>debug(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_debug}
@@ -591,7 +592,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property excludes.
- *
+ *
* <p>
* Specifies to exclude the specified list of properties for the specified bean class.
*
@@ -610,10 +611,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property excludes.
- *
+ *
* <p>
* Specifies to exclude the specified list of properties for the specified bean classes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_excludeProperties}
@@ -629,7 +630,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property excludes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_excludeProperties}
@@ -647,11 +648,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore invocation errors on getters.
- *
+ *
* <p>
* If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreInvocationExceptionsOnGetters}
@@ -668,10 +669,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore invocation errors on getters.
- *
+ *
* <p>
* Shortcut for calling <code>ignoreInvocationExceptionsOnGetters(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreInvocationExceptionsOnGetters}
@@ -685,11 +686,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore invocation errors on setters.
- *
+ *
* <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'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreInvocationExceptionsOnSetters}
@@ -706,10 +707,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore invocation errors on setters.
- *
+ *
* <p>
* Shortcut for calling <code>ignoreInvocationExceptionsOnSetters(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreInvocationExceptionsOnSetters}
@@ -723,11 +724,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore properties without setters.
- *
+ *
* <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 BeanRuntimeException} is thrown.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignorePropertiesWithoutSetters}
@@ -744,11 +745,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore unknown properties.
- *
+ *
* <p>
* If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored.
* <br>Otherwise, a {@code BeanRuntimeException} is thrown.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreUnknownBeanProperties}
@@ -765,10 +766,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore unknown properties.
- *
+ *
* <p>
* Shortcut for calling <code>ignoreUnknownBeanProperties(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreUnknownBeanProperties}
@@ -782,11 +783,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore unknown properties with null values.
- *
+ *
* <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 BeanRuntimeException} is thrown.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreUnknownNullBeanProperties}
@@ -803,7 +804,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Implementation classes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_implClasses}
@@ -820,12 +821,12 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Implementation classes.
- *
+ *
* <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'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_implClasses}
@@ -840,7 +841,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property includes.
- *
+ *
* <p>
* Specifies the set and order of names of properties associated with the bean class.
*
@@ -859,10 +860,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property includes.
- *
+ *
* <p>
* Specifies the set and order of names of properties associated with the bean class.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_includeProperties}
@@ -877,7 +878,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property includes.
- *
+ *
* <p>
* Specifies the set and order of names of properties associated with the bean class.
*
@@ -898,10 +899,10 @@ 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}
@@ -916,10 +917,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Media type.
- *
+ *
* <p>
* Specifies a default media type value for serializer and parser sessions.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_mediaType}
@@ -934,11 +935,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean class exclusions.
- *
+ *
* <p>
* 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>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
@@ -985,7 +986,7 @@ public class BeanContextBuilder extends ContextBuilder {
* <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}
@@ -1006,7 +1007,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean class exclusions.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
@@ -1027,10 +1028,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean package exclusions.
- *
+ *
* <p>
* When specified, the current list of ignore packages are appended to.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
@@ -1054,7 +1055,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean package exclusions.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
@@ -1075,7 +1076,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean package exclusions.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
@@ -1091,7 +1092,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean package exclusions.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
@@ -1112,14 +1113,14 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: POJO swaps.
- *
+ *
* <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.
*
* <p>
* An example of a POJO swap would be a <code>Calendar</code> object that gets swapped out for an ISO8601 string.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
@@ -1143,7 +1144,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: POJO swaps.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
@@ -1158,7 +1159,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: POJO swaps.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
@@ -1180,7 +1181,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: POJO swaps.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
@@ -1202,7 +1203,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property namer
- *
+ *
* <p>
* The class to use for calculating bean property names.
*
@@ -1222,11 +1223,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Sort bean properties.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_sortProperties}
@@ -1243,10 +1244,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Sort bean properties.
- *
+ *
* <p>
* Shortcut for calling <code>sortProperties(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_sortProperties}
@@ -1260,7 +1261,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: TimeZone.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_timeZone}
@@ -1275,11 +1276,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Use interface proxies.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_useInterfaceProxies}
@@ -1296,15 +1297,15 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Use Java Introspector.
- *
+ *
* <p>
* Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
- *
+ *
* <h5 class 'section'>Notes:</h5>
* <ul>
* <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}
@@ -1321,10 +1322,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Use Java Introspector.
- *
+ *
* <p>
* Shortcut for calling <code>useJavaBeanIntrospector(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_useJavaBeanIntrospector}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryList.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryList.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryList.java
index b1b771a..997e043 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryList.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryList.java
@@ -18,7 +18,7 @@ import org.apache.juneau.annotation.*;
/**
* Represents a collection of bean classes that make up a bean dictionary.
- *
+ *
* <p>
* The classes in the list must be one of the following:
* <ul>
@@ -44,7 +44,7 @@ import org.apache.juneau.annotation.*;
* .beanDictionary(MyBeanDictionaryList.<jk>class</jk>)
* .build();
* </p>
- *
+ *
* <p>
* Subclasses must implement a public no-arg constructor so that it can be instantiated by the bean context code.
*/
@@ -53,7 +53,7 @@ public class BeanDictionaryList extends ArrayList<Class<?>> {
/**
* Constructor.
- *
+ *
* @param c
* The list of bean classes to add to this dictionary.
* Classes must either specify a {@link Bean#typeName() @Bean.typeName()} value or be another subclass of
@@ -65,7 +65,7 @@ public class BeanDictionaryList extends ArrayList<Class<?>> {
/**
* Append one or more bean classes to this bean dictionary.
- *
+ *
* @param c
* The list of bean classes to add to this dictionary.
* Classes must either specify a {@link Bean#typeName() @Bean.typeName()} value or be another subclass of
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryMap.java
index 573438d..2cb7294 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryMap.java
@@ -19,11 +19,11 @@ import org.apache.juneau.annotation.*;
/**
* Represents a map of dictionary type names to bean classes that make up a bean dictionary.
- *
+ *
* <p>
* In general, this approach for defining dictionary names for classes is used when it's not possible to use the
* {@link Bean#typeName() @Bean.typeName()} annotation.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// A bean dictionary map consisting of classes without @Bean.typeName() annotations</jc>
@@ -67,7 +67,7 @@ public class BeanDictionaryMap extends LinkedHashMap<String,Object> {
/**
* Add a dictionary name mapping for the specified class.
- *
+ *
* @param typeName The dictionary name of the class.
* @param c The class represented by the dictionary name.
* @return This object (for method chaining).
@@ -79,7 +79,7 @@ public class BeanDictionaryMap extends LinkedHashMap<String,Object> {
/**
* Add a dictionary name mapping for the specified map class with the specified key and value classes.
- *
+ *
* @param typeName The dictionary name of the class.
* @param mapClass The map implementation class.
* @param keyClass The key class.
@@ -95,7 +95,7 @@ public class BeanDictionaryMap extends LinkedHashMap<String,Object> {
/**
* Add a dictionary name mapping for the specified collection class with the specified entry class.
- *
+ *
* @param typeName The dictionary name of the class.
* @param collectionClass The collection implementation class.
* @param entryClass The entry class.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMap.java
index 9d61ce6..611f6e8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMap.java
@@ -25,17 +25,18 @@ import org.apache.juneau.xml.annotation.*;
/**
* Java bean wrapper class.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* A wrapper that wraps Java bean instances inside of a {@link Map} interface that allows properties on the wrapped
* object can be accessed using the {@link Map#get(Object) get()} and {@link Map#put(Object,Object) put()} methods.
- *
+ *
* <p>
* Use the {@link BeanContext} class to create instances of this class.
- *
+ *
* <h6 class='topic'>Bean property order</h6>
- *
+ *
* The order of the properties returned by the {@link Map#keySet() keySet()} and {@link Map#entrySet() entrySet()}
* methods are as follows:
* <ul class='spaced-list'>
@@ -46,16 +47,16 @@ import org.apache.juneau.xml.annotation.*;
* If {@link Bean @Bean} annotation is not specified on the class, then the order is the same as that returned
* by the {@link java.beans.BeanInfo} class (i.e. ordered by definition in the class).
* </ul>
- *
+ *
* <p>
* <br>The order can also be overridden through the use of a {@link BeanFilter}.
- *
+ *
* <h6 class='topic'>POJO swaps</h6>
- *
+ *
* If {@link PojoSwap PojoSwaps} are defined on the class types of the properties of this bean or the bean properties
* themselves, the {@link #get(Object)} and {@link #put(String, Object)} methods will automatically transform the
* property value to and from the serialized form.
- *
+ *
* @param <T> Specifies the type of object that this map encapsulates.
*/
public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T> {
@@ -77,7 +78,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Instance of this class are instantiated through the BeanContext class.
- *
+ *
* @param session The bean session object that created this bean map.
* @param bean The bean to wrap inside this map.
* @param meta The metadata associated with the bean class.
@@ -93,7 +94,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the metadata associated with this bean map.
- *
+ *
* @return The metadata associated with this bean map.
*/
public BeanMeta<T> getMeta() {
@@ -102,7 +103,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the bean session that created this bean map.
- *
+ *
* @return The bean session that created this bean map.
*/
public final BeanSession getBeanSession() {
@@ -111,11 +112,11 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the wrapped bean object.
- *
+ *
* <p>
* Triggers bean creation if bean has read-only properties set through a constructor defined by the
* {@link BeanConstructor @BeanConstructor} annotation.
- *
+ *
* @return The inner bean object.
*/
public T getBean() {
@@ -140,15 +141,15 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the wrapped bean object.
- *
+ *
* <p>
* If <code>create</code> is <jk>false</jk>, then this method may return <jk>null</jk> if the bean has read-only
* properties set through a constructor defined by the {@link BeanConstructor @BeanConstructor} annotation.
- *
+ *
* <p>
* This method does NOT always return the bean in it's final state.
* Array properties temporary stored as ArrayLists are not finalized until the {@link #getBean()} method is called.
- *
+ *
* @param create If bean hasn't been instantiated yet, then instantiate it.
* @return The inner bean object.
*/
@@ -176,7 +177,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Sets a property on the bean.
- *
+ *
* <p>
* If there is a {@link PojoSwap} associated with this bean property or bean property type class, then you must pass
* in a transformed value.
@@ -184,22 +185,22 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
* {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
* {@link Swap#value() @Swap.value()} annotation, the value being passed in must be
* a String containing an ISO8601 date-time string value.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a bean with a 'birthDate' Date field</jc>
* Person p = <jk>new</jk> Person();
- *
+ *
* <jc>// Create a bean context and add the ISO8601 date-time swap</jc>
* BeanContext beanContext = <jk>new</jk> BeanContext().pojoSwaps(DateSwap.ISO8601DT.<jk>class</jk>);
- *
+ *
* <jc>// Wrap our bean in a bean map</jc>
* BeanMap<Person> b = beanContext.forBean(p);
- *
+ *
* <jc>// Set the field</jc>
* myBeanMap.put(<js>"birthDate"</js>, <js>"'1901-03-03T04:05:06-5000'"</js>);
* </p>
- *
+ *
* @param property The name of the property to set.
* @param value The value to set the property to.
* @return
@@ -233,11 +234,11 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Add a value to a collection or array property.
- *
+ *
* <p>
* As a general rule, adding to arrays is not recommended since the array must be recreate each time this method is
* called.
- *
+ *
* @param property Property name or child-element name (if {@link Xml#childName() @Xml.childName()} is specified).
* @param value The value to add to the collection or array.
*/
@@ -254,7 +255,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Gets a property on the bean.
- *
+ *
* <p>
* If there is a {@link PojoSwap} associated with this bean property or bean property type class, then this method
* will return the transformed value.
@@ -262,23 +263,23 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
* {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
* {@link Swap#value() @Swap.value()} annotation, this method will return a String containing an
* ISO8601 date-time string value.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a bean with a 'birthDate' Date field</jc>
* Person p = <jk>new</jk> Person();
* p.setBirthDate(<jk>new</jk> Date(1, 2, 3, 4, 5, 6));
- *
+ *
* <jc>// Create a bean context and add the ISO8601 date-time swap</jc>
* BeanContext beanContext = <jk>new</jk> BeanContext().pojoSwaps(DateSwap.ISO8601DT.<jk>class</jk>);
- *
+ *
* <jc>// Wrap our bean in a bean map</jc>
* BeanMap<Person> b = beanContext.forBean(p);
- *
+ *
* <jc>// Get the field as a string (i.e. "'1901-03-03T04:05:06-5000'")</jc>
* String s = myBeanMap.get(<js>"birthDate"</js>);
* </p>
- *
+ *
* @param property The name of the property to get.
* @throws
* RuntimeException if any of the following occur.
@@ -302,7 +303,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Same as {@link #get(Object)} except bypasses the POJO filter associated with the bean property or bean filter
* associated with the bean class.
- *
+ *
* @param property The name of the property to get.
* @return The raw property value.
*/
@@ -316,12 +317,12 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Convenience method for setting multiple property values by passing in JSON text.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* aPersonBean.load(<js>"{name:'John Smith',age:21}"</js>)
* </p>
- *
+ *
* @param input The text that will get parsed into a map and then added to this map.
* @return This object (for method chaining).
* @throws ParseException If the input contains a syntax error or is malformed.
@@ -333,7 +334,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Convenience method for setting multiple property values by passing in a reader.
- *
+ *
* @param r The text that will get parsed into a map and then added to this map.
* @param p The parser to use to parse the text.
* @return This object (for method chaining).
@@ -347,10 +348,10 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Convenience method for loading this map with the contents of the specified map.
- *
+ *
* <p>
* Identical to {@link #putAll(Map)} except as a fluent-style method.
- *
+ *
* @param entries The map containing the entries to add to this map.
* @return This object (for method chaining).
*/
@@ -362,7 +363,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the names of all properties associated with the bean.
- *
+ *
* <p>
* The returned set is unmodifiable.
*/
@@ -384,14 +385,14 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the specified property on this bean map.
- *
+ *
* <p>
* Allows you to get and set an individual property on a bean without having a handle to the bean itself by using
* the {@link BeanMapEntry#getValue()} and {@link BeanMapEntry#setValue(Object)} methods.
- *
+ *
* <p>
* This method can also be used to get metadata on a property by calling the {@link BeanMapEntry#getMeta()} method.
- *
+ *
* @param propertyName The name of the property to look up.
* @return The bean property, or null if the bean has no such property.
*/
@@ -404,7 +405,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the metadata on the specified property.
- *
+ *
* @param propertyName The name of the bean property.
* @return Metadata on the specified property, or <jk>null</jk> if that property does not exist.
*/
@@ -417,7 +418,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the {@link ClassMeta} of the wrapped bean.
- *
+ *
* @return The class type of the wrapped bean.
*/
@Override /* Delegate */
@@ -427,10 +428,10 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Invokes all the getters on this bean and return the values as a list of {@link BeanPropertyValue} objects.
- *
+ *
* <p>
* This allows a snapshot of all values to be grabbed from a bean in one call.
- *
+ *
* @param ignoreNulls
* Don't return properties whose values are null.
* @param prependVals
@@ -473,7 +474,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Given a string containing variables of the form <code>"{property}"</code>, replaces those variables with property
* values in this bean.
- *
+ *
* @param s The string containing variables.
* @return A new string with variables replaced, or the same string if no variables were found.
*/
@@ -483,7 +484,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns a simple collection of properties for this bean map.
- *
+ *
* @return A simple collection of properties for this bean map.
*/
protected Collection<BeanPropertyMeta> getProperties() {
@@ -492,7 +493,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns all the properties associated with the bean.
- *
+ *
* @return A new set.
*/
@Override
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMapEntry.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMapEntry.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMapEntry.java
index a5a77d2..a72536d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMapEntry.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMapEntry.java
@@ -19,24 +19,24 @@ import org.apache.juneau.transform.*;
/**
* Represents a single entry in a bean map.
- *
+ *
* <p>
* This class can be used to get and set property values on a bean, or to get metadata on a property.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a new bean</jc>
* Person p = <jk>new</jk> Person();
- *
+ *
* <jc>// Wrap it in a bean map</jc>
* BeanMap<Person> b = BeanContext.<jsf>DEFAULT</jsf>.forBean(p);
- *
+ *
* <jc>// Get a reference to the birthDate property</jc>
* BeanMapEntry birthDate = b.getProperty(<js>"birthDate"</js>);
- *
+ *
* <jc>// Set the property value</jc>
* birthDate.setValue(<jk>new</jk> Date(1, 2, 3, 4, 5, 6));
- *
+ *
* <jc>// Or if the DateSwap.DEFAULT_ISO8601DT is registered with the bean context, set a transformed value</jc>
* birthDate.setValue(<js>"'1901-03-03T04:05:06-5000'"</js>);
* </p>
@@ -48,7 +48,7 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
/**
* Constructor.
- *
+ *
* @param beanMap The bean map that this entry belongs to.
* @param property The bean property.
* @param pName The bean property name.
@@ -66,7 +66,7 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
/**
* Returns the value of this property.
- *
+ *
* <p>
* If there is a {@link PojoSwap} associated with this bean property or bean property type class, then this method
* will return the transformed value.
@@ -82,14 +82,14 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
/**
* Sets the value of this property.
- *
+ *
* <p>
* If the property is an array of type {@code X}, then the value can be a {@code Collection<X>} or {@code X[]} or
* {@code Object[]}.
- *
+ *
* <p>
* If the property is a bean type {@code X}, then the value can either be an {@code X} or a {@code Map}.
- *
+ *
* <p>
* If there is a {@link PojoSwap} associated with this bean property or bean property type class, then you must pass
* in a transformed value.
@@ -97,7 +97,7 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
* {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
* {@link Swap#value() @Swap.value()} annotation, the value being passed in must be a String
* containing an ISO8601 date-time string value.
- *
+ *
* @return The set value after it's been converted.
*/
@Override /* Map.Entry */
@@ -107,7 +107,7 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
/**
* Returns the bean map that contains this property.
- *
+ *
* @return The bean map that contains this property.
*/
public BeanMap<?> getBeanMap() {
@@ -116,7 +116,7 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
/**
* Returns the metadata about this bean property.
- *
+ *
* @return Metadata about this bean property.
*/
public BeanPropertyMeta getMeta() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMeta.java
index 157f7b4..c9d86b9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMeta.java
@@ -28,16 +28,17 @@ import org.apache.juneau.utils.*;
/**
* Encapsulates all access to the properties of a bean class (like a souped-up {@link java.beans.BeanInfo}).
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Uses introspection to find all the properties associated with this class. If the {@link Bean @Bean} annotation
* is present on the class, or the class has a {@link BeanFilter} registered with it in the bean context,
* then that information is used to determine the properties on the class.
* Otherwise, the {@code BeanInfo} functionality in Java is used to determine the properties on the class.
- *
+ *
* <h6 class='topic'>Bean property ordering</h6>
- *
+ *
* The order of the properties are as follows:
* <ul class='spaced-list'>
* <li>
@@ -51,10 +52,10 @@ import org.apache.juneau.utils.*;
* <li>Non-standard getters/setters with {@link BeanProperty @BeanProperty} annotation defined on them.
* </ul>
* </ul>
- *
+ *
* <p>
* The order can also be overridden through the use of an {@link BeanFilter}.
- *
+ *
* @param <T> The class type that this metadata applies to.
*/
public class BeanMeta<T> {
@@ -102,7 +103,7 @@ public class BeanMeta<T> {
/**
* Constructor.
- *
+ *
* @param classMeta The target class.
* @param ctx The bean context that created this object.
* @param beanFilter Optional bean filter associated with the target class. Can be <jk>null</jk>.
@@ -456,7 +457,7 @@ public class BeanMeta<T> {
/**
* Returns the {@link ClassMeta} of this bean.
- *
+ *
* @return The {@link ClassMeta} of this bean.
*/
@BeanIgnore
@@ -466,7 +467,7 @@ public class BeanMeta<T> {
/**
* Returns the dictionary name for this bean as defined through the {@link Bean#typeName() @Bean.typeName()} annotation.
- *
+ *
* @return The dictionary name for this bean, or <jk>null</jk> if it has no dictionary name defined.
*/
public final String getDictionaryName() {
@@ -476,7 +477,7 @@ public class BeanMeta<T> {
/**
* Returns a mock bean property that resolves to the name <js>"_type"</js> and whose value always resolves to the
* dictionary name of the bean.
- *
+ *
* @return The type name property.
*/
public final BeanPropertyMeta getTypeProperty() {
@@ -546,7 +547,7 @@ public class BeanMeta<T> {
/*
* Find all the bean methods on this class.
- *
+ *
* @param c The transformed class.
* @param stopClass Don't look above this class in the hierarchy.
* @param v The minimum method visibility.
@@ -652,7 +653,7 @@ public class BeanMeta<T> {
/**
* Returns the metadata on all properties associated with this bean.
- *
+ *
* @return Metadata on all properties associated with this bean.
*/
public Collection<BeanPropertyMeta> getPropertyMetas() {
@@ -661,7 +662,7 @@ public class BeanMeta<T> {
/**
* Returns the metadata on the specified list of properties.
- *
+ *
* @param pNames The list of properties to retrieve. If <jk>null</jk>, returns all properties.
* @return The metadata on the specified list of properties.
*/
@@ -676,7 +677,7 @@ public class BeanMeta<T> {
/**
* Returns the language-specified extended metadata on this bean class.
- *
+ *
* @param metaDataClass The name of the metadata class to create.
* @return Extended metadata on this bean class. Never <jk>null</jk>.
*/
@@ -686,7 +687,7 @@ public class BeanMeta<T> {
/**
* Returns metadata about the specified property.
- *
+ *
* @param name The name of the property on this bean.
* @return The metadata about the property, or <jk>null</jk> if no such property exists on this bean.
*/
@@ -699,7 +700,7 @@ public class BeanMeta<T> {
/**
* Creates a new instance of this bean.
- *
+ *
* @param outer The outer object if bean class is a non-static inner member class.
* @return A new instance of this bean if possible, or <jk>null</jk> if not.
* @throws IllegalArgumentException Thrown by constructor.
@@ -727,7 +728,7 @@ public class BeanMeta<T> {
/**
* Recursively determines the classes represented by parameterized types in the class hierarchy of the specified
* type, and puts the results in the specified map.
- *
+ *
* <p>
* For example, given the following classes...
* <p class='bcode'>
@@ -742,18 +743,18 @@ public class BeanMeta<T> {
* <p class='bcode'>
* {BeanA.class:[Integer.class]}
* </p>
- *
+ *
* <p>
* TODO: This code doesn't currently properly handle the following situation:
* <p class='bcode'>
* public static class BeanB<T extends Number> extends BeanA<T>;
* public static class BeanC extends BeanB<Integer>;
* </p>
- *
+ *
* <p>
* When called on {@code BeanC}, the variable will be detected as a {@code Number}, not an {@code Integer}.
* If anyone can figure out a better way of doing this, please do so!
- *
+ *
* @param t The type we're recursing.
* @param m Where the results are loaded.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaExtended.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaExtended.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaExtended.java
index f4c2eab..b06acbc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaExtended.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaExtended.java
@@ -14,7 +14,7 @@ package org.apache.juneau;
/**
* Defines extended language-specific metadata associated with a bean.
- *
+ *
* <p>
* Serializers and parsers can implement their own language-specific metadata on a bean and retrieve the metadata using
* the {@link BeanMeta#getExtendedMeta(Class)} method.
@@ -25,7 +25,7 @@ public class BeanMetaExtended {
/**
* Constructor.
- *
+ *
* @param bm The metadata of the bean we're extending.
* @throws BeanRuntimeException If any error occurred trying to construct the metadata.
*/
@@ -35,7 +35,7 @@ public class BeanMetaExtended {
/**
* Returns the bean metadata that was passed into the constructor.
- *
+ *
* @return The bean metadata that was passed into the constructor.
*/
protected BeanMeta<?> getBeanMeta() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaFiltered.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaFiltered.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaFiltered.java
index 583e098..2673529 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaFiltered.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaFiltered.java
@@ -18,14 +18,14 @@ import org.apache.juneau.annotation.*;
/**
* Same as {@link BeanMeta}, except the list of bean properties are limited by a {@link BeanProperty#properties() @BeanProperty.properties()} annotation.
- *
+ *
* @param <T> The class type that this metadata applies to.
*/
public final class BeanMetaFiltered<T> extends BeanMeta<T> {
/**
* Wrapper constructor.
- *
+ *
* @param innerMeta The untransformed bean meta of the bean property.
* @param pNames The list of transformed property names.
*/
@@ -35,7 +35,7 @@ public final class BeanMetaFiltered<T> extends BeanMeta<T> {
/**
* Wrapper constructor.
- *
+ *
* @param innerMeta The untransformed bean meta of the bean property.
* @param pNames The list of transformed property names.
*/