http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/BeanSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanSession.java b/juneau-core/src/main/java/org/apache/juneau/BeanSession.java index abc9959..b033324 100644 --- a/juneau-core/src/main/java/org/apache/juneau/BeanSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/BeanSession.java @@ -45,13 +45,13 @@ public class BeanSession extends Session { * Create a new session using properties specified in the context. * * @param op The override properties. - * These override any context properties defined in the context. + * These override any context properties defined in the context. * @param ctx The context creating this session object. - * The context contains all the configuration settings for this object. + * The context contains all the configuration settings for this object. * @param locale The session locale. - * If <jk>null</jk>, then the locale defined on the context is used. + * If <jk>null</jk>, then the locale defined on the context is used. * @param timeZone The session timezone. - * If <jk>null</jk>, then the timezone defined on the context is used. + * If <jk>null</jk>, then the timezone defined on the context is used. * @param mediaType The session media type (e.g. <js>"application/json"</js>). */ protected BeanSession(BeanContext ctx, ObjectMap op, Locale locale, TimeZone timeZone, MediaType mediaType) { @@ -124,7 +124,7 @@ public class BeanSession extends Session { /** * Converts the specified value to the specified class type. * <p> - * See {@link #convertToType(Object, ClassMeta)} for the list of valid conversions. + * See {@link #convertToType(Object, ClassMeta)} for the list of valid conversions. * * @param <T> The class type to convert the value to. * @param value The value to convert. @@ -145,7 +145,7 @@ public class BeanSession extends Session { * * @param <T> The class type to convert the value to. * @param outer If class is a member class, this is the instance of the containing class. - * Should be <jk>null</jk> if not a member class. + * Should be <jk>null</jk> if not a member class. * @param value The value to convert. * @param type The class type to convert the value to. * @throws InvalidDataConversionException If the specified value cannot be converted to the specified type. @@ -158,10 +158,10 @@ public class BeanSession extends Session { /** * Casts the specified value into the specified type. * <p> - * If the value isn't an instance of the specified type, then converts + * If the value isn't an instance of the specified type, then converts * the value if possible.<br> * <p> - * The following conversions are valid: + * The following conversions are valid: * <table class='styled'> * <tr><th>Convert to type</th><th>Valid input value types</th><th>Notes</th></tr> * <tr> @@ -298,7 +298,7 @@ public class BeanSession extends Session { * * @param <T> The class type to convert the value to. * @param outer If class is a member class, this is the instance of the containing class. - * Should be <jk>null</jk> if not a member class. + * Should be <jk>null</jk> if not a member class. * @param value The value to convert. * @param type The class type to convert the value to. * @throws InvalidDataConversionException If the specified value cannot be converted to the specified type. @@ -583,9 +583,9 @@ public class BeanSession extends Session { /** * Converts the contents of the specified list into an array. * <p> - * Works on both object and primitive arrays. + * Works on both object and primitive arrays. * <p> - * In the case of multi-dimensional arrays, the incoming list must + * In the case of multi-dimensional arrays, the incoming list must * contain elements of type n-1 dimension. i.e. if {@code type} is <code><jk>int</jk>[][]</code> * then {@code list} must have entries of type <code><jk>int</jk>[]</code>. * @@ -621,7 +621,7 @@ public class BeanSession extends Session { /** * Wraps an object inside a {@link BeanMap} object (i.e. a modifiable {@link Map}). * <p> - * If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a bean. + * If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a bean. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -663,7 +663,7 @@ public class BeanSession extends Session { * Wraps an object inside a {@link BeanMap} object (i.e.: a modifiable {@link Map}) * defined as a bean for one of its class, a super class, or an implemented interface. * <p> - * If object is not a true bean, throws a {@link BeanRuntimeException} with an explanation of why it's not a bean. + * If object is not a true bean, throws a {@link BeanRuntimeException} with an explanation of why it's not a bean. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -701,7 +701,7 @@ public class BeanSession extends Session { /** * Creates a new {@link BeanMap} object (i.e. a modifiable {@link Map}) of the given class with uninitialized property values. * <p> - * If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a bean. + * If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a bean. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -724,7 +724,7 @@ public class BeanSession extends Session { * @param <T> The class of the object being wrapped. * @param c The name of the class to create a new instance of. * @param outer If class is a member class, this is the instance of the containing class. - * Should be <jk>null</jk> if not a member class. + * Should be <jk>null</jk> if not a member class. * @return A new instance of the class. */ public final <T> BeanMap<T> newBeanMap(Object outer, Class<T> c) { @@ -763,7 +763,7 @@ public class BeanSession extends Session { * @param <T> The class type of the bean being created. * @param c The class type of the bean being created. * @param outer If class is a member class, this is the instance of the containing class. - * Should be <jk>null</jk> if not a member class. + * Should be <jk>null</jk> if not a member class. * @return A new bean object. * @throws BeanRuntimeException If the specified class is not a valid bean. */
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java b/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java index c1c2e72..7cf4180 100644 --- a/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java +++ b/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java @@ -35,16 +35,16 @@ import org.apache.juneau.utils.*; * about that class. * * <p> - * Instances of this class can be created through the {@link BeanContext#getClassMeta(Class)} method. + * Instances of this class can be created through the {@link BeanContext#getClassMeta(Class)} method. * <p> - * The {@link BeanContext} class will cache and reuse instances of this class except for the following class types: + * The {@link BeanContext} class will cache and reuse instances of this class except for the following class types: * <ul> * <li>Arrays * <li>Maps with non-Object key/values. * <li>Collections with non-Object key/values. * </ul> * <p> - * This class is tied to the {@link BeanContext} class because it's that class that makes the determination + * This class is tied to the {@link BeanContext} class because it's that class that makes the determination * of what is a bean. * * @param <T> The class type of the wrapped class. @@ -121,16 +121,16 @@ public final class ClassMeta<T> implements Type { * @param innerClass The class being wrapped. * @param beanContext The bean context that created this object. * @param implClass For interfaces and abstract classes, this represents the "real" class to instantiate. - * Can be <jk>null</jk>. + * Can be <jk>null</jk>. * @param beanFilter The {@link BeanFilter} programmatically associated with this class. - * Can be <jk>null</jk>. + * Can be <jk>null</jk>. * @param pojoSwap The {@link PojoSwap} programmatically associated with this class. - * Can be <jk>null</jk>. + * Can be <jk>null</jk>. * @param childPojoSwap The child {@link PojoSwap PojoSwaps} programmatically associated with this class. - * These are the <code>PojoSwaps</code> that have normal classes that are subclasses of this class. - * Can be <jk>null</jk>. + * These are the <code>PojoSwaps</code> that have normal classes that are subclasses of this class. + * Can be <jk>null</jk>. * @param delayedInit Don't call init() in constructor. - * Used for delayed initialization when the possibility of class reference loops exist. + * Used for delayed initialization when the possibility of class reference loops exist. */ @SuppressWarnings({ "rawtypes", "unchecked" }) ClassMeta(Class<T> innerClass, BeanContext beanContext, Class<? extends T> implClass, BeanFilter beanFilter, PojoSwap<T,?> pojoSwap, PojoSwap<?,?>[] childPojoSwaps) { @@ -629,7 +629,7 @@ public final class ClassMeta<T> implements Type { * Returns the resolved bean dictionary name associated with this class. * <p> * Unlike {@link #getDictionaryName()}, this method automatically resolves multidimensional arrays - * (e.g. <js>"X^^"</js> and returns array class metas accordingly if the base class has a type name. + * (e.g. <js>"X^^"</js> and returns array class metas accordingly if the base class has a type name. * * @return The type name associated with this bean class, or <jk>null</jk> if there is no type name defined or this isn't a bean. */ @@ -1026,7 +1026,7 @@ public final class ClassMeta<T> implements Type { /** * Returns <jk>true</jk> if instance of this object can be <jk>null</jk>. * <p> - * Objects can be <jk>null</jk>, but primitives cannot, except for chars which can be represented + * Objects can be <jk>null</jk>, but primitives cannot, except for chars which can be represented * by <code>(<jk>char</jk>)0</code>. * * @return <jk>true</jk> if instance of this class can be null. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/Context.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/Context.java b/juneau-core/src/main/java/org/apache/juneau/Context.java index fe151cb..6005ee9 100644 --- a/juneau-core/src/main/java/org/apache/juneau/Context.java +++ b/juneau-core/src/main/java/org/apache/juneau/Context.java @@ -19,12 +19,12 @@ import org.apache.juneau.serializer.*; /** * A reusable stateless thread-safe read-only configuration, typically used for creating one-time use {@link Session} objects. * <p> - * Contexts are created through the {@link ContextFactory#getContext(Class)} method. + * Contexts are created through the {@link ContextFactory#getContext(Class)} method. * <p> - * Subclasses MUST implement a constructor method that takes in a {@link ContextFactory} parameter. - * Besides that restriction, a context object can do anything you desire. However, it MUST - * be thread-safe and all fields should be declared final to prevent modification. - * It should NOT be used for storing temporary or state information. + * Subclasses MUST implement a constructor method that takes in a {@link ContextFactory} parameter. + * Besides that restriction, a context object can do anything you desire. However, it MUST + * be thread-safe and all fields should be declared final to prevent modification. + * It should NOT be used for storing temporary or state information. * * @see ContextFactory */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/ContextFactory.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/ContextFactory.java b/juneau-core/src/main/java/org/apache/juneau/ContextFactory.java index fff9e21..6dcde7b 100644 --- a/juneau-core/src/main/java/org/apache/juneau/ContextFactory.java +++ b/juneau-core/src/main/java/org/apache/juneau/ContextFactory.java @@ -26,94 +26,94 @@ import org.apache.juneau.parser.*; /** * A factory for instantiating {@link Context} objects. * <p> - * The hierarchy of these objects are... - * <ul class='spaced-list'> - * <li>{@link ContextFactory} - A thread-safe, modifiable context property store.<br> - * Used to create {@link Context} objects. - * <li>{@link Context} - A reusable, cachable, thread-safe, read-only context with configuration properties copied from the factory.<br> - * Often used to create {@link Session} objects. - * <li>{@link Session} - A one-time-use non-thread-safe object.<br> - * Used by serializers and parsers to retrieve context properties and to be used as scratchpads. - * </ul> + * The hierarchy of these objects are... + * <ul class='spaced-list'> + * <li>{@link ContextFactory} - A thread-safe, modifiable context property store.<br> + * Used to create {@link Context} objects. + * <li>{@link Context} - A reusable, cachable, thread-safe, read-only context with configuration properties copied from the factory.<br> + * Often used to create {@link Session} objects. + * <li>{@link Session} - A one-time-use non-thread-safe object.<br> + * Used by serializers and parsers to retrieve context properties and to be used as scratchpads. + * </ul> * * <h6 class='topic'>ContextFactory objects</h6> * <p> - * Context factories can be thought of as consisting of the following: - * <ul class='spaced-list'> - * <li>A <code>Map<String,Object></code> of context properties. - * <li>A <code>Map<Class,Context></code> of context instances. - * </ul> + * Context factories can be thought of as consisting of the following: + * <ul class='spaced-list'> + * <li>A <code>Map<String,Object></code> of context properties. + * <li>A <code>Map<Class,Context></code> of context instances. + * </ul> * <p> - * Context factories are used to create and cache {@link Context} objects using the {@link #getContext(Class)} method. + * Context factories are used to create and cache {@link Context} objects using the {@link #getContext(Class)} method. * <p> - * As a general rule, {@link ContextFactory} objects are 'slow'.<br> - * Setting and retrieving properties on a factory can involve relatively slow data conversion and synchronization.<br> - * However, the {@link #getContext(Class)} method is fast, and will return cached context objects if the context properties have not changed. + * As a general rule, {@link ContextFactory} objects are 'slow'.<br> + * Setting and retrieving properties on a factory can involve relatively slow data conversion and synchronization.<br> + * However, the {@link #getContext(Class)} method is fast, and will return cached context objects if the context properties have not changed. * <p> - * Context factories can be used to store context properties for a variety of contexts.<br> - * For example, a single factory can store context properties for the JSON serializer, XML serializer, HTML serializer + * Context factories can be used to store context properties for a variety of contexts.<br> + * For example, a single factory can store context properties for the JSON serializer, XML serializer, HTML serializer * etc... and can thus be used to retrieve context objects for those serializers.<br> * <p> - * Other notes: - * <ul class='spaced-list'> - * <li>Context factories can be locked using the {@link #lock()} method.<br> - * This prevents the context properties from being further modified. - * <li>Context factories can be cloned using the {@link #clone} method.<br> - * This will return a new unlocked factory with the same context properties. - * </ul> + * Other notes: + * <ul class='spaced-list'> + * <li>Context factories can be locked using the {@link #lock()} method.<br> + * This prevents the context properties from being further modified. + * <li>Context factories can be cloned using the {@link #clone} method.<br> + * This will return a new unlocked factory with the same context properties. + * </ul> * * <h6 class='topic'>Context properties</h6> * <p> - * Context properties are 'settings' for serializers and parsers.<br> - * For example, the {@link BeanContext#BEAN_sortProperties} context property defines whether + * Context properties are 'settings' for serializers and parsers.<br> + * For example, the {@link BeanContext#BEAN_sortProperties} context property defines whether * bean properties should be serialized in alphabetical order. * <p> - * Each {@link Context} object should contain the context properties that apply to it as static + * Each {@link Context} object should contain the context properties that apply to it as static * fields (e.g {@link BeanContext#BEAN_sortProperties}). * <p> - * Context properties can be of the following types: - * <ul class='spaced-list'> - * <li><l>SIMPLE</l> - A simple property.<br> - * Examples include: booleans, integers, Strings, Classes, etc...<br> - * <br> - * An example of this would be the {@link BeanContext#BEAN_sortProperties} property.<br> - * It's name is simply <js>"BeanContext.sortProperties"</js>. + * Context properties can be of the following types: + * <ul class='spaced-list'> + * <li><l>SIMPLE</l> - A simple property.<br> + * Examples include: booleans, integers, Strings, Classes, etc...<br> + * <br> + * An example of this would be the {@link BeanContext#BEAN_sortProperties} property.<br> + * It's name is simply <js>"BeanContext.sortProperties"</js>. + * + * <li><l>SET</l> - A sorted set of objects.<br> + * These are denoted by appending <js>".set"</js> to the property name.<br> + * Objects can be of any type, even complex types.<br> + * Sorted sets use tree sets to maintain the value in alphabetical order.<br> + * <br> + * For example, the {@link BeanContext#BEAN_notBeanClasses} property is used to store classes that should not be treated like beans.<br> + * It's name is <js>"BeanContext.notBeanClasses.set"</js>. * - * <li><l>SET</l> - A sorted set of objects.<br> - * These are denoted by appending <js>".set"</js> to the property name.<br> - * Objects can be of any type, even complex types.<br> - * Sorted sets use tree sets to maintain the value in alphabetical order.<br> - * <br> - * For example, the {@link BeanContext#BEAN_notBeanClasses} property is used to store classes that should not be treated like beans.<br> - * It's name is <js>"BeanContext.notBeanClasses.set"</js>. + * <li><l>LIST</l> - A list of unique objects.<br> + * These are denoted by appending <js>".list"</js> to the property name.<br> + * Objects can be of any type, even complex types.<br> + * Use lists if the ordering of the values in the set is important (similar to how the order of entries in a classpath is important).<br> + * <br> + * For example, the {@link BeanContext#BEAN_beanFilters} property is used to store bean filters.<br> + * It's name is <js>"BeanContext.transforms.list"</js>. * - * <li><l>LIST</l> - A list of unique objects.<br> - * These are denoted by appending <js>".list"</js> to the property name.<br> - * Objects can be of any type, even complex types.<br> - * Use lists if the ordering of the values in the set is important (similar to how the order of entries in a classpath is important).<br> - * <br> - * For example, the {@link BeanContext#BEAN_beanFilters} property is used to store bean filters.<br> - * It's name is <js>"BeanContext.transforms.list"</js>. - * - * <li><l>MAP</l> - A sorted map of key-value pairs.<br> - * These are denoted by appending <js>".map"</js> to the property name.<br> - * Keys can be any type directly convertable to and from Strings. - * Values can be of any type, even complex types.<br> - * <br> - * For example, the {@link BeanContext#BEAN_implClasses} property is used to specify the names of implementation classes for interfaces.<br> - * It's name is <js>"BeanContext.implClasses.map"</js>.<br> - * </ul> + * <li><l>MAP</l> - A sorted map of key-value pairs.<br> + * These are denoted by appending <js>".map"</js> to the property name.<br> + * Keys can be any type directly convertable to and from Strings. + * Values can be of any type, even complex types.<br> + * <br> + * For example, the {@link BeanContext#BEAN_implClasses} property is used to specify the names of implementation classes for interfaces.<br> + * It's name is <js>"BeanContext.implClasses.map"</js>.<br> + * </ul> * <p> - * All context properties are set using the {@link #setProperty(String, Object)} method. + * All context properties are set using the {@link #setProperty(String, Object)} method. * <p> - * Default values for context properties can be specified globally as system properties.<br> - * Example: <code>System.<jsm>setProperty</jsm>(<jsf>BEAN_sortProperties</jsf>, <jk>true</jk>);</code> + * Default values for context properties can be specified globally as system properties.<br> + * Example: <code>System.<jsm>setProperty</jsm>(<jsf>BEAN_sortProperties</jsf>, <jk>true</jk>);</code> * <p> - * SET and LIST properties can be added to using the {@link #addToProperty(String, Object)} method and removed from using the {@link #removeFromProperty(String, Object)} method. + * SET and LIST properties can be added to using the {@link #addToProperty(String, Object)} method and removed from using the {@link #removeFromProperty(String, Object)} method. * <p> - * SET and LIST properties can also be added to and removed from by appending <js>".add"</js> or <js>".remove"</js> to the property name and using the {@link #setProperty(String, Object)} method. + * SET and LIST properties can also be added to and removed from by appending <js>".add"</js> or <js>".remove"</js> to the property name and using the {@link #setProperty(String, Object)} method. * <p> - * The following shows the two different ways to append to a set or list property: + * The following shows the two different ways to append to a set or list property: * <p class='bcode'> * Config config = <jk>new</jk> Config().set(<js>"BeanContext.notBeanClasses.set"</js>, Collections.<jsm>emptySet</jsm>()); * @@ -124,10 +124,10 @@ import org.apache.juneau.parser.*; * config.set(<js>"BeanContext.notBeanClasses.set.add"</js>, MyNotBeanClass.<jk>class</jk>); * </p> * <p> - * Lists are appended to the beginning of the set so that behavior can be overridden.<br> + * Lists are appended to the beginning of the set so that behavior can be overridden.<br> * <p> - * For sample, the following code shows the order in which POJO swaps are applied.<br> - * In this case, we want F3 and F4 to appear at the beginning of the set so that they + * For sample, the following code shows the order in which POJO swaps are applied.<br> + * In this case, we want F3 and F4 to appear at the beginning of the set so that they * take precedence over F1 and F2.... * <p class='bcode'> * <jc>// Result will be F3,F4,F1,F2</jc> @@ -135,7 +135,7 @@ import org.apache.juneau.parser.*; * config.addTo(<js>"BeanContext.transforms.list"</js>, Arrays.<jsm>asList</jsm>(F3.<jk>class</jk>,F4.<jk>class</jk>)); * </p> * <p> - * SET and LIST properties can also be set and manipulated using JSON strings. + * SET and LIST properties can also be set and manipulated using JSON strings. * <p class='bcode'> * ContextFactory f = ContextFactory.<jsm>create</jsm>(); * @@ -152,11 +152,11 @@ import org.apache.juneau.parser.*; * f.removeFrom(<js>"BeanContext.notBeanClasses.set"</js>, <js>"['com.my.MyNotBeanClass3']"</js>); * </p> * <p> - * MAP properties can be added to using the {@link #putToProperty(String, Object, Object)} and {@link #putToProperty(String, Object)} methods.<br> - * MAP property entries can be removed by setting the value to <jk>null</jk> (e.g. <code>config.putTo(<js>"BEAN_implClasses"</js>, MyNotBeanClass.<jk>class</jk>, <jk>null</jk>);</code>.<br> - * MAP properties can also be added to by appending <js>".put"</js> to the property name and using the {@link #setProperty(String, Object)} method.<br> + * MAP properties can be added to using the {@link #putToProperty(String, Object, Object)} and {@link #putToProperty(String, Object)} methods.<br> + * MAP property entries can be removed by setting the value to <jk>null</jk> (e.g. <code>config.putTo(<js>"BEAN_implClasses"</js>, MyNotBeanClass.<jk>class</jk>, <jk>null</jk>);</code>.<br> + * MAP properties can also be added to by appending <js>".put"</js> to the property name and using the {@link #setProperty(String, Object)} method.<br> * <p> - * The following shows the two different ways to append to a set property: + * The following shows the two different ways to append to a set property: * <p class='bcode'> * ContextFactory f = ContextFactory.<jsm>create</jsm>().set(<js>"BeanContext.implClasses.map"</js>, Collections.<jsm>emptyMap</jsm>()); * @@ -168,7 +168,7 @@ import org.apache.juneau.parser.*; * f.set(<js>"BeanContext.implClasses.map.put"</js>, m); * </p> * <p> - * MAP properties can also be set and manipulated using JSON strings. + * MAP properties can also be set and manipulated using JSON strings. * <p class='bcode'> * ContextFactory f = ContextFactory.<jsm>create</jsm>(); * @@ -182,23 +182,23 @@ import org.apache.juneau.parser.*; * f.putTo(<js>"BeanContext.implClasses.map"</js>, <js>"{'com.my.MyInterface2':null}"</js>); * </p> * <p> - * Context properties are retrieved from this factory using the following 3 methods: - * <ul class='spaced-list'> - * <li>{@link #getProperty(String, Class, Object)} - Retrieve a SIMPLE or SET property converted to the specified class type. - * <li>{@link #getMap(String, Class, Class, Map)} - Retrieve a MAP property with keys/values converted to the specified class types. - * <li>{@link #getPropertyMap(String)} - Retrieve a map of all context properties with the specified prefix (e.g. <js>"BeanContext"</js> for {@link BeanContext} properties). - * </ul> + * Context properties are retrieved from this factory using the following 3 methods: + * <ul class='spaced-list'> + * <li>{@link #getProperty(String, Class, Object)} - Retrieve a SIMPLE or SET property converted to the specified class type. + * <li>{@link #getMap(String, Class, Class, Map)} - Retrieve a MAP property with keys/values converted to the specified class types. + * <li>{@link #getPropertyMap(String)} - Retrieve a map of all context properties with the specified prefix (e.g. <js>"BeanContext"</js> for {@link BeanContext} properties). + * </ul> * <p> - * As a general rule, only {@link Context} objects will use these read methods. + * As a general rule, only {@link Context} objects will use these read methods. * * <h6 class='topic'>Context objects</h6> * <p> - * A Context object can be thought of as unmodifiable snapshot of a factory.<br> - * They should be 'fast' by avoiding synchronization by using final fields whenever possible.<br> - * However, they MUST be thread safe. + * A Context object can be thought of as unmodifiable snapshot of a factory.<br> + * They should be 'fast' by avoiding synchronization by using final fields whenever possible.<br> + * However, they MUST be thread safe. * <p> - * Context objects are created using the {@link #getContext(Class)} method.<br> - * As long as the properties on a factory have not been modified, the factory will return a cached copy + * Context objects are created using the {@link #getContext(Class)} method.<br> + * As long as the properties on a factory have not been modified, the factory will return a cached copy * of a context. * <p class='bcode'> * ContextFactory f = ContextFactory.<jsm>create</jsm>(); @@ -220,12 +220,12 @@ import org.apache.juneau.parser.*; * * <h6 class='topic'>Session objects</h6> * <p> - * Session objects are created through {@link Context} objects, typically through a <code>createContext()</code> method.<br> - * Unlike context objects, they are NOT reusable and NOT thread safe.<br> - * They are meant to be used one time and then thrown away.<br> - * They should NEVER need to use synchronization. + * Session objects are created through {@link Context} objects, typically through a <code>createContext()</code> method.<br> + * Unlike context objects, they are NOT reusable and NOT thread safe.<br> + * They are meant to be used one time and then thrown away.<br> + * They should NEVER need to use synchronization. * <p> - * Session objects are also often used as scratchpads for information such as keeping track of call stack + * Session objects are also often used as scratchpads for information such as keeping track of call stack * information to detect recursive loops when serializing beans. */ public final class ContextFactory extends Lockable { @@ -315,13 +315,13 @@ public final class ContextFactory extends Lockable { /** * Sets a configuration property value on this object. * <p> - * A typical usage is to set or overwrite configuration values like so... + * A typical usage is to set or overwrite configuration values like so... * <p class='bcode'> * ContextFactory g = ContextFactory.<jsm>create</jsm>(); * f.setProperty(<jsf>BEAN_sortProperties</jsf>, <jk>true</jk>); * </p> * <p> - * The possible class types of the value depend on the property type: + * The possible class types of the value depend on the property type: * <p> * <table class='styled'> * <tr> @@ -357,16 +357,16 @@ public final class ContextFactory extends Lockable { * </table> * * @param name The configuration property name.<br> - * If name ends with <l>.add</l>, then the specified value is added to the - * existing property value as an entry in a SET or LIST property.<br> - * If name ends with <l>.put</l>, then the specified value is added to the - * existing property value as a key/value pair in a MAP property.<br> - * If name ends with <l>.remove</l>, then the specified value is removed from the - * existing property property value in a SET or LIST property.<br> + * If name ends with <l>.add</l>, then the specified value is added to the + * existing property value as an entry in a SET or LIST property.<br> + * If name ends with <l>.put</l>, then the specified value is added to the + * existing property value as a key/value pair in a MAP property.<br> + * If name ends with <l>.remove</l>, then the specified value is removed from the + * existing property property value in a SET or LIST property.<br> * * @param value The new value. - * If <jk>null</jk>, the property value is deleted.<br> - * In general, the value type can be anything.<br> + * If <jk>null</jk>, the property value is deleted.<br> + * In general, the value type can be anything.<br> * * @return This object (for method chaining). */ @@ -526,10 +526,10 @@ public final class ContextFactory extends Lockable { * Returns an instance of the specified context initialized with the properties * in this config. * <p> - * Multiple calls to this method for the same config class will return the same + * Multiple calls to this method for the same config class will return the same * cached value as long as the config properties on this config are not touched. * <p> - * As soon as any properties are modified on this config, all cached entries + * As soon as any properties are modified on this config, all cached entries * are discarded and recreated as needed. * * @param c The context class to instantiate. @@ -565,7 +565,7 @@ public final class ContextFactory extends Lockable { /** * Returns the configuration properties with the specified prefix. * <p> - * For example, if <l>prefix</l> is <js>"BeanContext"</js>, then retrieves + * For example, if <l>prefix</l> is <js>"BeanContext"</js>, then retrieves * all configuration properties that are prefixed with <js>"BeanContext."</js>. * * @param prefix The prefix of properties to retrieve. @@ -584,10 +584,10 @@ public final class ContextFactory extends Lockable { /** * 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 + * 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. + * If <jk>null</jk>, the system classloader will be used to resolve classes. * * @param classLoader The new classloader. * @throws LockedException If {@link #lock()} was called on this object. @@ -602,7 +602,7 @@ public final class ContextFactory extends Lockable { /** * Specifies the parser to use to convert Strings to POJOs. * <p> - * If <jk>null</jk>, {@link JsonParser#DEFAULT} will be used. + * If <jk>null</jk>, {@link JsonParser#DEFAULT} will be used. * * @param defaultParser The new defaultParser. * @throws LockedException If {@link #lock()} was called on this object. @@ -787,9 +787,9 @@ public final class ContextFactory extends Lockable { /** * 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. + * Instances of this map are immutable from outside this class. * <p> - * The {@link PropertyMap#hashCode()} and {@link PropertyMap#equals(Object)} methods + * The {@link PropertyMap#hashCode()} and {@link PropertyMap#equals(Object)} methods * can be used to compare with other property maps. */ @SuppressWarnings("hiding") http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/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 a648ad8..717f556 100644 --- a/juneau-core/src/main/java/org/apache/juneau/Delegate.java +++ b/juneau-core/src/main/java/org/apache/juneau/Delegate.java @@ -17,7 +17,7 @@ package org.apache.juneau; * <p> * <b>*** Internal Interface - Not intended for external use ***</b> * <p> - * For example, {@link BeanMap} is a map representation of a bean. + * For example, {@link BeanMap} is a map representation of a bean. * * @param <T> The represented class type. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/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 c97fc34..1336fb0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java +++ b/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java @@ -20,7 +20,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>. + * 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>. */ public final class InvalidDataConversionException extends RuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/MediaRange.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/MediaRange.java b/juneau-core/src/main/java/org/apache/juneau/MediaRange.java index 376fdee..c9295f0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/MediaRange.java +++ b/juneau-core/src/main/java/org/apache/juneau/MediaRange.java @@ -255,7 +255,7 @@ public final class MediaRange implements Comparable<MediaRange> { * * @param value The value to parse. If <jk>null</jk> or empty, returns a single <code>MediaRange</code> is returned that represents all types. * @return The media ranges described by the string. - * The ranges are sorted such that the most acceptable media is available at ordinal position <js>'0'</js>, and the least acceptable at position n-1. + * The ranges are sorted such that the most acceptable media is available at ordinal position <js>'0'</js>, and the least acceptable at position n-1. */ public static MediaRange[] parse(String value) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/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 d8526e8..a5d6148 100644 --- a/juneau-core/src/main/java/org/apache/juneau/ObjectList.java +++ b/juneau-core/src/main/java/org/apache/juneau/ObjectList.java @@ -23,10 +23,10 @@ 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 + * 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 + * 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 @@ -88,8 +88,7 @@ import org.apache.juneau.utils.*; * } * </p> * <p> - * This class is not thread safe. - * </p> + * This class is not thread safe. */ public class ObjectList extends LinkedList<Object> { private static final long serialVersionUID = 1L; @@ -236,7 +235,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. + * See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions. * * @param type The type of object to convert the entry to. * @param index The index into this list. @@ -338,7 +337,7 @@ 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. * <p> - * For example, the following code is equivalent: + * For example, the following code is equivalent: * </p> * <p class='bcode'> * ObjectMap m = getObjectMap(); @@ -350,9 +349,8 @@ public class ObjectList extends LinkedList<Object> { * <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). - * </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). * * @param <T> The class type. * @param type The class type. @@ -367,7 +365,7 @@ 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. * <p> - * For example, the following code is equivalent: + * For example, the following code is equivalent: * </p> * <p class='bcode'> * ObjectMap m = getObjectMap(); @@ -379,9 +377,8 @@ public class ObjectList extends LinkedList<Object> { * 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). - * </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). * * @param path The path to the entry. * @param o The new value. @@ -395,7 +392,7 @@ public class ObjectList extends LinkedList<Object> { * 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: + * For example, the following code is equivalent: * </p> * <p class='bcode'> * ObjectMap m = getObjectMap(); @@ -407,9 +404,8 @@ public class ObjectList extends LinkedList<Object> { * 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). - * </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). * * @param path The path to the entry. * @param o The new value. @@ -423,7 +419,7 @@ 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. * <p> - * For example, the following code is equivalent: + * For example, the following code is equivalent: * </p> * <p class='bcode'> * ObjectMap m = getObjectMap(); @@ -435,9 +431,8 @@ public class ObjectList extends LinkedList<Object> { * 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). - * </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). * * @param path The path to the entry. * @return The previous value, or <jk>null</jk> if the entry doesn't exist. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/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 502189a..08069a5 100644 --- a/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java +++ b/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java @@ -27,10 +27,10 @@ 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 + * 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 + * 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 @@ -94,8 +94,7 @@ import org.apache.juneau.utils.*; * <jk>int</jk> a = m2.getInt(<js>"a"</js>); <jc>// a == 1 </jc> * </p> * <p> - * This class is not thread safe. - * </p> + * This class is not thread safe. */ public class ObjectMap extends LinkedHashMap<String,Object> { private static final long serialVersionUID = 1L; @@ -238,7 +237,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> { * </p> * * @param inner The inner map. - * Can be <jk>null</jk> to remove the inner map from an existing map. + * Can be <jk>null</jk> to remove the inner map from an existing map. * @return This object (for method chaining). */ public ObjectMap setInner(ObjectMap inner) { @@ -296,7 +295,7 @@ 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 + * Equivalent to calling {@code put(key, value)}, but returns * this map so that the method can be chained. * * @param key The key. @@ -311,7 +310,7 @@ 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 + * 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. @@ -346,7 +345,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. + * See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions. * * @param <T> The class type. * @param type The class type. @@ -378,7 +377,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. + * See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions. * * @param <T> The class type. * @param type The class type. @@ -399,7 +398,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. + * See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions. * * @param <T> The class type. * @param type The class type. @@ -413,7 +412,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. + * See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions. * * @param <T> The class type. * @param type The class type. @@ -444,9 +443,9 @@ 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. + * Casts or converts the value to the specified class type. * <p> - * See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions. + * See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions. * * @param type The class type to convert the value to. * @param <T> The class type to convert the value to. @@ -464,7 +463,7 @@ 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. * <p> - * For example, the following code is equivalent: + * For example, the following code is equivalent: * </p> * <p class='bcode'> * ObjectMap m = getObjectMap(); @@ -476,9 +475,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> { * <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). - * </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). * * @param <T> The class type. * @param type The class type. @@ -493,7 +491,7 @@ 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. * <p> - * For example, the following code is equivalent: + * For example, the following code is equivalent: * </p> * <p class='bcode'> * ObjectMap m = getObjectMap(); @@ -505,9 +503,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> { * 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). - * </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). * * @param path The path to the entry. * @param o The new value. @@ -521,7 +518,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> { * 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: + * For example, the following code is equivalent: * </p> * <p class='bcode'> * ObjectMap m = getObjectMap(); @@ -533,9 +530,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> { * 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). - * </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). * * @param path The path to the entry. * @param o The new value. @@ -549,7 +545,7 @@ 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. * <p> - * For example, the following code is equivalent: + * For example, the following code is equivalent: * </p> * <p class='bcode'> * ObjectMap m = getObjectMap(); @@ -561,9 +557,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> { * 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). - * </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). * * @param path The path to the entry. * @return The previous value, or <jk>null</jk> if the entry doesn't exist. @@ -575,7 +570,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>). + * The JSON text can be an object (i.e. <js>"{...}"</js>) or an array (i.e. <js>"[...]"</js>). * * @param key The key. * @param json The JSON text that will be parsed into an Object and then inserted into this map. @@ -588,7 +583,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>. + * Shortcut for <code>get(String.<jk>class</jk>, key)</code>. * * @param key The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -625,7 +620,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>. + * Shortcut for <code>get(String.<jk>class</jk>, key, defVal)</code>. * * @param key The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -638,7 +633,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>. + * Shortcut for <code>get(Integer.<jk>class</jk>, key)</code>. * * @param key The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -651,7 +646,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>. + * Shortcut for <code>get(Integer.<jk>class</jk>, key, defVal)</code>. * * @param key The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -665,7 +660,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>. + * Shortcut for <code>get(Long.<jk>class</jk>, key)</code>. * * @param key The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -678,7 +673,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>. + * Shortcut for <code>get(Long.<jk>class</jk>, key, defVal)</code>. * * @param key The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -692,7 +687,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>. + * Shortcut for <code>get(Boolean.<jk>class</jk>, key)</code>. * * @param key The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -705,7 +700,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>. + * Shortcut for <code>get(Boolean.<jk>class</jk>, key, defVal)</code>. * * @param key The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -719,7 +714,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>. + * Shortcut for <code>get(Map.<jk>class</jk>, key)</code>. * * @param key The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -732,7 +727,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>. + * Shortcut for <code>get(Map.<jk>class</jk>, key, defVal)</code>. * * @param key The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -746,7 +741,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>. + * Shortcut for <code>get(List.<jk>class</jk>, key)</code>. * * @param key The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -759,7 +754,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>. + * Shortcut for <code>get(List.<jk>class</jk>, key, defVal)</code>. * * @param key The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -773,7 +768,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>. + * Shortcut for <code>get(ObjectMap.<jk>class</jk>, key)</code>. * * @param key The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -786,7 +781,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>. + * Shortcut for <code>get(ObjectMap.<jk>class</jk>, key, defVal)</code>. * * @param key The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -800,7 +795,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>. + * Shortcut for <code>get(ObjectList.<jk>class</jk>, key)</code>. * * @param key The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -813,7 +808,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>. + * Shortcut for <code>get(ObjectList.<jk>class</jk>, key, defVal)</code>. * * @param key The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -827,7 +822,7 @@ 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>. + * 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, @@ -840,7 +835,7 @@ 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>. + * 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, @@ -854,7 +849,7 @@ 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>. + * 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, @@ -868,7 +863,7 @@ 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>. + * 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, @@ -882,7 +877,7 @@ 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>. + * 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, @@ -896,7 +891,7 @@ 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>. + * 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, @@ -910,7 +905,7 @@ 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>. + * 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, @@ -924,7 +919,7 @@ 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>. + * 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, @@ -1088,7 +1083,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> { * Same as {@link #cast()}, but first do a lookup for the name in the specified dictionary. * * @param beanRegistry - * The class lexicon to resolve the name. Can be <jk>null</jk>. + * The class lexicon to resolve the name. Can be <jk>null</jk>. * @return The new Java object of type specified by the <js>"_type"</js> entry value, or this * same object if entry does not exist. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/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 1a64676..19dcda3 100644 --- a/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java +++ b/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java @@ -25,7 +25,7 @@ import java.beans.*; * <li><js>"URL"</js> -> <js>"URL"</js> * </ul> * <p> - * See {@link Introspector#decapitalize(String)} for exact rules. + * See {@link Introspector#decapitalize(String)} for exact rules. */ public final class PropertyNamerDefault implements PropertyNamer { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/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 fe33eb2..b870421 100644 --- a/juneau-core/src/main/java/org/apache/juneau/Session.java +++ b/juneau-core/src/main/java/org/apache/juneau/Session.java @@ -41,7 +41,7 @@ public abstract class Session { * Default constructor. * * @param ctx The context creating this session object. - * The context contains all the configuration settings for the session. + * The context contains all the configuration settings for the session. * @param op Properties associated with this session. */ protected Session(Context ctx, ObjectMap op) { @@ -75,7 +75,7 @@ public abstract class Session { * 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>. + * No-op if <jk>null</jk>. */ public void addToCache(Map<String,Object> cacheObjects) { if (cacheObjects != null) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/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 3a2b9e0..9dc9b44 100644 --- a/juneau-core/src/main/java/org/apache/juneau/Streamable.java +++ b/juneau-core/src/main/java/org/apache/juneau/Streamable.java @@ -17,9 +17,8 @@ import java.io.*; /** * 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 + * Instances must identify the media type of the content by implementing the * {@link #getMediaType()} method. - * </p> */ public interface Streamable { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/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 747990f..20dd7e0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/Writable.java +++ b/juneau-core/src/main/java/org/apache/juneau/Writable.java @@ -17,9 +17,8 @@ import java.io.*; /** * 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 + * Instances must identify the media type of the content by implementing the * {@link #getMediaType()} method. - * </p> */ public interface Writable { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java index 983588d..d4abba2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java @@ -24,14 +24,14 @@ import org.apache.juneau.transform.*; /** * Used to tailor how beans get interpreted by the framework. * <p> - * Can be used to do the following: + * Can be used to do the following: * <ul class='spaced-list'> * <li>Explicitly specify the set and order of properties on a bean. * <li>Associate a {@link PropertyNamer} with a class. * <li>Specify subtypes of a bean differentiated by a sub type property. * </ul> * <p> - * This annotation can be applied to classes and interfaces. + * This annotation can be applied to classes and interfaces. */ @Documented @Target(TYPE) @@ -56,8 +56,8 @@ public @interface Bean { * <ja>@Bean</ja>(typeName=<js>"foo"</js>) * <jk>public class</jk> Foo { * <jc>// A bean property where the object types cannot be inferred since it's an Object[].</jc> - * <ja>@BeanProperty</ja>(typeDictionary={Bar.<jk>class</jk>,Baz.<jk>class</jk>}) - * <jk>public</jk> Object[] x = <jk>new</jk> Object[]{<jk>new</jk> Bar(), <jk>new</jk> Baz()}; + * <ja>@BeanProperty</ja>(typeDictionary={Bar.<jk>class</jk>,Baz.<jk>class</jk>}) + * <jk>public</jk> Object[] x = <jk>new</jk> Object[]{<jk>new</jk> Bar(), <jk>new</jk> Baz()}; * } * * <ja>@Bean</ja>(typeName=<js>"bar"</js>) @@ -67,26 +67,26 @@ public @interface Bean { * <jk>public class</jk> Baz {} * </p> * <p> - * When serialized as XML, the bean is rendered as: + * When serialized as XML, the bean is rendered as: * </p> * <p class='bcode'> * <xt><foo></xt> - * <xt><x></xt> - * <xt><bar/>v - * <xt><baz/></xt> - * <xt></x></xt> + * <xt><x></xt> + * <xt><bar/>v + * <xt><baz/></xt> + * <xt></x></xt> * <xt></foo></xt> * </p> * <p> - * When serialized as JSON, <js>'n'</js> attributes would be added when needed to infer the type during parsing: + * When serialized as JSON, <js>'n'</js> attributes would be added when needed to infer the type during parsing: * </p> * <p class='bcode'> * { - * x: [ - * {_type:<js>'bar'</js>}, - * {_type>:<js>'baz'</js>} - * ] - * } * + * x: [ + * {_type:<js>'bar'</js>}, + * {_type>:<js>'baz'</js>} + * ] + * } * </p> */ String typeName() default ""; @@ -94,9 +94,9 @@ public @interface Bean { /** * The set and order of names of properties associated with a bean class. * <p> - * The order specified is the same order that the entries will be returned by the {@link BeanMap#entrySet()} and related methods. + * The order specified is the same order that the entries will be returned by the {@link BeanMap#entrySet()} and related methods. * <p> - * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getProperties()} method. + * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getProperties()} method. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -104,7 +104,7 @@ public @interface Bean { * <jc>// All other properties are ignored.</jc> * <ja>@Bean</ja>(properties=<js>"street,city,state"</js>) * <jk>public class</jk> Address { - * ... + * ... * </p> */ String properties() default ""; @@ -112,17 +112,17 @@ public @interface Bean { /** * Sort bean properties in alphabetical order. * <p> - * When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order. - * Otherwise, the natural order of the bean properties is used which is dependent on the - * JVM vendor. - * On IBM JVMs, the bean properties are ordered based on their ordering in the Java file. - * On Oracle JVMs, the bean properties are not ordered (which follows the offical JVM specs). + * When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order. + * Otherwise, the natural order of the bean properties is used which is dependent on the + * JVM vendor. + * On IBM JVMs, the bean properties are ordered based on their ordering in the Java file. + * On Oracle JVMs, the bean properties are not ordered (which follows the offical 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 - * in the Java file. + * 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. * <p> - * This annotation is equivalent to using the {@link BeanContext#BEAN_sortProperties} property, but + * This annotation is equivalent to using the {@link BeanContext#BEAN_sortProperties} property, but * applied to individual classes instead of globally at the serializer or parser level. */ boolean sort() default false; @@ -130,7 +130,7 @@ public @interface Bean { /** * Specifies a list of properties that should be excluded from {@link BeanMap#entrySet()}. * <p> - * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getExcludeProperties()} method. + * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getExcludeProperties()} method. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -146,11 +146,11 @@ public @interface Bean { /** * Associates a {@link PropertyNamer} with this bean to tailor the names of the bean properties. * <p> - * Property namers are used to transform bean property names from standard form to some other form. - * For example, the {@link PropertyNamerDashedLC} will convert property names to dashed-lowercase, and - * these will be used as attribute names in JSON, and element names in XML. + * Property namers are used to transform bean property names from standard form to some other form. + * For example, the {@link PropertyNamerDashedLC} will convert property names to dashed-lowercase, and + * these will be used as attribute names in JSON, and element names in XML. * <p> - * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getPropertyNamer()} method. + * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getPropertyNamer()} method. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -159,15 +159,15 @@ public @interface Bean { * <jk>public class</jk> MyClass { * ... * } - * </p> + * </p> */ Class<? extends PropertyNamer> propertyNamer() default PropertyNamerDefault.class; /** * Identifies a class to be used as the interface class for this and all subclasses. * <p> - * When specified, only the list of properties defined on the interface class will be used during serialization. - * Additional properties on subclasses will be ignored. + * When specified, only the list of properties defined on the interface class will be used during serialization. + * Additional properties on subclasses will be ignored. * <p class='bcode'> * <jc>// Parent class</jc> * <ja>@Bean</ja>(interfaceClass=A.<jk>class</jk>) @@ -186,10 +186,10 @@ public @interface Bean { * <jsm>assertEquals</jsm>(<js>"{f0:'f0'}"</js>, r); // Note f1 is not serialized. * </p> * <p> - * Note that this annotation can be used on the parent class so that it filters to all child classes, - * or can be set individually on the child classes. + * Note that this annotation can be used on the parent class so that it filters to all child classes, + * or can be set individually on the child classes. * <p> - * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getInterfaceClass()} method. + * This annotation is an alternative to using the {@link BeanFilter} class with an implemented {@link BeanFilter#getInterfaceClass()} method. */ Class<?> interfaceClass() default Object.class; http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java index 168c73b..68a4c63 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java @@ -22,12 +22,12 @@ import org.apache.juneau.*; /** * Maps constructor arguments to property names on beans with read-only properties. * <p> - * This annotation can be used in the case of beans with properties whose values can only be set by passing - * them in through a constructor on the class.<br> - * Since method parameter names are lost during compilation, this annotation essentially redefines them - * so that they are available at runtime. + * This annotation can be used in the case of beans with properties whose values can only be set by passing + * them in through a constructor on the class.<br> + * Since method parameter names are lost during compilation, this annotation essentially redefines them + * so that they are available at runtime. * <p> - * The definition of a read-only bean is a bean with properties with only getters, like shown below... + * The definition of a read-only bean is a bean with properties with only getters, like shown below... * <p class='bcode'> * <jk>public class</jk> Person { * <jk>private final</jk> String <jf>name</jf>; @@ -56,18 +56,18 @@ import org.apache.juneau.*; * <jk>int</jk> age = p.getAge(); <jc>// 45</jc> * </p> * <p> - * This annotation can only be applied to constructors and can only be applied to one constructor per class. + * This annotation can only be applied to constructors and can only be applied to one constructor per class. * <p> - * When present, bean instantiation is delayed until the call to {@link BeanMap#getBean()}. - * Until then, bean property values are stored in a local cache until <code>getBean()</code> is called. - * Because of this additional caching step, parsing into read-only beans tends to be slower and use - * more memory than parsing into beans with writable properties. + * When present, bean instantiation is delayed until the call to {@link BeanMap#getBean()}. + * Until then, bean property values are stored in a local cache until <code>getBean()</code> is called. + * Because of this additional caching step, parsing into read-only beans tends to be slower and use + * more memory than parsing into beans with writable properties. * <p> - * Attempting to call {@link BeanMap#put(String,Object)} on a read-only property after calling {@link BeanMap#getBean()} - * will result in a {@link BeanRuntimeException} being thrown. - * Multiple calls to {@link BeanMap#getBean()} will return the same bean instance. + * Attempting to call {@link BeanMap#put(String,Object)} on a read-only property after calling {@link BeanMap#getBean()} + * will result in a {@link BeanRuntimeException} being thrown. + * Multiple calls to {@link BeanMap#getBean()} will return the same bean instance. * <p> - * Beans can be defined with a combination of read-only and read-write properties. + * Beans can be defined with a combination of read-only and read-write properties. */ @Documented @Target(CONSTRUCTOR) @@ -78,7 +78,7 @@ public @interface BeanConstructor { /** * The names of the properties of the constructor arguments. * <p> - * The number of properties listed must match the number of arguments in the constructor. + * The number of properties listed must match the number of arguments in the constructor. */ String properties() default ""; } http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java index bed8fec..5f8dc70 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java @@ -20,13 +20,13 @@ import java.lang.annotation.*; /** * Ignore classes, fields, and methods from being interpreted as bean or bean components. * <p> - * Applied to classes that may look like beans, but you want to be treated as non-beans. - * For example, if you want to force a bean to be converted to a string using the <code>toString()</code> - * method, use this annoation on the class. + * Applied to classes that may look like beans, but you want to be treated as non-beans. + * For example, if you want to force a bean to be converted to a string using the <code>toString()</code> + * method, use this annoation on the class. * <p> - * Applies to fields that should not be interpreted as bean property fields. + * Applies to fields that should not be interpreted as bean property fields. * <p> - * Applies to getters or setters that should not be interpreted as bean property getters or setters. + * Applies to getters or setters that should not be interpreted as bean property getters or setters. */ @Documented @Target({FIELD,METHOD,TYPE}) http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java index 10e4919..f934c9e 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java @@ -24,7 +24,7 @@ import org.apache.juneau.transform.*; /** * Used tailor how bean properties get interpreted by the framework. * <p> - * Can be used to do the following: + * Can be used to do the following: * <ul class='spaced-list'> * <li>Override the name of a property. * <li>Identify a getter or setter with a non-standard naming convention. @@ -37,7 +37,7 @@ import org.apache.juneau.transform.*; * <li>Identify a property as the ID for a bean. * </ul> * <p> - * This annotation is applied to public fields and public getter/setter methods of beans. + * This annotation is applied to public fields and public getter/setter methods of beans. */ @Documented @Target({FIELD,METHOD}) @@ -48,11 +48,11 @@ public @interface BeanProperty { /** * Identifies the name of the property. * <p> - * Normally, this is automatically inferred from the field name or getter method name + * Normally, this is automatically inferred from the field name or getter method name * of the property. However, this property can be used to assign a different * property name from the automatically inferred value. * <p> - * If the {@link BeanContext#BEAN_beanFieldVisibility} setting on the bean context excludes this field (e.g. the visibility + * If the {@link BeanContext#BEAN_beanFieldVisibility} setting on the bean context excludes this field (e.g. the visibility * is set to PUBLIC, but the field is PROTECTED), this annotation can be used to force the field to be identified as a property. */ String name() default ""; @@ -60,12 +60,12 @@ public @interface BeanProperty { /** * Identifies a specialized class type for the property. * <p> - * Normally this can be inferred through reflection of the field type or getter return type. - * However, you'll want to specify this value if you're parsing beans where the bean property class + * Normally this can be inferred through reflection of the field type or getter return type. + * However, you'll want to specify this value if you're parsing beans where the bean property class * is an interface or abstract class to identify the bean type to instantiate. Otherwise, you may * cause an {@link InstantiationException} when trying to set these fields. * <p> - * This property must denote a concrete bean class with a no-arg constructor. + * This property must denote a concrete bean class with a no-arg constructor. * * <h5 class='section'>Example:</h5> * <p class='bcode'>
