http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/urlencoding/UonSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UonSerializer.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UonSerializer.java index 9fae479..d5ca9e7 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UonSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UonSerializer.java @@ -27,24 +27,24 @@ import org.apache.juneau.transform.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>text/uon</code> + * Handles <code>Accept</code> types: <code>text/uon</code> * <p> - * Produces <code>Content-Type</code> types: <code>text/uon</code> + * Produces <code>Content-Type</code> types: <code>text/uon</code> * * <h5 class='section'>Description:</h5> * <p> - * This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient. - * However, custom serializers can be constructed to fine-tune behavior. + * This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient. + * However, custom serializers can be constructed to fine-tune behavior. * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul> * <li>{@link UonSerializerContext} * <li>{@link BeanContext} * </ul> * <p> - * The following shows a sample object defined in Javascript: + * The following shows a sample object defined in Javascript: * </p> * <p class='bcode'> * { @@ -69,8 +69,8 @@ import org.apache.juneau.transform.*; * } * </p> * <p> - * Using the "strict" syntax defined in this document, the equivalent - * UON notation would be as follows: + * Using the "strict" syntax defined in this document, the equivalent + * UON notation would be as follows: * </p> * <p class='bcode'> * (
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/urlencoding/UonSerializerSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UonSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UonSerializerSession.java index e0beaf3..27aeb38 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UonSerializerSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UonSerializerSession.java @@ -37,15 +37,15 @@ public class UonSerializerSession extends SerializerSession { * Create a new session using properties specified 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 output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types. * @param op The override properties. - * These override any context properties defined in the context. + * These override any context properties defined in the context. * @param javaMethod The java method that called this parser, usually the method in a REST servlet. * @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 UonSerializerSession(UonSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingContext.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingContext.java index 0a0fd5d..d412eeb 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingContext.java @@ -15,7 +15,7 @@ package org.apache.juneau.urlencoding; /** * Configurable properties on the {@link UrlEncodingSerializer} and {@link UrlEncodingParser} classes. * <p> - * Use the {@link UrlEncodingSerializer#setProperty(String, Object)} and + * Use the {@link UrlEncodingSerializer#setProperty(String, Object)} and * {@link UrlEncodingParser#setProperty(String, Object)} methods to set property values. */ public final class UrlEncodingContext implements Cloneable { @@ -23,10 +23,10 @@ public final class UrlEncodingContext implements Cloneable { /** * Serialize bean property collections/arrays as separate key/value pairs ({@link Boolean}, default=<jk>false</jk>). * <p> - * If <jk>false</jk>, serializing the array <code>[1,2,3]</code> results in <code>?key=$a(1,2,3)</code>. - * If <jk>true</jk>, serializing the same array results in <code>?key=1&key=2&key=3</code>. + * If <jk>false</jk>, serializing the array <code>[1,2,3]</code> results in <code>?key=$a(1,2,3)</code>. + * If <jk>true</jk>, serializing the same array results in <code>?key=1&key=2&key=3</code>. * <p> - * Example: + * Example: * <p class='bcode'> * <jk>public class</jk> A { * <jk>public</jk> String[] f1 = {<js>"a"</js>,<js>"b"</js>}; http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParser.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParser.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParser.java index 99e28d1..1a76fd6 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParser.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParser.java @@ -28,19 +28,19 @@ import org.apache.juneau.transform.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Content-Type</code> types: <code>application/x-www-form-urlencoded</code> + * Handles <code>Content-Type</code> types: <code>application/x-www-form-urlencoded</code> * * <h5 class='section'>Description:</h5> * <p> - * Parses URL-Encoded text (e.g. <js>"foo=bar&baz=bing"</js>) into POJOs. + * Parses URL-Encoded text (e.g. <js>"foo=bar&baz=bing"</js>) into POJOs. * <p> - * Expects parameter values to be in UON notation. + * Expects parameter values to be in UON notation. * <p> - * This parser uses a state machine, which makes it very fast and efficient. + * This parser uses a state machine, which makes it very fast and efficient. * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul> * <li>{@link UonParserContext} * <li>{@link BeanContext} @@ -539,8 +539,8 @@ public class UrlEncodingParser extends UonParser { * <li><b>Session-overridable:</b> <jk>true</jk> * </ul> * <p> - * If <jk>false</jk>, serializing the array <code>[1,2,3]</code> results in <code>?key=$a(1,2,3)</code>. - * If <jk>true</jk>, serializing the same array results in <code>?key=1&key=2&key=3</code>. + * If <jk>false</jk>, serializing the array <code>[1,2,3]</code> results in <code>?key=$a(1,2,3)</code>. + * If <jk>true</jk>, serializing the same array results in <code>?key=1&key=2&key=3</code>. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -556,7 +556,7 @@ public class UrlEncodingParser extends UonParser { * String s2 = p2.serialize(<jk>new</jk> A()); <jc>// Produces "f1=a&f1=b&f2=c&f2=d"</jc> * </p> * <p> - * This option only applies to beans. + * This option only applies to beans. * <p> * <h5 class='section'>Notes:</h5> * <ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserContext.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserContext.java index 20b33e3..a9829c1 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserContext.java @@ -34,8 +34,8 @@ public class UrlEncodingParserContext extends UonParserContext { * <li><b>Session-overridable:</b> <jk>true</jk> * </ul> * <p> - * If <jk>false</jk>, serializing the array <code>[1,2,3]</code> results in <code>?key=$a(1,2,3)</code>. - * If <jk>true</jk>, serializing the same array results in <code>?key=1&key=2&key=3</code>. + * If <jk>false</jk>, serializing the array <code>[1,2,3]</code> results in <code>?key=$a(1,2,3)</code>. + * If <jk>true</jk>, serializing the same array results in <code>?key=1&key=2&key=3</code>. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -51,7 +51,7 @@ public class UrlEncodingParserContext extends UonParserContext { * String s2 = p2.serialize(<jk>new</jk> A()); <jc>// Produces "f1=a&f1=b&f2=c&f2=d"</jc> * </p> * <p> - * This option only applies to beans. + * This option only applies to beans. * <p> * <h5 class='section'>Notes:</h5> * <ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserSession.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserSession.java index 62234b9..2d2ba44 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserSession.java @@ -33,7 +33,7 @@ public class UrlEncodingParserSession extends UonParserSession { * Create a new session using properties specified 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 input The input. Can be any of the following types: * <ul> * <li><jk>null</jk> @@ -43,13 +43,13 @@ public class UrlEncodingParserSession extends UonParserSession { * <li>{@link File} containing system encoded text. * </ul> * @param op The override properties. - * These override any context properties defined in the context. + * These override any context properties defined in the context. * @param javaMethod The java method that called this parser, usually the method in a REST servlet. * @param outer The outer object for instantiating top-level non-static inner classes. * @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>). */ public UrlEncodingParserSession(UrlEncodingParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializer.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializer.java index 04b64d6..94c8f97 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializer.java @@ -30,24 +30,24 @@ import org.apache.juneau.transform.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>application/x-www-form-urlencoded</code> + * Handles <code>Accept</code> types: <code>application/x-www-form-urlencoded</code> * <p> - * Produces <code>Content-Type</code> types: <code>application/x-www-form-urlencoded</code> + * Produces <code>Content-Type</code> types: <code>application/x-www-form-urlencoded</code> * * <h5 class='section'>Description:</h5> * <p> - * This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient. - * However, custom serializers can be constructed to fine-tune behavior. + * This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient. + * However, custom serializers can be constructed to fine-tune behavior. * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul> * <li>{@link UonSerializerContext} * <li>{@link BeanContext} * </ul> * <p> - * The following shows a sample object defined in Javascript: + * The following shows a sample object defined in Javascript: * </p> * <p class='bcode'> * { @@ -72,8 +72,8 @@ import org.apache.juneau.transform.*; * } * </p> * <p> - * Using the "strict" syntax defined in this document, the equivalent - * URL-encoded notation would be as follows: + * Using the "strict" syntax defined in this document, the equivalent + * URL-encoded notation would be as follows: * </p> * <p class='bcode'> * <ua>id</ua>=<un>1</un> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.java index a09d9b0..9f89a7f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.java @@ -33,15 +33,15 @@ public class UrlEncodingSerializerSession extends UonSerializerSession { * Create a new session using properties specified 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 output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types. * @param op The override properties. - * These override any context properties defined in the context. + * These override any context properties defined in the context. * @param javaMethod The java method that called this parser, usually the method in a REST servlet. * @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>). */ public UrlEncodingSerializerSession(UrlEncodingSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/utils/Args.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/Args.java b/juneau-core/src/main/java/org/apache/juneau/utils/Args.java index 4d4d01d..0399c39 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/Args.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/Args.java @@ -194,7 +194,7 @@ public final class Args extends ObjectMap { * If the optional arg has multiple values, returns only the first converted value. * * <h5 class='section'>Example:</h5> - * <p class='bcode'> + * <p class='bcode'> * <jc>// Command: java com.sample.MyClass -verbose true -debug 5</jc> * <jk>boolean</jk> b = args.getArg(<jk>boolean</jk>.<jk>class</jk>, <js>"verbose"</js>); * <jk>int</jk> i = args.getArg(<jk>int</jk>.<jk>class</jk>, <js>"debug"</js>); http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/utils/IOPipe.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/IOPipe.java b/juneau-core/src/main/java/org/apache/juneau/utils/IOPipe.java index 48829c3..743f7ae 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/IOPipe.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/IOPipe.java @@ -22,15 +22,15 @@ import org.apache.juneau.internal.*; /** * A utility class for piping input streams and readers to output streams and writers. * <p> - * A typical usage is as follows... + * A typical usage is as follows... * <p class='bcode'> * InputStream in = getInputStream(); * Writer out = getWriter(); * IOPipe.create(in, out).closeOut().run(); * </p> * <p> - * By default, the input stream is closed and the output stream is not. - * This can be changed by calling {@link #closeOut()} and {@link #close(boolean, boolean)}. + * By default, the input stream is closed and the output stream is not. + * This can be changed by calling {@link #closeOut()} and {@link #close(boolean, boolean)}. */ @SuppressWarnings("hiding") public class IOPipe { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java b/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java index 190e68c..cb6dd18 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java @@ -76,7 +76,7 @@ public class MessageBundle extends ResourceBundle { * * @param forClass The class using this resource bundle. * @param bundlePath The path of the resource bundle to wrap. - * This can be an absolute path (e.g. <js>"com.foo.MyMessages"</js>) or a path + * This can be an absolute path (e.g. <js>"com.foo.MyMessages"</js>) or a path * relative to the package of the <l>forClass</l> (e.g. <js>"MyMessages"</js> if <l>forClass</l> is <js>"com.foo.MyClass"</js>). */ public MessageBundle(Class<?> forClass, String bundlePath) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java b/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java index 1e55ec7..a48c3fc 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java @@ -18,10 +18,10 @@ import org.apache.juneau.transform.*; /** * Utility class for efficiently converting objects between types. * <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> @@ -166,7 +166,7 @@ public class ObjectUtils { * * @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. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java index 908fc5d..415e203 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java @@ -24,10 +24,10 @@ import org.apache.juneau.parser.*; * Used to invoke methods on {@code Objects} using arguments in serialized form. * * <h5 class='section'>Example:</h5> - * <p class='bcode'> - * String s = <js>"foobar"</js>; - * String s2 = (String)<jk>new</jk> PojoIntrospector(s).invoke(<js>"substring(int,int)"</js>, <js>"[3,6]"</js>); <jc>// "bar"</jc> - * </p> + * <p class='bcode'> + * String s = <js>"foobar"</js>; + * String s2 = (String)<jk>new</jk> PojoIntrospector(s).invoke(<js>"substring(int,int)"</js>, <js>"[3,6]"</js>); <jc>// "bar"</jc> + * </p> */ public final class PojoIntrospector { @@ -61,8 +61,8 @@ public final class PojoIntrospector { * * @param method The method being invoked. * @param args The arguments to pass as parameters to the method.<br> - * These will automatically be converted to the appropriate object type if possible.<br> - * Can be <jk>null</jk> if method has no arguments. + * These will automatically be converted to the appropriate object type if possible.<br> + * Can be <jk>null</jk> if method has no arguments. * @return The object returned by the call to the method, or <jk>null</jk> if target object is <jk>null</jk>. * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is inaccessible. * @throws IllegalArgumentException If one of the following occurs: @@ -89,8 +89,8 @@ public final class PojoIntrospector { * * @param method The method being invoked. * @param args The arguments to pass as parameters to the method.<br> - * These will automatically be converted to the appropriate object type if possible.<br> - * Can be <jk>null</jk> if method has no arguments. + * These will automatically be converted to the appropriate object type if possible.<br> + * Can be <jk>null</jk> if method has no arguments. * @return The object returned by the call to the method, or <jk>null</jk> if target object is <jk>null</jk>. * @throws NoSuchMethodException If method does not exist. * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is inaccessible. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java index 1f2ff64..e42ec1b 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java @@ -24,9 +24,9 @@ import org.apache.juneau.internal.*; /** * Designed to provide query/view/sort/paging filtering on tabular in-memory POJO models. * <p> - * It can also perform just view filtering on beans/maps. + * It can also perform just view filtering on beans/maps. * <p> - * Examples of tabular POJO models: + * Examples of tabular POJO models: * <ul> * <li><tt>Collection{@code <Map>}</tt> * <li><tt>Collection{@code <Bean>}</tt> @@ -34,7 +34,7 @@ import org.apache.juneau.internal.*; * <li><tt>Bean[]</tt> * </ul> * <p> - * Tabular POJO models can be thought of as tables of data. For example, a list of the following beans... + * Tabular POJO models can be thought of as tables of data. For example, a list of the following beans... * <p class='bcode'> * <jk>public</jk> MyBean { * <jk>public int</jk> fi; @@ -50,7 +50,7 @@ import org.apache.juneau.internal.*; * <tr><td colspan=3>...</td></tr> * </table> * <p> - * From this table, you can perform the following functions: + * From this table, you can perform the following functions: * <ul class='spaced-list'> * <li>Query - Return only rows where a search pattern matches. * <li>View - Return only the specified subset of columns in the specified order. @@ -60,11 +60,11 @@ import org.apache.juneau.internal.*; * * <h5 class='topic'>Query</h5> * <p> - * The query capabilites allow you to filter based on query patterns against + * The query capabilites allow you to filter based on query patterns against * strings, dates, and numbers. Queries take the form of a Map with column names * as keys, and search patterns as values. <br> - * Search patterns can be either {@code Strings} or {@code Maps}.<br> - * Multiple search patterns are ANDed (i.e. all patterns must match for the row to be returned). + * Search patterns can be either {@code Strings} or {@code Maps}.<br> + * Multiple search patterns are ANDed (i.e. all patterns must match for the row to be returned). * * <h5 class='section'>Example:</h5> * <ul class='spaced-list'> @@ -75,13 +75,13 @@ import org.apache.juneau.internal.*; * and the <tt>fs</tt> column starts with <tt>"foo"</tt>. * </ul> * <p> - * Search patterns can also be applied to lower level fields. For example, the search term + * Search patterns can also be applied to lower level fields. For example, the search term * <tt>{f1:{f2:{f3{'foobar'}}}</tt> means only return top level rows where the <tt>f1.getF2().getF3()</tt> * property is <tt>'foobar'</tt>. * * <h5 class='topic'>String Patterns</h5> * <p> - * Any objects can be queried against using string patterns. If the objects being + * Any objects can be queried against using string patterns. If the objects being * searched are not strings, then the patterns are matched against whatever is * return by the {@code Object#toString()} method. * @@ -104,7 +104,7 @@ import org.apache.juneau.internal.*; * * <h5 class='topic'>Numeric Patterns</h5> * <p> - * Any object of type {@link Number} (or numeric primitives) can be searched using numeric patterns. + * Any object of type {@link Number} (or numeric primitives) can be searched using numeric patterns. * * <h6 class='topic'>Example numeric query patterns:</h6> * <ul> @@ -126,9 +126,9 @@ import org.apache.juneau.internal.*; * * <h5 class='topic'>Date Patterns</h5> * <p> - * Any object of type {@link Date} or {@link Calendar} can be searched using date patterns. + * Any object of type {@link Date} or {@link Calendar} can be searched using date patterns. * <p> - * The default valid input timestamp formats (which can be overridden via the {@link #setValidTimestampFormats(String...)} method are... + * The default valid input timestamp formats (which can be overridden via the {@link #setValidTimestampFormats(String...)} method are... * * <ul> * <li><tt>yyyy.MM.dd.HH.mm.ss</tt> @@ -156,9 +156,9 @@ import org.apache.juneau.internal.*; * * <h5 class='topic'>View</h5> * <p> - * The view capability allows you to return only the specified subset of columns in the + * The view capability allows you to return only the specified subset of columns in the * specified order.<br> - * The view parameter is a list of either <tt>Strings</tt> or <tt>Maps</tt>. + * The view parameter is a list of either <tt>Strings</tt> or <tt>Maps</tt>. * * <h6 class='topic'>Example view parameters:</h6> * <ul> @@ -170,8 +170,8 @@ import org.apache.juneau.internal.*; * * <h5 class='topic'>Sort</h5> * <p> - * The sort capability allows you to sort values by the specified rows.<br> - * The sort parameter is a list of either <tt>Strings</tt> or <tt>Maps</tt>.<br> + * The sort capability allows you to sort values by the specified rows.<br> + * The sort parameter is a list of either <tt>Strings</tt> or <tt>Maps</tt>.<br> * <tt>Strings</tt> represent column names to sort ascending. If you want * to sort descending, you need to specify a <tt>Map</tt> of the form <tt>{colname:'d'}</tt> * @@ -185,7 +185,7 @@ import org.apache.juneau.internal.*; * * <h5 class='topic'>Paging</h5> * <p> - * Use the <tt>pos</tt> and <tt>limit</tt> parameters to specify a subset of rows to + * Use the <tt>pos</tt> and <tt>limit</tt> parameters to specify a subset of rows to * return. * * <h5 class='topic'>Other Notes</h5> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java index 851bc9b..12de791 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java @@ -26,21 +26,21 @@ import org.apache.juneau.parser.*; * Provides the ability to perform standard REST operations (GET, PUT, POST, DELETE) against * nodes in a POJO model. Nodes in the POJO model are addressed using URLs. * <p> - * A POJO model is defined as a tree model where nodes consist of consisting of the following: - * <ul class='spaced-list'> - * <li>{@link Map Maps} and Java beans representing JSON objects. - * <li>{@link Collection Collections} and arrays representing JSON arrays. - * <li>Java beans. - * </ul> + * A POJO model is defined as a tree model where nodes consist of consisting of the following: + * <ul class='spaced-list'> + * <li>{@link Map Maps} and Java beans representing JSON objects. + * <li>{@link Collection Collections} and arrays representing JSON arrays. + * <li>Java beans. + * </ul> * <p> - * Leaves of the tree can be any type of object. + * Leaves of the tree can be any type of object. * <p> - * Use {@link #get(String) get()} to retrieve an element from a JSON tree.<br> - * Use {@link #put(String,Object) put()} to create (or overwrite) an element in a JSON tree.<br> - * Use {@link #post(String,Object) post()} to add an element to a list in a JSON tree.<br> - * Use {@link #delete(String) delete()} to remove an element from a JSON tree.<br> + * Use {@link #get(String) get()} to retrieve an element from a JSON tree.<br> + * Use {@link #put(String,Object) put()} to create (or overwrite) an element in a JSON tree.<br> + * Use {@link #post(String,Object) post()} to add an element to a list in a JSON tree.<br> + * Use {@link #delete(String) delete()} to remove an element from a JSON tree.<br> * <p> - * Leading slashes in URLs are ignored. So <js>"/xxx/yyy/zzz"</js> and <js>"xxx/yyy/zzz"</js> are considered identical. + * Leading slashes in URLs are ignored. So <js>"/xxx/yyy/zzz"</js> and <js>"xxx/yyy/zzz"</js> are considered identical. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -102,9 +102,9 @@ import org.apache.juneau.parser.*; * ); * johnSmith.put(<js>"additionalInfo/medicalInfo"</js>, medicalInfo); * <p> - * In the special case of collections/arrays of maps/beans, a special XPath-like selector notation + * In the special case of collections/arrays of maps/beans, a special XPath-like selector notation * can be used in lieu of index numbers on GET requests to return a map/bean with a specified attribute value.<br> - * The syntax is {@code @attr=val}, where attr is the attribute name on the child map, and val is the matching value. + * The syntax is {@code @attr=val}, where attr is the attribute name on the child map, and val is the matching value. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -130,7 +130,7 @@ public final class PojoRest { /** * Create a new instance of a REST interface over the specified object. * <p> - * Uses {@link BeanContext#DEFAULT} for working with Java beans. + * Uses {@link BeanContext#DEFAULT} for working with Java beans. * * @param o The object to be wrapped. */ @@ -141,7 +141,7 @@ public final class PojoRest { /** * Create a new instance of a REST interface over the specified object. * <p> - * The parser is used as the bean context. + * The parser is used as the bean context. * * @param o The object to be wrapped. * @param parser The parser to use for parsing arguments and converting objects to the correct data type. @@ -177,7 +177,7 @@ public final class PojoRest { * Retrieves the element addressed by the URL. * * @param url The URL of the element to retrieve. - * If null or blank, returns the root. + * If null or blank, returns the root. * @return The addressed element, or null if that element does not exist in the tree. */ public Object get(String url) { @@ -188,7 +188,7 @@ public final class PojoRest { * Retrieves the element addressed by the URL. * * @param url The URL of the element to retrieve. - * If null or blank, returns the root. + * If null or blank, returns the root. * @param defVal The default value if the map doesn't contain the specified mapping. * @return The addressed element, or null if that element does not exist in the tree. */ @@ -204,7 +204,7 @@ public final class PojoRest { * * @param type The specified object type. * @param url The URL of the element to retrieve. - * If null or blank, returns the root. + * If null or blank, returns the root. * @param <T> The specified object type. * * @return The addressed element, or null if that element does not exist in the tree. @@ -220,7 +220,7 @@ public final class PojoRest { * * @param type The specified object type. * @param url The URL of the element to retrieve. - * If null or blank, returns the root. + * If null or blank, returns the root. * @param def The default value if addressed item does not exist. * @param <T> The specified object type. * @@ -236,7 +236,7 @@ public final class PojoRest { /** * 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 url The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -248,7 +248,7 @@ public final class PojoRest { /** * 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 url The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -261,7 +261,7 @@ public final class PojoRest { /** * 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 url The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -274,7 +274,7 @@ public final class PojoRest { /** * 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 url The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -288,7 +288,7 @@ public final class PojoRest { /** * 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 url The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -301,7 +301,7 @@ public final class PojoRest { /** * 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 url The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -315,7 +315,7 @@ public final class PojoRest { /** * 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 url The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -328,7 +328,7 @@ public final class PojoRest { /** * 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 url The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -342,7 +342,7 @@ public final class PojoRest { /** * 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 url The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -355,7 +355,7 @@ public final class PojoRest { /** * 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 url The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -369,7 +369,7 @@ public final class PojoRest { /** * 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 url The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -382,7 +382,7 @@ public final class PojoRest { /** * 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 url The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -396,7 +396,7 @@ public final class PojoRest { /** * 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 url The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -409,7 +409,7 @@ public final class PojoRest { /** * 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 url The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -423,7 +423,7 @@ public final class PojoRest { /** * 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 url The key. * @return The converted value, or <jk>null</jk> if the map contains no mapping for this key. @@ -436,7 +436,7 @@ public final class PojoRest { /** * 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 url The key. * @param defVal The default value if the map doesn't contain the specified mapping. @@ -452,20 +452,18 @@ public final class PojoRest { * * @param url The URL of the element to retrieve. * @param method The method signature. - * <p> - * Can be any of the following formats: - * </p> - * <ul class='spaced-list'> - * <li>Method name only. e.g. <js>"myMethod"</js>. - * <li>Method name with class names. e.g. <js>"myMethod(String,int)"</js>. - * <li>Method name with fully-qualified class names. e.g. <js>"myMethod(java.util.String,int)"</js>. - * </ul> - * <p> - * As a rule, use the simplest format needed to uniquely resolve a method. - * </p> + * <p> + * Can be any of the following formats: + * <ul class='spaced-list'> + * <li>Method name only. e.g. <js>"myMethod"</js>. + * <li>Method name with class names. e.g. <js>"myMethod(String,int)"</js>. + * <li>Method name with fully-qualified class names. e.g. <js>"myMethod(java.util.String,int)"</js>. + * </ul> + * <p> + * As a rule, use the simplest format needed to uniquely resolve a method. * @param args The arguments to pass as parameters to the method.<br> - * These will automatically be converted to the appropriate object type if possible.<br> - * This must be an array, like a JSON array. + * These will automatically be converted to the appropriate object type if possible.<br> + * This must be an array, like a JSON array. * @return The returned object from the method call. * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is inaccessible. * @throws IllegalArgumentException If one of the following occurs: @@ -514,10 +512,10 @@ public final class PojoRest { /** * Sets/replaces the element addressed by the URL. * <p> - * This method expands the POJO model as necessary to create the new element. + * This method expands the POJO model as necessary to create the new element. * * @param url The URL of the element to create. - * If <jk>null</jk> or blank, the root itself is replaced with the specified value. + * If <jk>null</jk> or blank, the root itself is replaced with the specified value. * @param val The value being set. Value can be of any type. * @return The previously addressed element, or <jk>null</jk> the element did not previously exist. */ @@ -559,7 +557,7 @@ public final class PojoRest { * qIf the element does not exist, no action is taken. * * @param url The URL of the element being deleted. - * If <jk>null</jk> or blank, the root itself is deleted. + * If <jk>null</jk> or blank, the root itself is deleted. * @return The removed element, or null if that element does not exist. */ public Object delete(String url) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java index ad74cef..451878c 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java @@ -18,9 +18,9 @@ import java.text.*; /** * Generic exception thrown from the {@link PojoRest} class. * <p> - * Typically, this is a user-error, such as trying to address a non-existent node in the tree. + * Typically, this is a user-error, such as trying to address a non-existent node in the tree. * <p> - * The status code is an HTTP-equivalent code. It will be one of the following: + * The status code is an HTTP-equivalent code. It will be one of the following: * <ul class='spaced-list'> * <li>{@link HttpURLConnection#HTTP_BAD_REQUEST HTTP_BAD_REQUEST} - Attempting to do something impossible. * <li>{@link HttpURLConnection#HTTP_NOT_FOUND HTTP_NOT_FOUND} - Attempting to access a non-existent node in the tree. @@ -48,7 +48,7 @@ public final class PojoRestException extends RuntimeException { /** * The HTTP-equivalent status code. * <p> - * See above for details. + * See above for details. * * @return The HTTP-equivalent status code. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/Namespace.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/Namespace.java b/juneau-core/src/main/java/org/apache/juneau/xml/Namespace.java index b78bd30..d8f4a76 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/Namespace.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/Namespace.java @@ -17,7 +17,7 @@ import org.apache.juneau.annotation.*; /** * Represents a simple namespace mapping between a simple name and URI. * <p> - * In general, the simple name will be used as the XML prefix mapping unless + * In general, the simple name will be used as the XML prefix mapping unless * there are conflicts or prefix remappings in the serializer. */ @Bean(sort=true) @@ -28,7 +28,7 @@ public final class Namespace implements Comparable<Namespace> { /** * Constructor. * <p> - * Use this constructor when the long name and short name are the same value. + * Use this constructor when the long name and short name are the same value. * * @param name The long and short name of this schema. * @param uri The URI of this schema. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java b/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java index 75c0d67..52fe1ea 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java @@ -22,10 +22,10 @@ import org.apache.juneau.parser.*; /** * Factory class for getting unique instances of {@link Namespace} objects. * <p> - * For performance reasons, {@link Namespace} objects are stored in {@link IdentityList IdentityLists}. - * For this to work property, namespaces with the same name and URI must only be represented by a single + * For performance reasons, {@link Namespace} objects are stored in {@link IdentityList IdentityLists}. + * For this to work property, namespaces with the same name and URI must only be represented by a single * {@link Namespace} instance. - * This factory class ensures this identity uniqueness. + * This factory class ensures this identity uniqueness. */ public final class NamespaceFactory { @@ -53,7 +53,7 @@ public final class NamespaceFactory { /** * Converts the specified object into a {@link Namespace} object. * <p> - * Can be any of following types: + * Can be any of following types: * <ul class='spaced-list'> * <li>A {@link Namespace} object * <li>A JSON string containing a single key/value pair indicating the name/URI mapping. @@ -85,7 +85,7 @@ public final class NamespaceFactory { /** * Converts the specified object into an array of {@link Namespace} object. * <p> - * Can be any of following types: + * Can be any of following types: * <ul class='spaced-list'> * <li>A {@link Namespace} array * <li>A JSON string with key/value pairs indicating name/URI pairs. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java index 86333c0..5e869cf 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java @@ -48,7 +48,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended { /** * Returns the XML namespace associated with this bean property. * <p> - * Namespace is determined in the following order: + * Namespace is determined in the following order: * <ol> * <li>{@link Xml#prefix()} annotation defined on bean property field. * <li>{@link Xml#prefix()} annotation defined on bean getter. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/XmlClassMeta.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlClassMeta.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlClassMeta.java index 931f379..c32cfa9 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlClassMeta.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlClassMeta.java @@ -78,7 +78,7 @@ public class XmlClassMeta extends ClassMetaExtended { /** * Returns the XML namespace associated with this class. * <p> - * Namespace is determined in the following order: + * Namespace is determined in the following order: * <ol> * <li>{@link Xml#prefix()} annotation defined on class. * <li>{@link Xml#prefix()} annotation defined on package. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java index d521717..c62d18f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java @@ -20,13 +20,13 @@ import org.apache.juneau.serializer.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>text/xml</code> + * Handles <code>Accept</code> types: <code>text/xml</code> * <p> - * Produces <code>Content-Type</code> types: <code>text/xml</code> + * Produces <code>Content-Type</code> types: <code>text/xml</code> * * <h5 class='section'>Description:</h5> * <p> - * Same as {@link XmlSerializer}, except prepends <code><xt><?xml</xt> <xa>version</xa>=<xs>'1.0'</xs> <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?></xt></code> to the response + * Same as {@link XmlSerializer}, except prepends <code><xt><?xml</xt> <xa>version</xa>=<xs>'1.0'</xs> <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?></xt></code> to the response * to make it a valid XML document. * */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/XmlParser.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParser.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParser.java index a13c1d9..a6a0212 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParser.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParser.java @@ -34,15 +34,15 @@ import org.apache.juneau.xml.annotation.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Content-Type</code> types: <code>text/xml</code> + * Handles <code>Content-Type</code> types: <code>text/xml</code> * * <h5 class='section'>Description:</h5> * <p> - * See the {@link XmlSerializer} class for a description of Juneau-generated XML. + * See the {@link XmlSerializer} class for a description of Juneau-generated XML. * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul> * <li>{@link XmlParserContext} * <li>{@link BeanContext} @@ -663,18 +663,18 @@ public class XmlParser extends ReaderParser { * contain a single entry whose key is the root element name. * * Example: - * <table class='styled'> - * <tr> - * <td>XML</td> - * <td>ObjectMap.toString(), preserveRootElement==false</td> - * <td>ObjectMap.toString(), preserveRootElement==true</td> - * </tr> - * <tr> - * <td><code><xt><root><a></xt>foobar<xt></a></root></xt></code></td> - * <td><code>{ a:<js>'foobar'</js> }</code></td> - * <td><code>{ root: { a:<js>'foobar'</js> }}</code></td> - * </tr> - * </table> + * <table class='styled'> + * <tr> + * <td>XML</td> + * <td>ObjectMap.toString(), preserveRootElement==false</td> + * <td>ObjectMap.toString(), preserveRootElement==true</td> + * </tr> + * <tr> + * <td><code><xt><root><a></xt>foobar<xt></a></root></xt></code></td> + * <td><code>{ a:<js>'foobar'</js> }</code></td> + * <td><code>{ root: { a:<js>'foobar'</js> }}</code></td> + * </tr> + * </table> * <p> * <h5 class='section'>Notes:</h5> * <ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java index 25df977..095410d 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java @@ -112,18 +112,18 @@ public class XmlParserContext extends ParserContext { * contain a single entry whose key is the root element name. * * Example: - * <table class='styled'> - * <tr> - * <td>XML</td> - * <td>ObjectMap.toString(), preserveRootElement==false</td> - * <td>ObjectMap.toString(), preserveRootElement==true</td> - * </tr> - * <tr> - * <td><code><xt><root><a></xt>foobar<xt></a></root></xt></code></td> - * <td><code>{ a:<js>'foobar'</js> }</code></td> - * <td><code>{ root: { a:<js>'foobar'</js> }}</code></td> - * </tr> - * </table> + * <table class='styled'> + * <tr> + * <td>XML</td> + * <td>ObjectMap.toString(), preserveRootElement==false</td> + * <td>ObjectMap.toString(), preserveRootElement==true</td> + * </tr> + * <tr> + * <td><code><xt><root><a></xt>foobar<xt></a></root></xt></code></td> + * <td><code>{ a:<js>'foobar'</js> }</code></td> + * <td><code>{ root: { a:<js>'foobar'</js> }}</code></td> + * </tr> + * </table> */ public static final String XML_preserveRootElement = "XmlParser.preserveRootElement"; http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserSession.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserSession.java index ebf5d5d..6a52ed7 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserSession.java @@ -47,7 +47,7 @@ public class XmlParserSession extends ParserSession { * Create a new session using properties specified 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 input The input. Can be any of the following types: * <ul> * <li><jk>null</jk> @@ -57,13 +57,13 @@ public class XmlParserSession extends ParserSession { * <li>{@link File} containing system encoded text. * </ul> * @param op The override properties. - * These override any context properties defined in the context. + * These override any context properties defined in the context. * @param javaMethod The java method that called this parser, usually the method in a REST servlet. * @param outer The outer object for instantiating top-level non-static inner classes. * @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>). */ public XmlParserSession(XmlParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) { @@ -208,7 +208,7 @@ public class XmlParserSession extends ParserSession { * * @param r The reader to read the element text from. * @param trim If <jk>true</jk>, trim the contents of the text node BEFORE decoding escape sequences. - * Typically <jk>true</jk> for {@link XmlFormat#MIXED_PWS} and {@link XmlFormat#TEXT_PWS}. + * Typically <jk>true</jk> for {@link XmlFormat#MIXED_PWS} and {@link XmlFormat#TEXT_PWS}. * @return The decoded text. <jk>null</jk> if the text consists of the sequence <js>'_x0000_'</js>. * @throws XMLStreamException */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java index 195abf1..6dd2841 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java @@ -20,13 +20,13 @@ import org.apache.juneau.serializer.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>text/xml+schema</code> + * Handles <code>Accept</code> types: <code>text/xml+schema</code> * <p> - * Produces <code>Content-Type</code> types: <code>text/xml</code> + * Produces <code>Content-Type</code> types: <code>text/xml</code> * * <h5 class='section'>Description:</h5> * <p> - * Same as {@link XmlSchemaSerializer}, except prepends <code><xt><?xml</xt> <xa>version</xa>=<xs>'1.0'</xs> <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?></xt></code> to the response + * Same as {@link XmlSchemaSerializer}, except prepends <code><xt><?xml</xt> <xa>version</xa>=<xs>'1.0'</xs> <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?></xt></code> to the response * to make it a valid XML document. */ public class XmlSchemaDocSerializer extends XmlSchemaSerializer { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java index 397c513..ec9bc52 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java @@ -37,17 +37,17 @@ import org.w3c.dom.ls.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>text/xml+schema</code> + * Handles <code>Accept</code> types: <code>text/xml+schema</code> * <p> - * Produces <code>Content-Type</code> types: <code>text/xml</code> + * Produces <code>Content-Type</code> types: <code>text/xml</code> * * <h5 class='section'>Description:</h5> * <p> - * Produces the XML-schema representation of the XML produced by the {@link XmlSerializer} class with the same properties. + * Produces the XML-schema representation of the XML produced by the {@link XmlSerializer} class with the same properties. * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul> * <li>{@link XmlSerializerContext} * <li>{@link BeanContext} @@ -91,7 +91,7 @@ public class XmlSchemaSerializer extends XmlSerializer { * Returns an XML-Schema validator based on the output returned by {@link #doSerialize(SerializerSession, Object)}; * * @param session The serializer session object return by {@link #createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType)}.<br> - * Can be <jk>null</jk>. + * Can be <jk>null</jk>. * @param o The object to serialize. * @return The new validator. * @throws Exception If a problem was detected in the XML-Schema output produced by this serializer. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java index bb4f6bc..3091056 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java @@ -32,15 +32,15 @@ import org.apache.juneau.xml.annotation.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>text/xml</code> + * Handles <code>Accept</code> types: <code>text/xml</code> * <p> - * Produces <code>Content-Type</code> types: <code>text/xml</code> + * Produces <code>Content-Type</code> types: <code>text/xml</code> * * <h5 class='section'>Description:</h5> * <p> - * See the {@link JsonSerializer} class for details on how Java models map to JSON. + * See the {@link JsonSerializer} class for details on how Java models map to JSON. * <p> - * For example, the following JSON... + * For example, the following JSON... * <p class='bcode'> * { * name:<js>'John Smith'</js>, @@ -80,7 +80,7 @@ import org.apache.juneau.xml.annotation.*; * <xt><fico_x0020_score></xt> &gt; 640<xt></fico_x0020_score></xt> * <xt></object></xt> * <p> - * An additional "add-json-properties" mode is also provided to prevent loss of JSON data types... + * An additional "add-json-properties" mode is also provided to prevent loss of JSON data types... * <p class='bcode'> * <xt><name</xt> <xa>_type</xa>=<xs>'string'</xs><xt>></xt>John Smith<xt></name></xt> * <xt><address</xt> <xa>_type</xa>=<xs>'object'</xs><xt>></xt> @@ -99,14 +99,14 @@ import org.apache.juneau.xml.annotation.*; * <xt><fico_x0020_score</xt> <xa>_type</xa>=<xs>'string'</xs><xt>></xt> &gt; 640<xt></fico_x0020_score></xt> * <xt></object></xt> * <p> - * This serializer provides several serialization options. Typically, one of the predefined <jsf>DEFAULT</jsf> serializers will be sufficient. - * However, custom serializers can be constructed to fine-tune behavior. + * This serializer provides several serialization options. Typically, one of the predefined <jsf>DEFAULT</jsf> serializers will be sufficient. + * However, custom serializers can be constructed to fine-tune behavior. * <p> - * If an attribute name contains any non-valid XML element characters, they will be escaped using standard {@code _x####_} notation. + * If an attribute name contains any non-valid XML element characters, they will be escaped using standard {@code _x####_} notation. * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul> * <li>{@link XmlSerializerContext} * <li>{@link BeanContext} @@ -114,7 +114,7 @@ import org.apache.juneau.xml.annotation.*; * * <h6 class='topic'>Behavior-specific subclasses</h6> * <p> - * The following direct subclasses are provided for convenience: + * The following direct subclasses are provided for convenience: * <ul class='spaced-list'> * <li>{@link Sq} - Default serializer, single quotes. * <li>{@link SqReadable} - Default serializer, single quotes, whitespace added. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java index 223f75b..36c8a03 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java @@ -49,15 +49,15 @@ public class XmlSerializerSession extends SerializerSession { * Create a new session using properties specified 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 output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types. * @param op The override properties. - * These override any context properties defined in the context. + * These override any context properties defined in the context. * @param javaMethod The java method that called this parser, usually the method in a REST servlet. * @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>). */ public XmlSerializerSession(XmlSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java index fe92575..0567d73 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java @@ -76,7 +76,7 @@ public final class XmlUtils { * @param trim Trim the text before serializing it. * @param preserveWhitespace Specifies whether we're in preserve-whitespace mode. * (e.g. {@link XmlFormat#MIXED_PWS} or {@link XmlFormat#TEXT_PWS}. - * If <jk>true</jk>, leading and trailing whitespace characters will be encoded. + * If <jk>true</jk>, leading and trailing whitespace characters will be encoded. * @return The same writer passed in. * @throws IOException Thrown from the writer. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java index 5d53451..13f7613 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java @@ -20,9 +20,9 @@ import java.lang.annotation.*; /** * Annotation for specifying various XML options for the XML and RDF/XML serializers. * <p> - * Can be applied to Java packages, types, fields, and methods. + * Can be applied to Java packages, types, fields, and methods. * <p> - * Can be used for the following: + * Can be used for the following: * <ul class='spaced-list'> * <li>Override the child element name on the XML representation of collection or array properties. * <li>Specify the XML namespace on a package, class, or method. @@ -38,7 +38,7 @@ public @interface Xml { /** * Sets the name of the XML child elements for bean properties of type collection and array. * <p> - * Applies only to collection and array bean properties. + * Applies only to collection and array bean properties. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -48,7 +48,7 @@ public @interface Xml { * } * </p> * <p> - * Without the <ja>@Xml</ja> annotation, serializing this bean as XML would have produced the following... + * Without the <ja>@Xml</ja> annotation, serializing this bean as XML would have produced the following... * </p> * <p class='bcode'> * <xt><object></xt> @@ -59,7 +59,7 @@ public @interface Xml { * <xt></object></xt> * </p> * <p> - * With the annotations, serializing this bean as XML produces the following... + * With the annotations, serializing this bean as XML produces the following... * </p> * <p class='bcode'> * <xt><object></xt> @@ -81,7 +81,7 @@ public @interface Xml { * to the bean property. * </ul> * <p> - * Must either be matched to a {@link #namespace()} annotation on the same object, parent object, or a {@link XmlNs} with the same name + * Must either be matched to a {@link #namespace()} annotation on the same object, parent object, or a {@link XmlNs} with the same name * through the {@link XmlSchema#xmlNs()} annotation on the package. * </p> */ @@ -90,7 +90,7 @@ public @interface Xml { /** * Sets the namespace URI of this property or class. * <p> - * Must be matched with a {@link #prefix()} annotation on this object, a parent object, or a {@link XmlNs} with the same name + * Must be matched with a {@link #prefix()} annotation on this object, a parent object, or a {@link XmlNs} with the same name * through the {@link XmlSchema#xmlNs()} annotation on the package. */ String namespace() default ""; @@ -120,7 +120,7 @@ public @interface Xml { * } * </p> * <p> - * Without the <ja>@Xml</ja> annotations, serializing this bean as XML would have produced the following... + * Without the <ja>@Xml</ja> annotations, serializing this bean as XML would have produced the following... * </p> * <p class='bcode'> * <xt><object</xt> <xa>href</xa>=<js>'http://foo'</js><xt>></xt> @@ -132,7 +132,7 @@ public @interface Xml { * <xt></object></xt> * </p> * <p> - * With the annotations, serializing this bean as XML produces the following... + * With the annotations, serializing this bean as XML produces the following... * </p> * <p class='bcode'> * <xt><object</xt> <xa>f1</xa>=<js>'123'</js><xt>></xt> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlNs.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlNs.java b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlNs.java index 61c79d5..d42412c 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlNs.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlNs.java @@ -19,7 +19,7 @@ import java.lang.annotation.*; /** * Namespace name/URL mapping pair. * <p> - * Used to identify a namespace/URI pair on a {@link XmlSchema#xmlNs()} annotation. + * Used to identify a namespace/URI pair on a {@link XmlSchema#xmlNs()} annotation. */ @Documented @Target({}) http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java index 1bd5945..8d67da8 100644 --- a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java +++ b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java @@ -29,7 +29,7 @@ public @interface XmlSchema { /** * Sets the default XML prefix for all classes in this and child packages. * <p> - * Must either be matched with a {@link #namespace()} annotation, or an {@link #xmlNs()} mapping with the + * Must either be matched with a {@link #namespace()} annotation, or an {@link #xmlNs()} mapping with the * same {@link XmlNs#prefix} value. * </p> */ @@ -38,7 +38,7 @@ public @interface XmlSchema { /** * Sets the default XML namespace URL for all classes in this and child packages. * <p> - * Must either be matched with a {@link #prefix()} annotation, or an {@link #xmlNs()} mapping with the + * Must either be matched with a {@link #prefix()} annotation, or an {@link #xmlNs()} mapping with the * same {@link XmlNs#namespaceURI} value. * </p> */ @@ -47,14 +47,14 @@ public @interface XmlSchema { /** * Lists all namespace mappings to be used on all classes within this package. * <p> - * The purpose of this annotation is to allow namespace mappings to be defined in a single location + * The purpose of this annotation is to allow namespace mappings to be defined in a single location * and referred to by name through just the {@link Xml#prefix()} annotation. * <p> - * Inherited by child packages. + * Inherited by child packages. * * <h5 class='section'>Example:</h5> * <p> - * Contents of <code>package-info.java</code>... + * Contents of <code>package-info.java</code>... * </p> * <p class='bcode'> * <jc>// XML namespaces used within this package.</jc> @@ -70,7 +70,7 @@ public @interface XmlSchema { * <jk>import</jk> org.apache.juneau.xml.annotation.*; * </p> * <p> - * Class in package using defined namespaces... + * Class in package using defined namespaces... * </p> * <p class='bcode'> * <jk>package</jk> corg.apache.juneau.examples.addressbook; http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-examples-rest/src/main/java/org/apache/juneau/examples/addressbook/AddressBook.java ---------------------------------------------------------------------- diff --git a/juneau-examples-rest/src/main/java/org/apache/juneau/examples/addressbook/AddressBook.java b/juneau-examples-rest/src/main/java/org/apache/juneau/examples/addressbook/AddressBook.java index 3064809..28935df 100755 --- a/juneau-examples-rest/src/main/java/org/apache/juneau/examples/addressbook/AddressBook.java +++ b/juneau-examples-rest/src/main/java/org/apache/juneau/examples/addressbook/AddressBook.java @@ -19,7 +19,7 @@ import java.util.*; import org.apache.juneau.annotation.*; /** - * Address book bean + * Address book bean */ @Bean(typeName="addressBook") public class AddressBook extends LinkedList<Person> implements IAddressBook { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/TestMicroservice.java ---------------------------------------------------------------------- diff --git a/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/TestMicroservice.java b/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/TestMicroservice.java index 303b1ca..8cedc99 100644 --- a/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/TestMicroservice.java +++ b/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/TestMicroservice.java @@ -26,7 +26,7 @@ public class TestMicroservice { /** * Starts the microservice. * @return <jk>true</jk> if the service started, <jk>false</jk> if it's already started. - * If this returns <jk>false</jk> then don't call stopMicroservice()!. + * If this returns <jk>false</jk> then don't call stopMicroservice()!. */ public static boolean startMicroservice() { if (microservice != null) http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java ---------------------------------------------------------------------- diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java index b65354b..66a9c7d 100755 --- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java +++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java @@ -244,8 +244,8 @@ public abstract class Microservice { * <cc># Example config file</cc> * <cs>[MySection]</cs> * <ck>myEntry</ck> = $B{foo} - * </p> - * <p class='bcode'> + * </p> + * <p class='bcode'> * <jc>// Example java code</jc> * String myentry = getConfig().getString(<js>"MySection/myEntry"</js>); <jc>// == "[foo]"</js> * </p> @@ -337,8 +337,8 @@ public abstract class Microservice { * <cc># A POJO with embedded variables</cc> * <ck>aBean2</ck> = {foo:'$ARG{0}',baz:$C{MySection/anInt}} * - * </p> - * <p class='bcode'> + * </p> + * <p class='bcode'> * <jc>// Java code for accessing config entries above.</jc> * ConfigFile cf = getConfig(); * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java ---------------------------------------------------------------------- diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java index fe46dca..36cef4e 100755 --- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java +++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java @@ -402,7 +402,7 @@ public class RestMicroservice extends Microservice { * <ck>resources</ck> = * </p> * <p> - * In most cases, the rest resources will be specified in the manifest file since + * In most cases, the rest resources will be specified in the manifest file since * it's not likely to be a configurable property: * <p> * <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java ---------------------------------------------------------------------- diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java index 19e1757..da1cae9 100755 --- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java +++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java @@ -36,14 +36,14 @@ import org.apache.juneau.utils.*; /** * REST resource that allows access to a file system directory. * <p> - * The root directory is specified in one of two ways: + * The root directory is specified in one of two ways: * </p> * <ul class='spaced-list'> * <li>Specifying the location via a <l>DirectoryResource.rootDir</l> property. * <li>Overriding the {@link #getRootDir()} method. * </ul> * <p> - * Read/write access control is handled through the following properties: + * Read/write access control is handled through the following properties: * </p> * <ul class='spaced-list'> * <li><l>DirectoryResource.allowViews</l> - If <jk>true</jk>, allows view and download access to files. @@ -51,8 +51,7 @@ import org.apache.juneau.utils.*; * <li><l>DirectoryResource.allowDeletes</l> - If <jk>true</jk>, allows files to be deleted. * </ul> * <p> - * Access can also be controlled by overriding the {@link #checkAccess(RestRequest)} method. - * </p> + * Access can also be controlled by overriding the {@link #checkAccess(RestRequest)} method. */ @RestResource( title="File System Explorer", @@ -104,8 +103,8 @@ public class DirectoryResource extends Resource { /** * [GET /*] - * On directories, returns a directory listing. - * On files, returns information about the file. + * On directories, returns a directory listing. + * On files, returns information about the file. * * @param req The HTTP request. * @return Either a FileResource or list of FileResources depending on whether it's a @@ -144,7 +143,7 @@ public class DirectoryResource extends Resource { /** * [DELETE /*] - * Delete a file on the file system. + * Delete a file on the file system. * * @param req The HTTP request. * @return The message <js>"File deleted"</js> if successful. @@ -189,8 +188,8 @@ public class DirectoryResource extends Resource { /** * [VIEW /*] - * View the contents of a file. - * Applies to files only. + * View the contents of a file. + * Applies to files only. * * @param req The HTTP request. * @param res The HTTP response. @@ -217,8 +216,8 @@ public class DirectoryResource extends Resource { /** * [DOWNLOAD /*] - * Download the contents of a file. - * Applies to files only. + * Download the contents of a file. + * Applies to files only. * * @param req The HTTP request. * @param res The HTTP response. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java ---------------------------------------------------------------------- diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java index 08ec6bc..05d3a31 100644 --- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java +++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java @@ -25,14 +25,14 @@ import org.apache.juneau.internal.*; /** * Log entry formatter. * <p> - * Uses three simple parameter for configuring log entry formats: - * <ul class='spaced-list'> - * <li><code>dateFormat</code> - A {@link SimpleDateFormat} string describing the format for dates. - * <li><code>format</code> - A string with <code>{...}</code> replacement variables representing predefined fields. - * <li><code>useStackTraceHashes</code> - A setting that causes duplicate stack traces to be replaced with 8-character hash strings. - * </ul> + * Uses three simple parameter for configuring log entry formats: + * <ul class='spaced-list'> + * <li><code>dateFormat</code> - A {@link SimpleDateFormat} string describing the format for dates. + * <li><code>format</code> - A string with <code>{...}</code> replacement variables representing predefined fields. + * <li><code>useStackTraceHashes</code> - A setting that causes duplicate stack traces to be replaced with 8-character hash strings. + * </ul> * <p> - * This class converts the format strings into a regular expression that can be used to parse the resulting log file. + * This class converts the format strings into a regular expression that can be used to parse the resulting log file. */ public class LogEntryFormatter extends Formatter { @@ -46,17 +46,17 @@ public class LogEntryFormatter extends Formatter { * Create a new formatter. * * @param format The log entry format. e.g. <js>"[{date} {level}] {msg}%n"</js> - * The string can contain any of the following variables: - * <ol> - * <li><js>"{date}"</js> - The date, formatted per <js>"Logging/dateFormat"</js>. - * <li><js>"{class}"</js> - The class name. - * <li><js>"{method}"</js> - The method name. - * <li><js>"{logger}"</js> - The logger name. - * <li><js>"{level}"</js> - The log level name. - * <li><js>"{msg}"</js> - The log message. - * <li><js>"{threadid}"</js> - The thread ID. - * <li><js>"{exception}"</js> - The localized exception message. - * </ol> + * The string can contain any of the following variables: + * <ol> + * <li><js>"{date}"</js> - The date, formatted per <js>"Logging/dateFormat"</js>. + * <li><js>"{class}"</js> - The class name. + * <li><js>"{method}"</js> - The method name. + * <li><js>"{logger}"</js> - The logger name. + * <li><js>"{level}"</js> - The log level name. + * <li><js>"{msg}"</js> - The log message. + * <li><js>"{threadid}"</js> - The thread ID. + * <li><js>"{exception}"</js> - The localized exception message. + * </ol> * @param dateFormat The {@link SimpleDateFormat} format to use for dates. e.g. <js>"yyyy.MM.dd hh:mm:ss"</js>. * @param useStackTraceHashes If <jk>true</jk>, only print unique stack traces once and then refer to them by a * simple 8 character hash identifier. @@ -202,7 +202,7 @@ public class LogEntryFormatter extends Formatter { * <li><js>"msg"</js> * <li><js>"threadid"</js> * <li><js>"exception"</js> - * </ul> + * </ul> * @param m The matcher. * @return The field value, or <jk>null</jk> if the specified field does not exist. */
