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 2017/06/28 01:49:47 UTC
[8/9] incubator-juneau git commit: Clean up javadocs.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java b/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
index 34f3590..27120d1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
@@ -44,6 +44,7 @@ public abstract class CoreObjectBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public CoreObjectBuilder(PropertyStore propertyStore) {
@@ -208,6 +209,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require no-arg constructors.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireDefaultConstructor"</js>
@@ -215,9 +217,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, a Java class must implement a default no-arg constructor to be considered a bean.
* 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>.
*
@@ -236,6 +240,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require {@link Serializable} interface.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSerializable"</js>
@@ -243,9 +248,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, a Java class must implement the {@link Serializable} interface to be considered a bean.
* 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>.
*
@@ -264,6 +271,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require setters for getters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSettersForGetters"</js>
@@ -271,6 +279,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean.
* Otherwise, they will be ignored.
@@ -290,6 +299,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require at least one property.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSomeProperties"</js>
@@ -297,9 +307,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, then a Java class must contain at least 1 property to be considered a bean.
* 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>.
*
@@ -319,6 +331,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
* value.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMapPutReturnsOldValue"</js>
@@ -326,10 +339,12 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
* values.
* Otherwise, it returns <jk>null</jk>.
+ *
* <p>
* Disabled by default because it introduces a slight performance penalty.
*
@@ -348,6 +363,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean constructors with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanConstructorVisibility"</js>
@@ -355,10 +371,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Constructors not meeting this minimum visibility will be ignored.
- * For example, if the visibility is <code>PUBLIC</code> and the constructor is <jk>protected</jk>, then
- * the constructor will be ignored.
+ * 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>
* <ul>
@@ -375,6 +392,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean classes with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanClassVisibility"</js>
@@ -382,10 +400,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <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.
+ * 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>
* <ul>
@@ -402,6 +421,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean fields with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFieldVisibility"</js>
@@ -409,10 +429,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Fields are not considered bean properties unless they meet the minimum visibility requirements.
- * For example, if the visibility is <code>PUBLIC</code> and the bean field is <jk>protected</jk>, then
- * the field will not be interpreted as a bean property.
+ * For example, if the visibility is <code>PUBLIC</code> and the bean field is <jk>protected</jk>, then the field
+ * will not be interpreted as a bean property.
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -430,6 +451,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean methods with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.methodVisibility"</js>
@@ -437,10 +459,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Methods are not considered bean getters/setters unless they meet the minimum visibility requirements.
- * 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.
+ * 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>
* <ul>
@@ -458,6 +481,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Use Java {@link Introspector} for determining bean properties.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useJavaBeanIntrospector"</js>
@@ -465,6 +489,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
*
@@ -484,6 +509,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Use interface proxies.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useInterfaceProxies"</js>
@@ -491,6 +517,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <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.
@@ -510,6 +537,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore unknown properties.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownBeanProperties"</js>
@@ -517,6 +545,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -536,6 +565,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore unknown properties with null values.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownNullBeanProperties"</js>
@@ -543,6 +573,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, trying to set a <jk>null</jk> value on a non-existent bean property will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -562,6 +593,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore properties without setters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignorePropertiesWithoutSetters"</js>
@@ -569,6 +601,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, trying to set a value on a bean property without a setter will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -588,6 +621,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore invocation errors on getters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnGetters"</js>
@@ -595,6 +629,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -614,6 +649,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore invocation errors on setters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnSetters"</js>
@@ -621,6 +657,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -640,6 +677,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Sort bean properties in alphabetical order.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.sortProperties"</js>
@@ -647,17 +685,19 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <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.
+ * 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 offical JVM specs).
+ * On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).
*
* <h5 class='section'>Notes:</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
+ * <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.
* </ul>
@@ -672,6 +712,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Packages whose classes should not be considered beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanPackages.set"</js>
@@ -689,10 +730,13 @@ public abstract class CoreObjectBuilder {
* </ul>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <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.
*
@@ -711,6 +755,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Packages whose classes should not be considered beans.
+ *
* <p>
* Same as {@link #setNotBeanPackages(String...)} but using a <code>Collection</code>.
*
@@ -741,6 +786,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to packages whose classes should not be considered beans.
+ *
* <p>
* Same as {@link #notBeanPackages(String...)} but using a <code>Collection</code>.
*
@@ -772,6 +818,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from packages whose classes should not be considered beans.
+ *
* <p>
* Same as {@link #removeNotBeanPackages(String...)} but using a <code>Collection</code>.
*
@@ -786,6 +833,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Classes to be excluded from consideration as being beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanClasses.set"</js>
@@ -793,9 +841,10 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> empty set
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
- * Not-bean classes are typically converted to <code>Strings</code> during serialization even if they
- * appear to be bean-like.
+ * 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>
* <ul>
@@ -812,6 +861,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Classes to be excluded from consideration as being beans.
+ *
* <p>
* Same as {@link #setNotBeanClasses(Class...)} but using a <code>Collection</code>.
*
@@ -843,6 +893,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to classes that should not be considered beans.
+ *
* <p>
* Same as {@link #notBeanClasses(Class...)} but using a <code>Collection</code>.
*
@@ -875,6 +926,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from classes that should not be considered beans.
+ *
* <p>
* Same as {@link #removeNotBeanClasses(Class...)} but using a <code>Collection</code>.
*
@@ -889,6 +941,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Bean filters to apply to beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFilters.list"</js>
@@ -896,10 +949,12 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* This is a programmatic equivalent to the {@link Bean @Bean} annotation.
- * It's useful when you want to use the Bean annotation functionality, but you don't have the ability
- * to alter the bean classes.
+ * It's useful when you want to use the Bean annotation functionality, but you don't have the ability to alter the
+ * bean classes.
+ *
* <p>
* There are two category of classes that can be passed in through this method:
* <ul class='spaced-list'>
@@ -928,6 +983,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Bean filters to apply to beans.
+ *
* <p>
* Same as {@link #setBeanFilters(Class...)} but using a <code>Collection</code>.
*
@@ -959,6 +1015,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to bean filters.
+ *
* <p>
* Same as {@link #beanFilters(Class...)} but using a <code>Collection</code>.
*
@@ -991,6 +1048,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from bean filters.
+ *
* <p>
* Same as {@link #removeBeanFilters(Class...)} but using a <code>Collection</code>.
*
@@ -1005,6 +1063,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> POJO swaps to apply to Java objects.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.pojoSwaps.list"</js>
@@ -1012,6 +1071,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* There are two category of classes that can be passed in through this method:
* <ul>
@@ -1034,6 +1094,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> POJO swaps to apply to Java objects.
+ *
* <p>
* Same as {@link #setPojoSwaps(Class...)} but using a <code>Collection</code>.
*
@@ -1065,6 +1126,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to POJO swaps.
+ *
* <p>
* Same as {@link #pojoSwaps(Class...)} but using a <code>Collection</code>.
*
@@ -1097,6 +1159,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from POJO swaps.
+ *
* <p>
* Same as {@link #removePojoSwaps(Class...)} but using a <code>Collection</code>.
*
@@ -1111,6 +1174,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Implementation classes for interfaces and abstract classes.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.implClasses.map"</js>
@@ -1118,10 +1182,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> empty map
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <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).
+ * 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'>Notes:</h5>
* <ul>
@@ -1158,6 +1223,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Explicitly specify visible bean properties.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.includeProperties"</js>
@@ -1165,15 +1231,18 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <code>{}</code>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <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.
+ * properties on the specified bean.
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -1228,6 +1297,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Exclude specified properties from beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.excludeProperties"</js>
@@ -1235,15 +1305,18 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <code>{}</code>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <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.
+ * properties on the specified bean.
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -1298,6 +1371,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Bean lookup dictionary.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanDictionary.list"</js>
@@ -1305,6 +1379,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* This list can consist of the following class types:
* <ul>
@@ -1330,6 +1405,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Bean lookup dictionary.
+ *
* <p>
* Same as {@link #setBeanDictionary(Class...)} but using a <code>Collection</code>.
*
@@ -1361,6 +1437,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to bean dictionary.
+ *
* <p>
* Same as {@link #beanDictionary(Class...)} but using a <code>Collection</code>.
*
@@ -1393,6 +1470,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from bean dictionary.
+ *
* <p>
* Same as {@link #removeFromBeanDictionary(Class...)} but using a <code>Collection</code>.
*
@@ -1407,6 +1485,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Name to use for the bean type properties used to represent a bean type.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanTypePropertyName"</js>
@@ -1430,6 +1509,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Default parser to use when converting <code>Strings</code> to POJOs.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.defaultParser"</js>
@@ -1437,6 +1517,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> {@link JsonSerializer}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Used in the in the {@link BeanSession#convertToType(Object, Class)} method.
*
@@ -1455,6 +1536,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Locale.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.locale"</js>
@@ -1478,6 +1560,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> TimeZone.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.timeZone"</js>
@@ -1501,6 +1584,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Media type.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.mediaType"</js>
@@ -1508,6 +1592,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Specifies a default media type value for serializer and parser sessions.
*
@@ -1526,6 +1611,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Debug mode.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.debug"</js>
@@ -1533,6 +1619,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Enables the following additional information during serialization:
* <ul class='spaced-list'>
@@ -1542,6 +1629,7 @@ public abstract class CoreObjectBuilder {
* <li>
* Enables {@link SerializerContext#SERIALIZER_detectRecursions}.
* </ul>
+ *
* <p>
* Enables the following additional information during parsing:
* <ul class='spaced-list'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Delegate.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Delegate.java b/juneau-core/src/main/java/org/apache/juneau/Delegate.java
index 717f556..00d0bec 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Delegate.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Delegate.java
@@ -14,8 +14,10 @@ package org.apache.juneau;
/**
* An object that represents another object, often wrapping that object.
+ *
* <p>
* <b>*** Internal Interface - Not intended for external use ***</b>
+ *
* <p>
* For example, {@link BeanMap} is a map representation of a bean.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java b/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
index f4fc490..89d0d28 100644
--- a/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
+++ b/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
@@ -18,6 +18,7 @@ import org.apache.juneau.json.*;
/**
* General invalid conversion exception.
+ *
* <p>
* Exception that gets thrown if you try to perform an invalid conversion, such as when calling
* {@code ObjectMap.getInt(...)} on a non-numeric <code>String</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ObjectList.java b/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
index 916e862..13d1be4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
@@ -22,15 +22,17 @@ import org.apache.juneau.utils.*;
/**
* Java implementation of a JSON array.
+ *
* <p>
- * An extension of {@link LinkedList}, so all methods available to in that class are also available
- * to this class.
+ * An extension of {@link LinkedList}, so all methods available to in that class are also available to this class.
+ *
* <p>
- * Note that the use of this class is optional. The serializers will accept any objects that implement
- * the {@link Collection} interface. But this class provides some useful additional functionality
- * when working with JSON models constructed from Java Collections Framework objects. For example, a
- * constructor is provided for converting a JSON array string directly into a {@link List}. It also contains
- * accessor methods for to avoid common typecasting when accessing elements in a list.
+ * Note that the use of this class is optional.
+ * The serializers will accept any objects that implement the {@link Collection} interface.
+ * But this class provides some useful additional functionality when working with JSON models constructed from Java
+ * Collections Framework objects.
+ * For example, a constructor is provided for converting a JSON array string directly into a {@link List}.
+ * It also contains accessor methods for to avoid common typecasting when accessing elements in a list.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -87,6 +89,7 @@ import org.apache.juneau.utils.*;
* <jc>// Do something with p</jc>
* }
* </p>
+ *
* <p>
* This class is not thread safe.
*/
@@ -161,8 +164,9 @@ public class ObjectList extends LinkedList<Object> {
/**
* Construct a JSON array directly from a reader using the specified parser.
*
- * @param r The reader to read from. Will automatically be wrapped in a {@link BufferedReader} if it isn't already
- * a BufferedReader.
+ * @param r
+ * The reader to read from.
+ * Will automatically be wrapped in a {@link BufferedReader} if it isn't already a BufferedReader.
* @param p The parser to use to parse the input.
* @throws ParseException If the input contains a syntax error or is malformed.
* @throws IOException If a problem occurred trying to read from the reader.
@@ -175,7 +179,9 @@ public class ObjectList extends LinkedList<Object> {
/**
* Shortcut for <code><jk>new</jk> ObjectList(reader, JsonParser.<jsf>DEFAULT</jsf>)</code>.
*
- * @param r The reader to read from. The reader will be wrapped in a {@link BufferedReader} if it isn't already.
+ * @param r
+ * The reader to read from.
+ * The reader will be wrapped in a {@link BufferedReader} if it isn't already.
* @throws ParseException If the input contains a syntax error or is malformed.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -227,8 +233,10 @@ public class ObjectList extends LinkedList<Object> {
/**
* Override the default bean session used for converting POJOs.
+ *
* <p>
* Default is {@link BeanContext#DEFAULT}, which is sufficient in most cases.
+ *
* <p>
* Useful if you're serializing/parsing beans with transforms defined.
*
@@ -242,6 +250,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Convenience method for adding multiple objects to this list.
+ *
* @param o The objects to add to the list.
* @return This object (for method chaining).
*/
@@ -253,6 +262,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Get the entry at the specified index, converted to the specified type (if possible).
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
*
@@ -353,8 +363,9 @@ public class ObjectList extends LinkedList<Object> {
}
/**
- * Same as {@link #get(Class,int) get(Class,int)}, but the key is a slash-delimited
- * path used to traverse entries in this POJO.
+ * Same as {@link #get(Class,int) get(Class,int)}, but the key is a slash-delimited path used to traverse entries in
+ * this POJO.
+ *
* <p>
* For example, the following code is equivalent:
* </p>
@@ -367,9 +378,10 @@ public class ObjectList extends LinkedList<Object> {
* <jc>// Using this method</jc>
* <jk>long</jk> l = m.getAt(<jk>long</jk>.<jk>class</jk>, <js>"foo/bar/0/baz"</js>);
* </p>
+ *
* <p>
- * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain
- * any of the various class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
+ * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
+ * class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
*
* @param <T> The class type.
* @param type The class type.
@@ -381,8 +393,9 @@ public class ObjectList extends LinkedList<Object> {
}
/**
- * Same as {@link #set(int,Object) set(int,Object)}, but the key is a slash-delimited
- * path used to traverse entries in this POJO.
+ * Same as {@link #set(int,Object) set(int,Object)}, but the key is a slash-delimited path used to traverse entries
+ * in this POJO.
+ *
* <p>
* For example, the following code is equivalent:
* </p>
@@ -395,9 +408,10 @@ public class ObjectList extends LinkedList<Object> {
* <jc>// Using this method</jc>
* m.putAt(<js>"foo/bar/0/baz"</js>, 123);
* </p>
+ *
* <p>
- * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain
- * any of the various class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
+ * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
+ * class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
*
* @param path The path to the entry.
* @param o The new value.
@@ -408,8 +422,8 @@ public class ObjectList extends LinkedList<Object> {
}
/**
- * Similar to {@link #putAt(String,Object) putAt(String,Object)}, but used to append
- * to collections and arrays.
+ * Similar to {@link #putAt(String,Object) putAt(String,Object)}, but used to append to collections and arrays.
+ *
* <p>
* For example, the following code is equivalent:
* </p>
@@ -422,9 +436,10 @@ public class ObjectList extends LinkedList<Object> {
* <jc>// Using this method</jc>
* m.postAt(<js>"foo/bar"</js>, 123);
* </p>
+ *
* <p>
- * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain
- * any of the various class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
+ * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
+ * class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
*
* @param path The path to the entry.
* @param o The new value.
@@ -435,8 +450,9 @@ public class ObjectList extends LinkedList<Object> {
}
/**
- * Similar to {@link #remove(int) remove(int)},but the key is a slash-delimited
- * path used to traverse entries in this POJO.
+ * Similar to {@link #remove(int) remove(int)},but the key is a slash-delimited path used to traverse entries in
+ * this POJO.
+ *
* <p>
* For example, the following code is equivalent:
* </p>
@@ -449,9 +465,10 @@ public class ObjectList extends LinkedList<Object> {
* <jc>// Using this method</jc>
* m.deleteAt(<js>"foo/bar/0/baz"</js>);
* </p>
+ *
* <p>
- * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain
- * any of the various class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
+ * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
+ * class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
*
* @param path The path to the entry.
* @return The previous value, or <jk>null</jk> if the entry doesn't exist.
@@ -462,11 +479,14 @@ public class ObjectList extends LinkedList<Object> {
/**
* Creates an {@link Iterable} with elements of the specified child type.
+ *
* <p>
* Attempts to convert the child objects to the correct type if they aren't already the correct type.
+ *
* <p>
* The <code>next()</code> method on the returned iterator may throw a {@link InvalidDataConversionException} if
- * the next element cannot be converted to the specified type.
+ * the next element cannot be converted to the specified type.
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for a description of valid conversions.
*
@@ -564,8 +584,8 @@ public class ObjectList extends LinkedList<Object> {
}
/**
- * Convenience method for serializing this ObjectList to the specified Writer using
- * the JsonSerializer.DEFAULT serializer.
+ * Convenience method for serializing this ObjectList to the specified Writer using the JsonSerializer.DEFAULT
+ * serializer.
*
* @param w The writer to send the serialized contents of this object.
* @throws IOException If a problem occurred trying to write to the writer.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java b/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
index 42a27b1..5bccde9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
@@ -27,15 +27,16 @@ import org.apache.juneau.utils.*;
/**
* Java implementation of a JSON object.
+ *
* <p>
- * An extension of {@link LinkedHashMap}, so all methods available in that class are also available
- * to this class.
+ * An extension of {@link LinkedHashMap}, so all methods available in that class are also available to this class.
* <p>
- * Note that the use of this class is optional. The serializers will accept any objects that implement
- * the {@link java.util.Map} interface. But this class provides some useful additional functionality
- * when working with JSON models constructed from Java Collections Framework objects. For example, a
- * constructor is provided for converting a JSON object string directly into a {@link Map}. It also contains
- * accessor methods for to avoid common typecasting when accessing elements in a list.
+ * Note that the use of this class is optional.
+ * The serializers will accept any objects that implement the {@link java.util.Map} interface.
+ * But this class provides some useful additional functionality when working with JSON models constructed from Java
+ * Collections Framework objects.
+ * For example, a constructor is provided for converting a JSON object string directly into a {@link Map}.
+ * It also contains accessor methods for to avoid common typecasting when accessing elements in a list.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -95,6 +96,7 @@ import org.apache.juneau.utils.*;
* ObjectMap m2 = <jk>new</jk> ObjectMap(<js>"{b:2}"</js>).setInner(m1);
* <jk>int</jk> a = m2.getInt(<js>"a"</js>); <jc>// a == 1 </jc>
* </p>
+ *
* <p>
* This class is not thread safe.
*/
@@ -230,12 +232,14 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Set an inner map in this map to allow for chained get calls.
+ *
* <p>
* If {@link #get(Object)} returns <jk>null</jk>, then {@link #get(Object)} will be called on the inner map.
+ *
* <p>
- * In addition to providing the ability to chain maps, this method also provides the ability
- * to wrap an existing map inside another map so that you can add entries to the outer
- * map without affecting the values on the inner map.
+ * In addition to providing the ability to chain maps, this method also provides the ability to wrap an existing map
+ * inside another map so that you can add entries to the outer map without affecting the values on the inner map.
+ *
* <p class='bcode'>
* ObjectMap m1 = <jk>new</jk> ObjectMap(<js>"{foo:1}"</js>);
* ObjectMap m2 = <jk>new</jk> ObjectMap().setInner(m1);
@@ -244,8 +248,9 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* <jk>int</jk> foo2 = m2.getInt(<js>"foo"</js>); <jc>// foo2 == 2 </jc>
* </p>
*
- * @param inner The inner map.
- * Can be <jk>null</jk> to remove the inner map from an existing map.
+ * @param inner
+ * The inner map.
+ * Can be <jk>null</jk> to remove the inner map from an existing map.
* @return This object (for method chaining).
*/
public ObjectMap setInner(Map<String,Object> inner) {
@@ -256,7 +261,9 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Searches for the specified key in this map ignoring case.
*
- * @param key The key to search for. For performance reasons, it's preferable that the key be all lowercase.
+ * @param key
+ * The key to search for.
+ * For performance reasons, it's preferable that the key be all lowercase.
* @return The key, or <jk>null</jk> if map does not contain this key.
*/
public String findKeyIgnoreCase(String key) {
@@ -268,8 +275,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Override the default bean session used for converting POJOs.
+ *
* <p>
* Default is {@link BeanContext#DEFAULT}, which is sufficient in most cases.
+ *
* <p>
* Useful if you're serializing/parsing beans with transforms defined.
*
@@ -292,9 +301,9 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Convenience method for adding multiple objects to this map.
+ *
* <p>
- * Equivalent to calling {@code put(key, value)}, but returns
- * this map so that the method can be chained.
+ * Equivalent to calling {@code put(key, value)}, but returns this map so that the method can be chained.
*
* @param key The key.
* @param value The value.
@@ -307,9 +316,9 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Convenience method for adding a contents of another map to this map.
+ *
* <p>
- * Equivalent to calling {@code putAll(m)}, but returns
- * this map so that the method can be chained.
+ * Equivalent to calling {@code putAll(m)}, but returns this map so that the method can be chained.
*
* @param m The map whose contents should be added to this map.
* @return This object (for method chaining).
@@ -328,8 +337,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Same as {@link Map#get(Object) get()}, but returns the default value if the key
- * could not be found.
+ * Same as {@link Map#get(Object) get()}, but returns the default value if the key could not be found.
*
* @param key The key.
* @param def The default value if the entry doesn't exist.
@@ -342,6 +350,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link Map#get(Object) get()}, but casts or converts the value to the specified class type.
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
*
@@ -375,6 +384,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link Map#get(Object) get()}, but casts or converts the value to the specified class type.
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
*
@@ -401,6 +411,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link Map#get(Object) get()}, but casts or converts the value to the specified class type.
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
*
@@ -415,6 +426,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link Map#get(Object) get()}, but casts or converts the value to the specified class type.
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
*
@@ -446,8 +458,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the value for the first key in the list that has an entry in this map.
+ *
* <p>
* Casts or converts the value to the specified class type.
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
*
@@ -464,8 +478,9 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Same as {@link #get(Class,String) get(Class,String)}, but the key is a slash-delimited
- * path used to traverse entries in this POJO.
+ * Same as {@link #get(Class,String) get(Class,String)}, but the key is a slash-delimited path used to traverse
+ * entries in this POJO.
+ *
* <p>
* For example, the following code is equivalent:
* </p>
@@ -479,9 +494,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* <jc>// Using this method</jc>
* <jk>long</jk> l = m.getAt(<jk>long</jk>.<jk>class</jk>, <js>"foo/bar/0/baz"</js>);
* </p>
+ *
* <p>
- * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain
- * any of the various class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
+ * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
+ * class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
*
* @param <T> The class type.
* @param type The class type.
@@ -493,8 +509,9 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Same as <code>put(String,Object)</code>, but the key is a slash-delimited
- * path used to traverse entries in this POJO.
+ * Same as <code>put(String,Object)</code>, but the key is a slash-delimited path used to traverse entries in this
+ * POJO.
+ *
* <p>
* For example, the following code is equivalent:
* </p>
@@ -508,9 +525,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* <jc>// Using this method</jc>
* m.putAt(<js>"foo/bar/0/baz"</js>, 123);
* </p>
+ *
* <p>
- * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain
- * any of the various class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
+ * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
+ * class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
*
* @param path The path to the entry.
* @param o The new value.
@@ -521,8 +539,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Similar to {@link #putAt(String,Object) putAt(String,Object)}, but used to append
- * to collections and arrays.
+ * Similar to {@link #putAt(String,Object) putAt(String,Object)}, but used to append to collections and arrays.
+ *
* <p>
* For example, the following code is equivalent:
* </p>
@@ -535,9 +553,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* <jc>// Using this method</jc>
* m.postAt(<js>"foo/bar"</js>, 123);
* </p>
+ *
* <p>
- * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain
- * any of the various class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
+ * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
+ * class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
*
* @param path The path to the entry.
* @param o The new value.
@@ -548,8 +567,9 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Similar to {@link #remove(Object) remove(Object)},but the key is a slash-delimited
- * path used to traverse entries in this POJO.
+ * Similar to {@link #remove(Object) remove(Object)},but the key is a slash-delimited path used to traverse entries
+ * in this POJO.
+ *
* <p>
* For example, the following code is equivalent:
* </p>
@@ -562,9 +582,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* <jc>// Using this method</jc>
* m.deleteAt(<js>"foo/bar/0/baz"</js>);
* </p>
+ *
* <p>
- * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain
- * any of the various class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
+ * This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
+ * class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
*
* @param path The path to the entry.
* @return The previous value, or <jk>null</jk> if the entry doesn't exist.
@@ -575,6 +596,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Convenience method for inserting JSON directly into an attribute on this object.
+ *
* <p>
* The JSON text can be an object (i.e. <js>"{...}"</js>) or an array (i.e. <js>"[...]"</js>).
*
@@ -588,6 +610,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link String}.
+ *
* <p>
* Shortcut for <code>get(String.<jk>class</jk>, key)</code>.
*
@@ -599,11 +622,13 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Specialized method that calls {@link #getString(String)} and splits the
- * results as a simple comma-delimited list.
+ * Specialized method that calls {@link #getString(String)} and splits the results as a simple comma-delimited list.
*
* @param key the key.
- * @return A list of tokens, trimmed of whitespace. An empty list if entry not found. Never <jk>null</jk>.
+ * @return
+ * A list of tokens, trimmed of whitespace.
+ * An empty list if entry not found.
+ * Never <jk>null</jk>.
*/
public String[] getStringArray(String key) {
String s = get(String.class, key);
@@ -625,6 +650,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link String}.
+ *
* <p>
* Shortcut for <code>get(String.<jk>class</jk>, key, defVal)</code>.
*
@@ -638,6 +664,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to an {@link Integer}.
+ *
* <p>
* Shortcut for <code>get(Integer.<jk>class</jk>, key)</code>.
*
@@ -651,6 +678,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to an {@link Integer}.
+ *
* <p>
* Shortcut for <code>get(Integer.<jk>class</jk>, key, defVal)</code>.
*
@@ -665,6 +693,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Long}.
+ *
* <p>
* Shortcut for <code>get(Long.<jk>class</jk>, key)</code>.
*
@@ -678,6 +707,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Long}.
+ *
* <p>
* Shortcut for <code>get(Long.<jk>class</jk>, key, defVal)</code>.
*
@@ -692,6 +722,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Boolean}.
+ *
* <p>
* Shortcut for <code>get(Boolean.<jk>class</jk>, key)</code>.
*
@@ -705,6 +736,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Boolean}.
+ *
* <p>
* Shortcut for <code>get(Boolean.<jk>class</jk>, key, defVal)</code>.
*
@@ -719,6 +751,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Map}.
+ *
* <p>
* Shortcut for <code>get(Map.<jk>class</jk>, key)</code>.
*
@@ -732,6 +765,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Map}.
+ *
* <p>
* Shortcut for <code>get(Map.<jk>class</jk>, key, defVal)</code>.
*
@@ -746,6 +780,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link List}.
+ *
* <p>
* Shortcut for <code>get(List.<jk>class</jk>, key)</code>.
*
@@ -759,6 +794,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link List}.
+ *
* <p>
* Shortcut for <code>get(List.<jk>class</jk>, key, defVal)</code>.
*
@@ -773,6 +809,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Map}.
+ *
* <p>
* Shortcut for <code>get(ObjectMap.<jk>class</jk>, key)</code>.
*
@@ -786,6 +823,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link ObjectMap}.
+ *
* <p>
* Shortcut for <code>get(ObjectMap.<jk>class</jk>, key, defVal)</code>.
*
@@ -800,6 +838,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link ObjectList}.
+ *
* <p>
* Shortcut for <code>get(ObjectList.<jk>class</jk>, key)</code>.
*
@@ -813,6 +852,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link ObjectList}.
+ *
* <p>
* Shortcut for <code>get(ObjectList.<jk>class</jk>, key, defVal)</code>.
*
@@ -827,12 +867,14 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link String}.
+ *
* <p>
* Shortcut for <code>find(String.<jk>class</jk>, keys)</code>.
*
* @param keys The list of keys to look for.
- * @return The converted value of the first key in the list that has an entry in this map,
- * or <jk>null</jk> if the map contains no mapping for any of the keys.
+ * @return
+ * The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
+ * contains no mapping for any of the keys.
*/
public String findString(String... keys) {
return find(String.class, keys);
@@ -840,12 +882,14 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to an {@link Integer}.
+ *
* <p>
* Shortcut for <code>find(Integer.<jk>class</jk>, keys)</code>.
*
* @param keys The list of keys to look for.
- * @return The converted value of the first key in the list that has an entry in this map,
- * or <jk>null</jk> if the map contains no mapping for any of the keys.
+ * @return
+ * The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public Integer findInt(String... keys) {
@@ -854,12 +898,14 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link Long}.
+ *
* <p>
* Shortcut for <code>find(Long.<jk>class</jk>, keys)</code>.
*
* @param keys The list of keys to look for.
- * @return The converted value of the first key in the list that has an entry in this map,
- * or <jk>null</jk> if the map contains no mapping for any of the keys.
+ * @return
+ * The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public Long findLong(String... keys) {
@@ -868,12 +914,14 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link Boolean}.
+ *
* <p>
* Shortcut for <code>find(Boolean.<jk>class</jk>, keys)</code>.
*
* @param keys The list of keys to look for.
- * @return The converted value of the first key in the list that has an entry in this map,
- * or <jk>null</jk> if the map contains no mapping for any of the keys.
+ * @return
+ * The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public Boolean findBoolean(String... keys) {
@@ -882,12 +930,14 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link Map}.
+ *
* <p>
* Shortcut for <code>find(Map.<jk>class</jk>, keys)</code>.
*
* @param keys The list of keys to look for.
- * @return The converted value of the first key in the list that has an entry in this map,
- * or <jk>null</jk> if the map contains no mapping for any of the keys.
+ * @return
+ * The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public Map<?,?> findMap(String... keys) {
@@ -896,12 +946,14 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link List}.
+ *
* <p>
* Shortcut for <code>find(List.<jk>class</jk>, keys)</code>.
*
* @param keys The list of keys to look for.
- * @return The converted value of the first key in the list that has an entry in this map,
- * or <jk>null</jk> if the map contains no mapping for any of the keys.
+ * @return
+ * The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public List<?> findList(String... keys) {
@@ -910,12 +962,14 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link ObjectMap}.
+ *
* <p>
* Shortcut for <code>find(ObjectMap.<jk>class</jk>, keys)</code>.
*
* @param keys The list of keys to look for.
- * @return The converted value of the first key in the list that has an entry in this map,
- * or <jk>null</jk> if the map contains no mapping for any of the keys.
+ * @return
+ * The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public ObjectMap findObjectMap(String... keys) {
@@ -924,12 +978,14 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link ObjectList}.
+ *
* <p>
* Shortcut for <code>find(ObjectList.<jk>class</jk>, keys)</code>.
*
* @param keys The list of keys to look for.
- * @return The converted value of the first key in the list that has an entry in this map,
- * or <jk>null</jk> if the map contains no mapping for any of the keys.
+ * @return
+ * The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public ObjectList findObjectList(String... keys) {
@@ -949,7 +1005,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* Returns the class type of the object at the specified index.
*
* @param key The key into this map.
- * @return The data type of the object at the specified key, or <jk>null</jk> if the value is null or does not exist.
+ * @return
+ * The data type of the object at the specified key, or <jk>null</jk> if the value is null or does not exist.
*/
public ClassMeta<?> getClassMeta(String key) {
return session.getClassMetaForObject(get(key));
@@ -1002,8 +1059,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Returns <jk>true</jk> if this map contains the specified key, ignoring
- * the inner map if it exists.
+ * Returns <jk>true</jk> if this map contains the specified key, ignoring the inner map if it exists.
*
* @param key The key to look up.
* @return <jk>true</jk> if this map contains the specified key.
@@ -1076,15 +1132,15 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Converts this map into an object of the specified type.
+ *
* <p>
- * If this map contains a <js>"_type"</js> entry, it must be the same as or a subclass
- * of the <code>type</code>.
+ * If this map contains a <js>"_type"</js> entry, it must be the same as or a subclass of the <code>type</code>.
*
* @param <T> The class type to convert this map object to.
* @param type The class type to convert this map object to.
* @return The new object.
- * @throws ClassCastException If the <js>"_type"</js> entry is present and not assignable
- * from <code>type</code>
+ * @throws ClassCastException
+ * If the <js>"_type"</js> entry is present and not assignable from <code>type</code>
*/
@SuppressWarnings("unchecked")
public <T> T cast(Class<T> type) {
@@ -1103,8 +1159,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* @param <T> The class type to convert this map object to.
* @param cm The class type to convert this map object to.
* @return The new object.
- * @throws ClassCastException If the <js>"_type"</js> entry is present and not assignable
- * from <code>type</code>
+ * @throws ClassCastException
+ * If the <js>"_type"</js> entry is present and not assignable from <code>type</code>
*/
@SuppressWarnings({"unchecked"})
public <T> T cast(ClassMeta<T> cm) {
@@ -1241,8 +1297,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Convenience method for serializing this map to the specified <code>Writer</code> using
- * the {@link JsonSerializer#DEFAULT} serializer.
+ * Convenience method for serializing this map to the specified <code>Writer</code> using the
+ * {@link JsonSerializer#DEFAULT} serializer.
*
* @param w The writer to serialize this object to.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/PropertyNamer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/PropertyNamer.java b/juneau-core/src/main/java/org/apache/juneau/PropertyNamer.java
index 2d6a33e..cb874a4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/PropertyNamer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/PropertyNamer.java
@@ -16,9 +16,11 @@ import org.apache.juneau.annotation.*;
/**
* Defines an API for converting conventional bean property names to some other form.
+ *
* <p>
- * For example, given the bean property <js>"fooBarURL"</js>, the {@link PropertyNamerDLC}
- * property namer will convert this to <js>"foo-bar-url"</js>.
+ * For example, given the bean property <js>"fooBarURL"</js>, the {@link PropertyNamerDLC} property namer will convert
+ * this to <js>"foo-bar-url"</js>.
+ *
* <p>
* Property namers are associated with beans through the {@link Bean#propertyNamer} annotation.
*/
@@ -26,6 +28,7 @@ public interface PropertyNamer {
/**
* Convert the specified default property name to some other value.
+ *
* @param name The original bean property name.
* @return The converted property name.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java b/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java
index 19dcda3..2b6e18f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java
+++ b/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java
@@ -24,6 +24,7 @@ import java.beans.*;
* <li><js>"FooBarURL"</js> -> <js>"fooBarURL"</js>
* <li><js>"URL"</js> -> <js>"URL"</js>
* </ul>
+ *
* <p>
* See {@link Introspector#decapitalize(String)} for exact rules.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java b/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
index 83f32ef..26961d9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
+++ b/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
@@ -27,6 +27,7 @@ import org.apache.juneau.parser.*;
/**
* A store for instantiating {@link Context} objects.
+ *
* <p>
* The hierarchy of these objects are...
* <ul class='spaced-list'>
@@ -321,9 +322,9 @@ public final class PropertyStore {
/**
* Copies the properties from the specified store into this store.
+ *
* <p>
- * Properties of type set/list/collection will be appended to the existing
- * properties if they already exist.
+ * Properties of type set/list/collection will be appended to the existing properties if they already exist.
*
* @param ps The store to copy from.
* @return This object (for method chaining).
@@ -351,15 +352,16 @@ public final class PropertyStore {
/**
* Sets a configuration property value on this object.
+ *
* <p>
* A typical usage is to set or overwrite configuration values like so...
* <p class='bcode'>
* PropertyStore ps = PropertyStore.<jsm>create</jsm>();
* ps.setProperty(<jsf>BEAN_sortProperties</jsf>, <jk>true</jk>);
* </p>
+ *
* <p>
* The possible class types of the value depend on the property type:
- * <p>
* <table class='styled'>
* <tr>
* <th>Property type</th>
@@ -434,6 +436,7 @@ public final class PropertyStore {
/**
* Convenience method for setting multiple properties in one call.
+ *
* <p>
* This appends to any previous configuration properties set on this store.
*
@@ -571,9 +574,11 @@ public final class PropertyStore {
/**
* Returns an instance of the specified context initialized with the properties in this store.
+ *
* <p>
* Multiple calls to this method for the same store class will return the same cached value as long as the
* properties on this store are not touched.
+ *
* <p>
* As soon as any properties are modified on this store, all cached entries are discarded and recreated as needed.
*
@@ -609,6 +614,7 @@ public final class PropertyStore {
/**
* Returns the configuration properties with the specified prefix.
+ *
* <p>
* For example, if <l>prefix</l> is <js>"BeanContext"</js>, then retrieves all configuration properties that are
* prefixed with <js>"BeanContext."</js>.
@@ -628,9 +634,11 @@ public final class PropertyStore {
/**
* Specifies the classloader to use when resolving classes from strings.
+ *
* <p>
* Can be used for resolving class names when the classes being created are in a different classloader from the
* Juneau code.
+ *
* <p>
* If <jk>null</jk>, the system classloader will be used to resolve classes.
*
@@ -644,6 +652,7 @@ public final class PropertyStore {
/**
* Specifies the parser to use to convert Strings to POJOs.
+ *
* <p>
* If <jk>null</jk>, {@link JsonParser#DEFAULT} will be used.
*
@@ -681,6 +690,7 @@ public final class PropertyStore {
/**
* Returns a property value either cast to the specified type, or a new instance of the specified type.
+ *
* <p>
* It's assumed that the current property value is either an instance of that type, or a <code>Class</code> that's
* a subclass of the type to be instantiated.
@@ -901,8 +911,10 @@ public final class PropertyStore {
/**
* Contains all the properties for a particular property prefix (e.g. <js>'BeanContext'</js>)
+ *
* <p>
* Instances of this map are immutable from outside this class.
+ *
* <p>
* The {@link PropertyMap#hashCode()} and {@link PropertyMap#equals(Object)} methods can be used to compare with
* other property maps.
@@ -975,6 +987,7 @@ public final class PropertyStore {
/**
* Returns the specified property as a map with the specified key and value types.
+ *
* <p>
* The map returned is an instance of {@link LinkedHashMap}.
*
@@ -1009,6 +1022,7 @@ public final class PropertyStore {
/**
* Convenience method for returning all values in this property map as a simple map.
+ *
* <p>
* Primarily useful for debugging.
*
@@ -1379,6 +1393,8 @@ public final class PropertyStore {
/**
* Returns true if a bean session is available.
+ *
+ * <p>
* Note that a bean session will not be available when constructing the BeanContext.DEFAULT context.
* (it's a chicken-and-egg thing).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Session.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Session.java b/juneau-core/src/main/java/org/apache/juneau/Session.java
index 43f0189..1bf8292 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Session.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Session.java
@@ -24,9 +24,10 @@ import org.apache.juneau.serializer.*;
/**
* A one-time-use non-thread-safe object that's meant to be used once and then thrown away.
+ *
* <p>
- * Serializers and parsers use session objects to retrieve config properties and to use it
- * as a scratchpad during serialize and parse actions.
+ * Serializers and parsers use session objects to retrieve config properties and to use it as a scratchpad during
+ * serialize and parse actions.
*
* @see PropertyStore
*/
@@ -43,8 +44,9 @@ public abstract class Session {
/**
* Default constructor.
*
- * @param ctx The context creating this session object.
- * The context contains all the configuration settings for the session.
+ * @param ctx
+ * The context creating this session object.
+ * The context contains all the configuration settings for the session.
* @param op Properties associated with this session.
*/
protected Session(final Context ctx, ObjectMap op) {
@@ -54,6 +56,7 @@ public abstract class Session {
/**
* Returns the session property with the specified key.
+ *
* <p>
* The order of lookup for the property is as follows:
* <ul>
@@ -113,6 +116,8 @@ public abstract class Session {
/**
* Adds an arbitrary object to this session's cache.
+ *
+ * <p>
* Can be used to store objects for reuse during a session.
*
* @param key The key. Can be any string.
@@ -126,10 +131,13 @@ public abstract class Session {
/**
* Adds arbitrary objects to this session's cache.
+ *
+ * <p>
* Can be used to store objects for reuse during a session.
*
- * @param cacheObjects The objects to add to this session's cache.
- * No-op if <jk>null</jk>.
+ * @param cacheObjects
+ * The objects to add to this session's cache.
+ * No-op if <jk>null</jk>.
*/
public void addToCache(Map<String,Object> cacheObjects) {
if (cacheObjects != null) {
@@ -184,6 +192,8 @@ public abstract class Session {
/**
* Returns the logger associated with this session.
+ *
+ * <p>
* Subclasses can override this method to provide their own logger.
*
* @return The logger associated with this session.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Streamable.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Streamable.java b/juneau-core/src/main/java/org/apache/juneau/Streamable.java
index 84fb539..3d98b92 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Streamable.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Streamable.java
@@ -18,9 +18,9 @@ import org.apache.juneau.http.*;
/**
* Interface that identifies that an object can be serialized directly to an output stream.
+ *
* <p>
- * Instances must identify the media type of the content by implementing the
- * {@link #getMediaType()} method.
+ * Instances must identify the media type of the content by implementing the {@link #getMediaType()} method.
*/
public interface Streamable {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/UriContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/UriContext.java b/juneau-core/src/main/java/org/apache/juneau/UriContext.java
index 1c8be0b..2890984 100644
--- a/juneau-core/src/main/java/org/apache/juneau/UriContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/UriContext.java
@@ -18,6 +18,7 @@ import org.apache.juneau.annotation.*;
/**
* Represents a URL broken into authority/context-root/servlet-path/path-info parts.
+ *
* <p>
* A typical request against a URL takes the following form:
* <p class='bcode'>
@@ -25,6 +26,7 @@ import org.apache.juneau.annotation.*;
* | authority | context | resource | path |
* +--------------------------------------------------+
* </p>
+ *
* <p>
* This class allows you to convert URL strings to absolute (e.g. <js>"http://host:port/foo/bar"</js>) or root-relative
* (e.g. <js>"/foo/bar"</js>) URLs.
@@ -34,6 +36,8 @@ public class UriContext {
/**
* Default URI context.
+ *
+ * <p>
* No information about authority, servlet-root, context-root, or path-info is known.
*/
public static final UriContext DEFAULT = new UriContext();
@@ -45,16 +49,21 @@ public class UriContext {
/**
* Constructor.
+ *
* <p>
* Leading and trailing slashes are trimmed of all parameters.
+ *
* <p>
* Any parameter can be <jk>null</jk>. Blanks and nulls are equivalent.
*
- * @param authority - The authority portion of URL (e.g. <js>"http://hostname:port"</js>)
- * @param contextRoot - The context root of the application (e.g. <js>"/context-root"</js>, or
- * <js>"context-root"</js>)
- * @param servletPath - The servlet path (e.g. <js>"/servlet-path"</js>, or <js>"servlet-path"</js>)
- * @param pathInfo - The path info (e.g. <js>"/path-info"</js>, or <js>"path-info"</js>)
+ * @param authority
+ * The authority portion of URL (e.g. <js>"http://hostname:port"</js>)
+ * @param contextRoot
+ * The context root of the application (e.g. <js>"/context-root"</js>, or <js>"context-root"</js>)
+ * @param servletPath
+ * The servlet path (e.g. <js>"/servlet-path"</js>, or <js>"servlet-path"</js>)
+ * @param pathInfo
+ * The path info (e.g. <js>"/path-info"</js>, or <js>"path-info"</js>)
*/
@BeanConstructor(properties="authority,contextRoot,servletPath,pathInfo")
public UriContext(String authority, String contextRoot, String servletPath, String pathInfo) {
@@ -68,6 +77,8 @@ public class UriContext {
/**
* Default constructor.
+ *
+ * <p>
* All <jk>null</jk> values.
*/
public UriContext() {
@@ -76,12 +87,15 @@ public class UriContext {
/**
* Returns the absolute URI of just the authority portion of this URI context.
+ *
* <p>
* Example: <js>"http://hostname:port"</js>
+ *
* <p>
* If the authority is null/empty, returns <js>"/"</js>.
*
- * @return The absolute URI of just the authority portion of this URI context.
+ * @return
+ * The absolute URI of just the authority portion of this URI context.
* Never <jk>null</jk>.
*/
public String getAbsoluteAuthority() {
@@ -90,10 +104,12 @@ public class UriContext {
/**
* Returns the absolute URI of the context-root portion of this URI context.
+ *
* <p>
* Example: <js>"http://hostname:port/context-root"</js>
*
- * @return The absolute URI of the context-root portion of this URI context.
+ * @return
+ * The absolute URI of the context-root portion of this URI context.
* Never <jk>null</jk>.
*/
public String getAbsoluteContextRoot() {
@@ -112,10 +128,12 @@ public class UriContext {
/**
* Returns the root-relative URI of the context portion of this URI context.
+ *
* <p>
* Example: <js>"/context-root"</js>
*
- * @return The root-relative URI of the context portion of this URI context.
+ * @return
+ * The root-relative URI of the context portion of this URI context.
* Never <jk>null</jk>.
*/
public String getRootRelativeContextRoot() {
@@ -126,10 +144,12 @@ public class UriContext {
/**
* Returns the absolute URI of the resource portion of this URI context.
+ *
* <p>
* Example: <js>"http://hostname:port/context-root/servlet-path"</js>
*
- * @return The absolute URI of the resource portion of this URI context.
+ * @return
+ * The absolute URI of the resource portion of this URI context.
* Never <jk>null</jk>.
*/
public String getAbsoluteServletPath() {
@@ -156,10 +176,12 @@ public class UriContext {
/**
* Returns the root-relative URI of the resource portion of this URI context.
+ *
* <p>
* Example: <js>"/context-root/servlet-path"</js>
*
- * @return The root-relative URI of the resource portion of this URI context.
+ * @return
+ * The root-relative URI of the resource portion of this URI context.
* Never <jk>null</jk>.
*/
public String getRootRelativeServletPath() {
@@ -200,10 +222,12 @@ public class UriContext {
/**
* Returns the absolute URI of the path portion of this URI context.
+ *
* <p>
* Example: <js>"http://hostname:port/context-root/servlet-path/path-info"</js>
*
- * @return The absolute URI of the path portion of this URI context.
+ * @return
+ * The absolute URI of the path portion of this URI context.
* Never <jk>null</jk>.
*/
public String getAbsolutePathInfo() {
@@ -244,10 +268,12 @@ public class UriContext {
/**
* Returns the root-relative URI of the path portion of this URI context.
+ *
* <p>
* Example: <js>"/context-root/servlet-path/path-info"</js>
*
- * @return The root-relative URI of the path portion of this URI context.
+ * @return
+ * The root-relative URI of the path portion of this URI context.
* Never <jk>null</jk>.
*/
public String getRootRelativePathInfo() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/UriResolver.java b/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
index b279cef..a82e6c6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
+++ b/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
@@ -24,15 +24,17 @@ import org.apache.juneau.internal.*;
/**
* Class used to create absolute and root-relative URIs based on your current URI 'location' and rules about how to
* make such resolutions.
+ *
* <p>
* Combines a {@link UriContext} instance with rules for resolution ({@link UriResolution} and relativity
- * ({@link UriRelativity}) to define simple {@link #resolve(Object)} and {@link #append(Appendable, Object)}
- * methods.
- * <p>
+ * ({@link UriRelativity}) to define simple {@link #resolve(Object)} and {@link #append(Appendable, Object)} methods.
+ *
+ * <p>
* Three special protocols are used to represent context-root-relative, servlet-relative, and request-path-relative
* URIs:
* <js>"context:/"</js>, <js>"servlet:/"</js>, and <js>"request:/"</js>.
*
+ * <p>
* The following list shows the protocols of URLs that can be resolved with this class:
* <ul>
* <li><js>"foo://foo"</js> - Absolute URI.
@@ -74,7 +76,8 @@ public class UriResolver {
/**
* Converts the specified URI to absolute form based on values in this context.
*
- * @param uri The URI to convert to absolute form.
+ * @param uri
+ * The URI to convert to absolute form.
* Can be any of the following:
* <ul>
* <li>{@link java.net.URI}
@@ -114,9 +117,11 @@ public class UriResolver {
/**
* Relativizes a URI.
+ *
* <p>
- * Similar to {@link URI#relativize(URI)}, except supports special protocols (e.g. <js>"servlet:/"</js>) for
- * both the <code>relativeTo</code> and <code>uri</code> parameters.
+ * Similar to {@link URI#relativize(URI)}, except supports special protocols (e.g. <js>"servlet:/"</js>) for both
+ * the <code>relativeTo</code> and <code>uri</code> parameters.
+ *
* <p>
* For example, to relativize a URI to its servlet-relative form:
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Visibility.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Visibility.java b/juneau-core/src/main/java/org/apache/juneau/Visibility.java
index 59f9fee..5a03b5b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Visibility.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Visibility.java
@@ -16,8 +16,11 @@ import java.lang.reflect.*;
/**
* Defines class/field/method visibilities.
+ *
* <p>
* Used to specify minimum levels of visibility when detecting bean classes, methods, and fields.
+ *
+ * <p>
* Used in conjunction with the following bean context properties:
* <ul>
* <li>{@link BeanContext#BEAN_beanConstructorVisibility}
@@ -99,10 +102,13 @@ public enum Visibility {
/**
* Makes constructor accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't.
+ *
+ * <p>
* Security exceptions thrown on the call to {@link Constructor#setAccessible(boolean)} are quietly ignored.
*
* @param x The constructor.
- * @return The same constructor if visibility requirements met, or <jk>null</jk> if visibility requirement not
+ * @return
+ * The same constructor if visibility requirements met, or <jk>null</jk> if visibility requirement not
* met or call to {@link Constructor#setAccessible(boolean)} throws a security exception.
*/
public <T> Constructor<T> transform(Constructor<T> x) {
@@ -116,10 +122,13 @@ public enum Visibility {
/**
* Makes method accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't.
+ *
+ * <p>
* Security exceptions thrown on the call to {@link Method#setAccessible(boolean)} are quietly ignored.
*
* @param x The method.
- * @return The same method if visibility requirements met, or <jk>null</jk> if visibility requirement not
+ * @return
+ * The same method if visibility requirements met, or <jk>null</jk> if visibility requirement not
* met or call to {@link Method#setAccessible(boolean)} throws a security exception.
*/
public <T> Method transform(Method x) {
@@ -133,10 +142,13 @@ public enum Visibility {
/**
* Makes field accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't.
+ *
+ * <p>
* Security exceptions thrown on the call to {@link Field#setAccessible(boolean)} are quietly ignored.
*
* @param x The field.
- * @return The same field if visibility requirements met, or <jk>null</jk> if visibility requirement not
+ * @return
+ * The same field if visibility requirements met, or <jk>null</jk> if visibility requirement not
* met or call to {@link Field#setAccessible(boolean)} throws a security exception.
*/
public Field transform(Field x) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Writable.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Writable.java b/juneau-core/src/main/java/org/apache/juneau/Writable.java
index bd9298f..656cf37 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Writable.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Writable.java
@@ -18,9 +18,9 @@ import org.apache.juneau.http.*;
/**
* Interface that identifies that an object can be serialized directly to a writer.
+ *
* <p>
- * Instances must identify the media type of the content by implementing the
- * {@link #getMediaType()} method.
+ * Instances must identify the media type of the content by implementing the {@link #getMediaType()} method.
*/
public interface Writable {