http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java index ce8df39..6a190a5 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java @@ -17,10 +17,12 @@ import org.apache.juneau.transform.*; /** * Transforms beans into {@link String Strings} by simply calling the {@link Object#toString()} method. + * * <p> * Allows you to specify classes that should just be converted to {@code Strings} instead of potentially * being turned into Maps by the {@link BeanContext} (or worse, throwing * {@link BeanRuntimeException BeanRuntimeExceptions}). + * * <p> * This is usually a one-way transform. * Beans serialized as strings cannot be reconstituted using a parser unless it is a
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java index 805fbd7..578e915 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java @@ -28,7 +28,7 @@ import org.apache.juneau.transform.*; * Transforms {@link Calendar Calendars} to {@link String Strings}. * * <h6 class='topic'>Behavior-specific subclasses</h6> - * <p> + * * The following direct subclasses are provided for convenience to the following formats: * <ul> * <li>{@link ToString} - To {@link String Strings} using the {@code Date.toString()} method. @@ -65,19 +65,25 @@ public class CalendarSwap extends StringSwap<Calendar> { /** * Constructor. + * * <p> * Only one of the <code>pattern</code> or <code>style</code> parameters should * - * @param pattern The {@link SimpleDateFormat} pattern. - * If <jk>null</jk>, <code>style</code> is used instead. - * @param dateStyle The {@link DateFormat} date style (e.g. {@link DateFormat#SHORT}). - * Ignored if <code>pattern</code> is not <jk>null</jk>. - * Ignored if <code>-1</code>. - * @param timeStyle The {@link DateFormat} time style (e.g. {@link DateFormat#SHORT}). - * Ignored if <code>pattern</code> is not <jk>null</jk>. - * Ignored if <code>-1</code>. - * @param timeZone The timeZone to use for dates. If <jk>null</jk> then either the timezone specified on the - * {@link Calendar} object or the timezone returned by {@link BeanSession#getTimeZone()} is used. + * @param pattern + * The {@link SimpleDateFormat} pattern. + * If <jk>null</jk>, <code>style</code> is used instead. + * @param dateStyle + * The {@link DateFormat} date style (e.g. {@link DateFormat#SHORT}). + * Ignored if <code>pattern</code> is not <jk>null</jk>. + * Ignored if <code>-1</code>. + * @param timeStyle + * The {@link DateFormat} time style (e.g. {@link DateFormat#SHORT}). + * Ignored if <code>pattern</code> is not <jk>null</jk>. + * Ignored if <code>-1</code>. + * @param timeZone + * The timeZone to use for dates. + * If <jk>null</jk> then either the timezone specified on the {@link Calendar} object or the timezone returned by + * {@link BeanSession#getTimeZone()} is used. */ protected CalendarSwap(String pattern, int dateStyle, int timeStyle, TimeZone timeZone) { this.pattern = pattern; @@ -523,10 +529,12 @@ public class CalendarSwap extends StringSwap<Calendar> { * Returns the {@link DateFormat} object for this session for formatting dates. * * @param session The current bean session. - * @param c Optional <code>Calendar</code> object to copy <code>TimeZone</code> from if not specified in session or - * <code>timeZone</code> setting. - * @return The {@link DateFormat} object. Multiple calls to this method on the same session will return a cached - * copy of date format object. + * @param c + * Optional <code>Calendar</code> object to copy <code>TimeZone</code> from if not specified in session or + * <code>timeZone</code> setting. + * @return + * The {@link DateFormat} object. + * Multiple calls to this method on the same session will return a cached copy of date format object. */ protected DateFormat getDateFormat(BeanSession session, Calendar c) { DateFormat df = session.getFromCache(DateFormat.class, this.getClass().getName()); http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java index 1bb74bb..a2c20ea 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java @@ -28,7 +28,7 @@ import org.apache.juneau.transform.*; * Transforms {@link Date Dates} to {@link String Strings}. * * <h6 class='topic'>Behavior-specific subclasses</h6> - * <p> + * * The following direct subclasses are provided for convenience to the following formats: * <ul> * <li>{@link ToString} - To {@link String Strings} using the {@code Date.toString()} method. @@ -65,19 +65,24 @@ public class DateSwap extends StringSwap<Date> { /** * Constructor. + * * <p> * Only one of the <code>pattern</code> or <code>style</code> parameters should * - * @param pattern The {@link SimpleDateFormat} pattern. - * If <jk>null</jk>, <code>style</code> is used instead. - * @param dateStyle The {@link DateFormat} date style (e.g. {@link DateFormat#SHORT}). - * Ignored if <code>pattern</code> is not <jk>null</jk>. - * Ignored if <code>-1</code>. - * @param timeStyle The {@link DateFormat} time style (e.g. {@link DateFormat#SHORT}). - * Ignored if <code>pattern</code> is not <jk>null</jk>. - * Ignored if <code>-1</code>. - * @param timeZone The timeZone to use for dates. If <jk>null</jk> then the timezone returned by - * {@link BeanSession#getTimeZone()} is used. + * @param pattern + * The {@link SimpleDateFormat} pattern. + * If <jk>null</jk>, <code>style</code> is used instead. + * @param dateStyle + * The {@link DateFormat} date style (e.g. {@link DateFormat#SHORT}). + * Ignored if <code>pattern</code> is not <jk>null</jk>. + * Ignored if <code>-1</code>. + * @param timeStyle + * The {@link DateFormat} time style (e.g. {@link DateFormat#SHORT}). + * Ignored if <code>pattern</code> is not <jk>null</jk>. + * Ignored if <code>-1</code>. + * @param timeZone + * The timeZone to use for dates. + * If <jk>null</jk> then the timezone returned by {@link BeanSession#getTimeZone()} is used. */ protected DateSwap(String pattern, int dateStyle, int timeStyle, TimeZone timeZone) { this.pattern = pattern; @@ -531,8 +536,9 @@ public class DateSwap extends StringSwap<Date> { * Returns the {@link DateFormat} object for this session for formatting dates. * * @param session The current bean session. - * @return The {@link DateFormat} object. Multiple calls to this method on the same session will return a cached - * copy of date format object. + * @return + * The {@link DateFormat} object. + * Multiple calls to this method on the same session will return a cached copy of date format object. */ protected DateFormat getDateFormat(BeanSession session) { DateFormat df = session.getFromCache(DateFormat.class, this.getClass().getName()); http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/transforms/EnumerationSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/EnumerationSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/EnumerationSwap.java index d1846c7..d90c75b 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transforms/EnumerationSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transforms/EnumerationSwap.java @@ -19,6 +19,7 @@ import org.apache.juneau.transform.*; /** * Transforms {@link Enumeration Enumerations} to {@code List<Object>} objects. + * * <p> * This is a one-way transform, since {@code Enumerations} cannot be reconstituted. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/transforms/IteratorSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/IteratorSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/IteratorSwap.java index 37ccaff..219baec 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transforms/IteratorSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transforms/IteratorSwap.java @@ -19,6 +19,7 @@ import org.apache.juneau.transform.*; /** * Transforms {@link Iterator Iterators} to {@code List<Object>} objects. + * * <p> * This is a one-way transform, since {@code Iterators} cannot be reconstituted. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java index 73f31e4..9c8a0a1 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java @@ -28,16 +28,18 @@ import org.apache.juneau.xml.*; * Transforms the contents of a {@link Reader} into an {@code Object}. * * <h5 class='section'>Description:</h5> - * <p> + * * The {@code Reader} must contain JSON, Juneau-generated XML (output from {@link XmlSerializer}), or Juneau-generated * HTML (output from {@link JsonSerializer}) in order to be parsed correctly. + * * <p> * Useful for serializing models that contain {@code Readers} created by {@code RestCall} instances. + * * <p> * This is a one-way transform, since {@code Readers} cannot be reconstituted. * * <h6 class='topic'>Behavior-specific subclasses</h6> - * <p> + * * The following direct subclasses are provided for convenience: * <ul> * <li>{@link Json} - Parses JSON text. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/transforms/XMLGregorianCalendarSwap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/XMLGregorianCalendarSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/XMLGregorianCalendarSwap.java index 31f26d3..ec0d9dc 100644 --- a/juneau-core/src/main/java/org/apache/juneau/transforms/XMLGregorianCalendarSwap.java +++ b/juneau-core/src/main/java/org/apache/juneau/transforms/XMLGregorianCalendarSwap.java @@ -23,8 +23,10 @@ import org.apache.juneau.transform.*; /** * Transforms {@link XMLGregorianCalendar XMLGregorianCalendars} to ISO8601 date-time {@link String Strings}. + * * <p> * Objects are converted to strings using {@link XMLGregorianCalendar#toXMLFormat()}. + * * <p> * Strings are converted to objects using {@link DatatypeFactory#newXMLGregorianCalendar(String)}. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/uon/UonParser.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonParser.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonParser.java index 7985742..cc8a19c 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonParser.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonParser.java @@ -29,15 +29,15 @@ import org.apache.juneau.transform.*; * Parses UON (a notation for URL-encoded query parameter values) text into POJO models. * * <h5 class='section'>Media types:</h5> - * <p> + * * Handles <code>Content-Type</code> types: <code>text/uon</code> * * <h5 class='section'>Description:</h5> - * <p> + * * 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: * <ul> * <li>{@link UonParserContext} @@ -104,8 +104,9 @@ public class UonParser extends ReaderParser { * @param eType The class type being parsed, or <jk>null</jk> if unknown. * @param r The reader being parsed. * @param outer The outer object (for constructing nested inner classes). - * @param isUrlParamValue If <jk>true</jk>, then we're parsing a top-level URL-encoded value which is treated a bit - * different than the default case. + * @param isUrlParamValue + * If <jk>true</jk>, then we're parsing a top-level URL-encoded value which is treated a bit different than the + * default case. * @param pMeta The current bean property being parsed. * @return The parsed object. * @throws Exception @@ -676,7 +677,7 @@ public class UonParser extends ReaderParser { private static final AsciiSet endCharsParam = new AsciiSet(""+AMP), endCharsNormal = new AsciiSet(",)"+AMP); - /** + /*= * Parses a string of the form "'foo'" * All whitespace within parenthesis are preserved. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java index b3ee739..168c539 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java @@ -54,13 +54,14 @@ public class UonParserBuilder extends ParserBuilder { /** * <b>Configuration property:</b> Decode <js>"%xx"</js> sequences. - * <p> + * * <ul> * <li><b>Name:</b> <js>"UonParser.decodeChars"</js> * <li><b>Data type:</b> <code>Boolean</code> * <li><b>Default:</b> <jk>false</jk> for {@link UonParser}, <jk>true</jk> for {@link UrlEncodingParser} * <li><b>Session-overridable:</b> <jk>true</jk> * </ul> + * * <p> * Specify <jk>true</jk> if URI encoded characters should be decoded, <jk>false</jk> if they've already been * decoded before being passed to this parser. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java index 7cf666b..aa5a02a 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java @@ -18,9 +18,11 @@ import org.apache.juneau.urlencoding.*; /** * Configurable properties on the {@link UonParser} class. + * * <p> * Context properties are set by calling {@link PropertyStore#setProperty(String, Object)} on the property store * passed into the constructor. + * * <p> * See {@link PropertyStore} for more information about context properties. * @@ -41,13 +43,14 @@ public class UonParserContext extends ParserContext { /** * <b>Configuration property:</b> Decode <js>"%xx"</js> sequences. - * <p> + * * <ul> * <li><b>Name:</b> <js>"UonParser.decodeChars"</js> * <li><b>Data type:</b> <code>Boolean</code> * <li><b>Default:</b> <jk>false</jk> for {@link UonParser}, <jk>true</jk> for {@link UrlEncodingParser} * <li><b>Session-overridable:</b> <jk>true</jk> * </ul> + * * <p> * Specify <jk>true</jk> if URI encoded characters should be decoded, <jk>false</jk> if they've already been decoded * before being passed to this parser. @@ -59,6 +62,7 @@ public class UonParserContext extends ParserContext { /** * Constructor. + * * <p> * Typically only called from {@link PropertyStore#getContext(Class)}. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/uon/UonParserSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserSession.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserSession.java index 95f685a..6fe5ef6 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserSession.java @@ -24,6 +24,7 @@ import org.apache.juneau.parser.*; /** * Session object that lives for the duration of a single use of {@link UonParser}. + * * <p> * This class is NOT thread safe. It is meant to be discarded after one-time use. */ @@ -35,24 +36,30 @@ public class UonParserSession 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. - * @param input The input. Can be any of the following types: - * <ul> - * <li><jk>null</jk> - * <li>{@link Reader} - * <li>{@link CharSequence} - * <li>{@link InputStream} containing UTF-8 encoded text. - * <li>{@link File} containing system encoded text. - * </ul> - * @param op The override properties. - * 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. + * @param input + * The input. + * Can be any of the following types: + * <ul> + * <li><jk>null</jk> + * <li>{@link Reader} + * <li>{@link CharSequence} + * <li>{@link InputStream} containing UTF-8 encoded text. + * <li>{@link File} containing system encoded text. + * </ul> + * @param op + * The override properties. + * 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. - * @param timeZone The session timezone. - * If <jk>null</jk>, then the timezone defined on the context is used. + * @param locale + * The session locale. + * 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. * @param mediaType The session media type (e.g. <js>"application/json"</js>). */ public UonParserSession(UonParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, @@ -67,19 +74,22 @@ public class UonParserSession extends ParserSession { /** * Create a specialized parser session for parsing URL parameters. + * * <p> * The main difference is that characters are never decoded, and the {@link UonParserContext#UON_decodeChars} * property is always ignored. * * @param ctx The context to copy setting from. - * @param input The input. Can be any of the following types: - * <ul> - * <li><jk>null</jk> - * <li>{@link Reader} - * <li>{@link CharSequence} (e.g. {@link String}) - * <li>{@link InputStream} - Read as UTF-8 encoded character stream. - * <li>{@link File} - Read as system-default encoded stream. - * </ul> + * @param input + * The input. + * Can be any of the following types: + * <ul> + * <li><jk>null</jk> + * <li>{@link Reader} + * <li>{@link CharSequence} (e.g. {@link String}) + * <li>{@link InputStream} - Read as UTF-8 encoded character stream. + * <li>{@link File} - Read as system-default encoded stream. + * </ul> */ public UonParserSession(UonParserContext ctx, Object input) { super(ctx, null, input, null, null, null, null, null); http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/uon/UonReader.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonReader.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonReader.java index 169896e..2f932bb 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonReader.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonReader.java @@ -18,8 +18,10 @@ import org.apache.juneau.parser.*; /** * Same functionality as {@link ParserReader} except automatically decoded <code>%xx</code> escape sequences. + * * <p> * Escape sequences are assumed to be encoded UTF-8. Extended Unicode (>\u10000) is supported. + * * <p> * If decoding is enabled, the following character replacements occur so that boundaries are not lost: * <ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializer.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializer.java index 346645e..c910bab 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializer.java @@ -28,27 +28,28 @@ import org.apache.juneau.transform.*; * Serializes POJO models to UON (a notation for URL-encoded query parameter values). * * <h5 class='section'>Media types:</h5> - * <p> + * * Handles <code>Accept</code> types: <code>text/uon</code> + * * <p> * 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. * * <h5 class='section'>Configurable properties:</h5> - * <p> + * * 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: - * </p> * <p class='bcode'> * { * id: 1, @@ -71,10 +72,9 @@ import org.apache.juneau.transform.*; * ] * } * </p> + * * <p> - * Using the "strict" syntax defined in this document, the equivalent - * UON notation would be as follows: - * </p> + * Using the "strict" syntax defined in this document, the equivalent UON notation would be as follows: * <p class='bcode'> * ( * <ua>id</ua>=<un>1</un>, @@ -208,8 +208,9 @@ public class UonSerializer extends WriterSerializer { * @param out The writer to serialize to. * @param o The object being serialized. * @param eType The expected type of the object if this is a bean property. - * @param attrName The bean property name if this is a bean property. - * <jk>null</jk> if this isn't a bean property being serialized. + * @param attrName + * The bean property name if this is a bean property. + * <jk>null</jk> if this isn't a bean property being serialized. * @param pMeta The bean property metadata. * @return The same writer passed in. * @throws Exception http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java index c516626..42ce35f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java @@ -54,15 +54,17 @@ public class UonSerializerBuilder extends SerializerBuilder { /** * <b>Configuration property:</b> Encode non-valid URI characters. - * <p> + * * <ul> * <li><b>Name:</b> <js>"UonSerializer.encodeChars"</js> * <li><b>Data type:</b> <code>Boolean</code> * <li><b>Default:</b> <jk>false</jk> for {@link UonSerializer}, <jk>true</jk> for {@link UrlEncodingSerializer} * <li><b>Session-overridable:</b> <jk>true</jk> * </ul> + * * <p> * Encode non-valid URI characters with <js>"%xx"</js> constructs. + * * <p> * If <jk>true</jk>, non-valid URI characters will be converted to <js>"%xx"</js> sequences. * Set to <jk>false</jk> if parameter value is being passed to some other code that will already perform http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java index 15ca313..f20dba1 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java @@ -18,9 +18,11 @@ import org.apache.juneau.urlencoding.*; /** * Configurable properties on the {@link UonSerializer} class. + * * <p> * Context properties are set by calling {@link PropertyStore#setProperty(String, Object)} on the property store * passed into the constructor. + * * <p> * See {@link PropertyStore} for more information about context properties. * @@ -41,15 +43,17 @@ public class UonSerializerContext extends SerializerContext { /** * <b>Configuration property:</b> Encode non-valid URI characters. - * <p> + * * <ul> * <li><b>Name:</b> <js>"UonSerializer.encodeChars"</js> * <li><b>Data type:</b> <code>Boolean</code> * <li><b>Default:</b> <jk>false</jk> for {@link UonSerializer}, <jk>true</jk> for {@link UrlEncodingSerializer} * <li><b>Session-overridable:</b> <jk>true</jk> * </ul> + * * <p> * Encode non-valid URI characters with <js>"%xx"</js> constructs. + * * <p> * If <jk>true</jk>, non-valid URI characters will be converted to <js>"%xx"</js> sequences. * Set to <jk>false</jk> if parameter value is being passed to some other code that will already perform @@ -59,19 +63,21 @@ public class UonSerializerContext extends SerializerContext { /** * <b>Configuration property:</b> Add <js>"_type"</js> properties when needed. - * <p> + * * <ul> * <li><b>Name:</b> <js>"UonSerializer.addBeanTypeProperties"</js> * <li><b>Data type:</b> <code>Boolean</code> * <li><b>Default:</b> <jk>false</jk> * <li><b>Session-overridable:</b> <jk>true</jk> * </ul> + * * <p> * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred * through reflection. * This is used to recreate the correct objects during parsing if the object types cannot be inferred. * For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined from * the value type. + * * <p> * When present, this value overrides the {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is * provided to customize the behavior of specific serializers in a {@link SerializerGroup}. @@ -80,15 +86,17 @@ public class UonSerializerContext extends SerializerContext { /** * <b>Configuration property:</b> Format to use for query/form-data/header values. - * <p> + * * <ul> * <li><b>Name:</b> <js>"UrlEncodingSerializer.paramFormat"</js> * <li><b>Data type:</b> <code>String</code> * <li><b>Default:</b> <js>"UON"</js> * <li><b>Session-overridable:</b> <jk>true</jk> * </ul> + * * <p> * Specifies the format to use for URL GET parameter keys and values. + * * <p> * The possible values are: * <ul class='spaced-list'> @@ -116,6 +124,7 @@ public class UonSerializerContext extends SerializerContext { /** * Constructor. + * * <p> * Typically only called from {@link PropertyStore#getContext(Class)}. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerSession.java index 82c2e42..df88809 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerSession.java @@ -25,6 +25,7 @@ import org.apache.juneau.serializer.*; /** * Session object that lives for the duration of a single use of {@link UonSerializer}. + * * <p> * This class is NOT thread safe. It is meant to be discarded after one-time use. */ @@ -38,20 +39,25 @@ 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. + * @param ctx + * The context creating this session object. + * The context contains all the configuration settings for this object. * @param encode Override the {@link UonSerializerContext#UON_encodeChars} setting. * @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. + * @param op + * The override properties. + * These override any context properties defined in the context. * @param javaMethod The java method that called this serializer, 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. - * @param timeZone The session timezone. - * If <jk>null</jk>, then the timezone defined on the context is used. + * @param locale + * The session locale. + * 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. * @param mediaType The session media type (e.g. <js>"application/json"</js>). - * @param uriContext The URI context. - * Identifies the current request URI used for resolution of URIs to absolute or root-relative form. + * @param uriContext + * The URI context. + * Identifies the current request URI used for resolution of URIs to absolute or root-relative form. */ protected UonSerializerSession(UonSerializerContext ctx, Boolean encode, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/uon/UonUtils.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonUtils.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonUtils.java index 811b716..50290da 100644 --- a/juneau-core/src/main/java/org/apache/juneau/uon/UonUtils.java +++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonUtils.java @@ -26,6 +26,7 @@ public final class UonUtils { /** * Returns <jk>true</jk> if the specified string needs to be quoted per UON notation. + * * <p> * For example, strings that start with '(' or '@' or look like boolean or numeric values need to be quoted. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 a419e48..3c71a4a 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 @@ -14,17 +14,20 @@ package org.apache.juneau.urlencoding; /** * Configurable properties on the {@link UrlEncodingSerializer} and {@link UrlEncodingParser} classes. + * * <p> * Use the {@link UrlEncodingSerializerBuilder#property(String, Object)} and - * {@link UrlEncodingParserBuilder#property(String, Object)} methods to set property values. + * {@link UrlEncodingParserBuilder#property(String, Object)} methods to set property values. */ 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>. + * * <p> * Example: * <p class='bcode'> @@ -39,6 +42,7 @@ public final class UrlEncodingContext implements Cloneable { * String ss1 = s1.serialize(<jk>new</jk> A()); <jc>// Produces "f1=(a,b)&f2=(c,d)"</jc> * String ss2 = s2.serialize(<jk>new</jk> A()); <jc>// Produces "f1=a&f1=b&f2=c&f2=d"</jc> * </p> + * * <p> * This option only applies to beans. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 de01c47..d07d778 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 @@ -30,19 +30,21 @@ import org.apache.juneau.uon.*; * Parses URL-encoded text into POJO models. * * <h5 class='section'>Media types:</h5> - * <p> + * * 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. + * * <p> * Expects parameter values to be in UON notation. + * * <p> * 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: * <ul> * <li>{@link UonParserContext} @@ -61,6 +63,7 @@ public class UrlEncodingParser extends UonParser implements PartParser { /** * Constructor. + * * @param propertyStore The property store containing all the settings for this object. */ public UrlEncodingParser(PropertyStore propertyStore) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java index 4e96bb4..71b6383 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java @@ -35,6 +35,7 @@ public class UrlEncodingParserBuilder extends UonParserBuilder { /** * Constructor. + * * @param propertyStore The initial configuration settings for this builder. */ public UrlEncodingParserBuilder(PropertyStore propertyStore) { @@ -53,13 +54,14 @@ public class UrlEncodingParserBuilder extends UonParserBuilder { /** * <b>Configuration property:</b> Serialize bean property collections/arrays as separate key/value pairs. - * <p> + * * <ul> * <li><b>Name:</b> <js>"UrlEncoding.expandedParams"</js> * <li><b>Data type:</b> <code>Boolean</code> * <li><b>Default:</b> <jk>false</jk> * <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>. @@ -77,6 +79,7 @@ public class UrlEncodingParserBuilder extends UonParserBuilder { * String ss1 = p1.serialize(<jk>new</jk> A()); <jc>// Produces "f1=(a,b)&f2=(c,d)"</jc> * String ss2 = 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. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 c26779a..fbcb41b 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 @@ -17,9 +17,11 @@ import org.apache.juneau.uon.*; /** * Configurable properties on the {@link UrlEncodingParser} class. + * * <p> * Context properties are set by calling {@link PropertyStore#setProperty(String, Object)} on the property store * passed into the constructor. + * * <p> * See {@link PropertyStore} for more information about context properties. */ @@ -30,6 +32,7 @@ public class UrlEncodingParserContext extends UonParserContext { /** * Constructor. + * * <p> * Typically only called from {@link PropertyStore#getContext(Class)}. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 a31768c..5c1ff7e 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 @@ -22,6 +22,7 @@ import org.apache.juneau.uon.*; /** * Session object that lives for the duration of a single use of {@link UrlEncodingParser}. + * * <p> * This class is NOT thread safe. It is meant to be discarded after one-time use. */ @@ -32,9 +33,12 @@ 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. - * @param input The input. Can be any of the following types: + * @param ctx + * The context creating this session 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> * <li>{@link Reader} @@ -42,14 +46,17 @@ public class UrlEncodingParserSession extends UonParserSession { * <li>{@link InputStream} containing UTF-8 encoded text. * <li>{@link File} containing system encoded text. * </ul> - * @param op The override properties. - * These override any context properties defined in the context. + * @param op + * The override properties. + * 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. - * @param timeZone The session timezone. - * If <jk>null</jk>, then the timezone defined on the context is used. + * @param locale + * The session locale. + * 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. * @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/f400b0c0/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 4db9313..e5c40c4 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 @@ -33,26 +33,26 @@ import org.apache.juneau.uon.*; * Serializes POJO models to URL-encoded notation with UON-encoded values (a notation for URL-encoded query paramter values). * * <h5 class='section'>Media types:</h5> - * <p> + * * 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> * * <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. * * <h5 class='section'>Configurable properties:</h5> - * <p> + * * 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: - * </p> * <p class='bcode'> * { * id: 1, @@ -75,10 +75,9 @@ import org.apache.juneau.uon.*; * ] * } * </p> + * * <p> - * Using the "strict" syntax defined in this document, the equivalent - * URL-encoded notation would be as follows: - * </p> + * Using the "strict" syntax defined in this document, the equivalent URL-encoded notation would be as follows: * <p class='bcode'> * <ua>id</ua>=<un>1</un> * &<ua>name</ua>=<us>'John+Smith'</us>, @@ -155,6 +154,7 @@ public class UrlEncodingSerializer extends UonSerializer implements PartSerializ /** * Constructor. + * * @param propertyStore The property store containing all the settings for this object. */ public Expanded(PropertyStore propertyStore) { @@ -174,6 +174,7 @@ public class UrlEncodingSerializer extends UonSerializer implements PartSerializ /** * Constructor. + * * @param propertyStore The property store containing all the settings for this object. */ public Readable(PropertyStore propertyStore) { @@ -193,6 +194,7 @@ public class UrlEncodingSerializer extends UonSerializer implements PartSerializ /** * Constructor. + * * @param propertyStore The property store containing all the settings for this object. */ public PlainText(PropertyStore propertyStore) { @@ -209,6 +211,7 @@ public class UrlEncodingSerializer extends UonSerializer implements PartSerializ /** * Constructor. + * * @param propertyStore The property store containing all the settings for this object. */ public UrlEncodingSerializer(PropertyStore propertyStore) { @@ -227,8 +230,7 @@ public class UrlEncodingSerializer extends UonSerializer implements PartSerializ } /** - * Workhorse method. Determines the type of object, and then calls the - * appropriate type-specific serialization method. + * Workhorse method. Determines the type of object, and then calls the appropriate type-specific serialization method. */ @SuppressWarnings({ "rawtypes", "unchecked" }) private SerializerWriter serializeAnything(UrlEncodingSerializerSession session, UonWriter out, Object o) throws Exception { @@ -405,15 +407,19 @@ public class UrlEncodingSerializer extends UonSerializer implements PartSerializ //-------------------------------------------------------------------------------- /** - * Converts the specified object to a string using this serializers {@link BeanSession#convertToType(Object, Class)} method - * and runs {@link URLEncoder#encode(String,String)} against the results. + * Converts the specified object to a string using this serializers {@link BeanSession#convertToType(Object, Class)} + * method and runs {@link URLEncoder#encode(String,String)} against the results. + * + * <p> * Useful for constructing URL parts. * * @param o The object to serialize. - * @param urlEncode URL-encode the string if necessary. - * If <jk>null</jk>, then uses the value of the {@link UonSerializerContext#UON_encodeChars} setting. - * @param plainTextParams Whether we're using plain-text params. - * If <jk>null</jk>, then uses the value from the {@link UrlEncodingSerializerContext#URLENC_paramFormat} setting. + * @param urlEncode + * URL-encode the string if necessary. + * If <jk>null</jk>, then uses the value of the {@link UonSerializerContext#UON_encodeChars} setting. + * @param plainTextParams + * Whether we're using plain-text params. + * If <jk>null</jk>, then uses the value from the {@link UrlEncodingSerializerContext#URLENC_paramFormat} setting. * @return The serialized object. */ private String serializePart(Object o, Boolean urlEncode, Boolean plainTextParams) { @@ -446,7 +452,8 @@ public class UrlEncodingSerializer extends UonSerializer implements PartSerializ //-------------------------------------------------------------------------------- @Override /* Serializer */ - public UrlEncodingSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) { + public UrlEncodingSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, + TimeZone timeZone, MediaType mediaType, UriContext uriContext) { return new UrlEncodingSerializerSession(ctx, null, op, output, javaMethod, locale, timeZone, mediaType, uriContext); } http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java index abaf23f..16e8f51 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java @@ -33,6 +33,7 @@ public class UrlEncodingSerializerBuilder extends UonSerializerBuilder { /** * Constructor. + * * @param propertyStore The initial configuration settings for this builder. */ public UrlEncodingSerializerBuilder(PropertyStore propertyStore) { @@ -51,13 +52,14 @@ public class UrlEncodingSerializerBuilder extends UonSerializerBuilder { /** * <b>Configuration property:</b> Serialize bean property collections/arrays as separate key/value pairs. - * <p> + * * <ul> * <li><b>Name:</b> <js>"UrlEncoding.expandedParams"</js> * <li><b>Data type:</b> <code>Boolean</code> * <li><b>Default:</b> <jk>false</jk> * <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>. @@ -75,6 +77,7 @@ public class UrlEncodingSerializerBuilder extends UonSerializerBuilder { * String ss1 = s1.serialize(<jk>new</jk> A()); <jc>// Produces "f1=(a,b)&f2=(c,d)"</jc> * String ss2 = s2.serialize(<jk>new</jk> A()); <jc>// Produces "f1=a&f1=b&f2=c&f2=d"</jc> * </p> + * * <p> * This option only applies to beans. * @@ -101,15 +104,17 @@ public class UrlEncodingSerializerBuilder extends UonSerializerBuilder { /** * <b>Configuration property:</b> Format to use for top-level query names and simple parameters. - * <p> + * * <ul> * <li><b>Name:</b> <js>"UrlEncodingSerializer.paramFormat"</js> * <li><b>Data type:</b> <code>String</code> * <li><b>Default:</b> <js>"UON"</js> * <li><b>Session-overridable:</b> <jk>true</jk> * </ul> + * * <p> * Specifies the format to use for URL GET parameter keys and values. + * * <p> * The possible values are: * <ul class='spaced-list'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerContext.java index d7ff160..87531c4 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerContext.java @@ -17,9 +17,11 @@ import org.apache.juneau.uon.*; /** * Configurable properties on the {@link UrlEncodingSerializer} class. + * * <p> * Context properties are set by calling {@link PropertyStore#setProperty(String, Object)} on the property store * passed into the constructor. + * * <p> * See {@link PropertyStore} for more information about context properties. */ @@ -31,6 +33,7 @@ public class UrlEncodingSerializerContext extends UonSerializerContext { /** * Constructor. + * * <p> * Typically only called from {@link PropertyStore#getContext(Class)}. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 d9c39d9..e2dd42a 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 @@ -22,6 +22,7 @@ import org.apache.juneau.uon.*; /** * Session object that lives for the duration of a single use of {@link UrlEncodingSerializer}. + * * <p> * This class is NOT thread safe. It is meant to be discarded after one-time use. */ @@ -32,22 +33,28 @@ public class UrlEncodingSerializerSession extends UonSerializerSession { /** * Create a new session using properties specified in the context. * - * @param ctx The context creating this session object. + * @param ctx + * The context creating this session object. * The context contains all the configuration settings for this object. * @param encode Overrides the {@link UonSerializerContext#UON_encodeChars} setting. * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types. - * @param op The override properties. + * @param op + * The override properties. * These override any context properties defined in the context. * @param javaMethod The java method that called this serializer, usually the method in a REST servlet. - * @param locale The session locale. + * @param locale + * The session locale. * If <jk>null</jk>, then the locale defined on the context is used. - * @param timeZone The session timezone. + * @param timeZone + * The session timezone. * 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>). - * @param uriContext The URI context. + * @param uriContext + * The URI context. * Identifies the current request URI used for resolution of URIs to absolute or root-relative form. */ - public UrlEncodingSerializerSession(UrlEncodingSerializerContext ctx, Boolean encode, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) { + public UrlEncodingSerializerSession(UrlEncodingSerializerContext ctx, Boolean encode, ObjectMap op, Object output, + Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) { super(ctx, encode, op, output, javaMethod, locale, timeZone, mediaType, uriContext); if (op == null || op.isEmpty()) { expandedParams = ctx.expandedParams; http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java index fd7bd75..2576e58 100644 --- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java +++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java @@ -31,6 +31,7 @@ public @interface UrlEncoding { /** * When true, bean properties of type array or Collection will be expanded into multiple key/value pairings. + * * <p> * This annotation is identical in behavior to using the {@link UrlEncodingContext#URLENC_expandedParams} * property, but applies to only instances of this bean. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/utils/AList.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/AList.java b/juneau-core/src/main/java/org/apache/juneau/utils/AList.java index 7d5dc64..6a0fc9c 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/AList.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/AList.java @@ -16,6 +16,7 @@ import java.util.*; /** * An extension of {@link LinkedList} with a convenience {@link #append(Object)} method. + * * <p> * Primarily used for testing purposes for quickly creating populated lists. * <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/utils/AMap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/AMap.java b/juneau-core/src/main/java/org/apache/juneau/utils/AMap.java index 8fe5d92..e6a8420 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/AMap.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/AMap.java @@ -16,6 +16,7 @@ import java.util.*; /** * An extension of {@link LinkedHashMap} with a convenience {@link #append(Object,Object)} method. + * * <p> * Primarily used for testing purposes for quickly creating populated maps. * <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/utils/ASet.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/ASet.java b/juneau-core/src/main/java/org/apache/juneau/utils/ASet.java index 86dc8ca..65320cc 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/ASet.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/ASet.java @@ -16,6 +16,7 @@ import java.util.*; /** * An extension of {@link LinkedHashSet} with a convenience {@link #append(Object)} method. + * * <p> * Primarily used for testing purposes for quickly creating populated sets. * <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 240d609..fd8c8ad 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 @@ -21,11 +21,14 @@ import org.apache.juneau.*; /** * Utility class to make it easier to work with command-line arguments pass in through a * <code>main(String[] args)</code> method. + * * <p> * Used to parse command-line arguments of the form * <js>"[zero or more main arguments] [zero or more optional arguments]"</js>. + * * <p> * The format of a main argument is a token that does not start with <js>'-'</js>. + * * <p> * The format of an optional argument is <js>"-argName [zero or more tokens]"</js>. * @@ -83,6 +86,7 @@ import org.apache.juneau.*; * List<String> a2 = a.getArgs(<js>"a2"</js>); <jc>// Contains ["v2a","v2b"]</jc> * } * </p> + * * <p> * Main arguments are available through numeric string keys (e.g. <js>"0"</js>, <js>"1"</js>, ...). * So you could use the {@link ObjectMap} API to convert main arguments directly to POJOs, such as an <code>Enum</code> @@ -93,6 +97,7 @@ import org.apache.juneau.*; * <jc>// Get 1st main argument as an integer</jc> * int i = a.get(<jk>int</jk>.<jk>class</jk>, <js>"0"</js>); * </p> + * * <p> * Equivalent operations are available on optional arguments through the {@link #getArg(Class, String)} method. */ @@ -136,6 +141,7 @@ public final class Args extends ObjectMap { /** * Returns main argument at the specified index, or <jk>null</jk> if the index is out of range. + * * <p> * Can be used in conjunction with {@link #hasArg(int)} to check for existence of arg. * <p class='bcode'> @@ -146,6 +152,7 @@ public final class Args extends ObjectMap { * <jc>// Get the first argument</jc> * String firstArg = args.getArg(0); * </p> + * * <p> * Since main arguments are stored as numeric keys, this method is essentially equivalent to... * <p class='bcode'> @@ -176,6 +183,7 @@ public final class Args extends ObjectMap { /** * Returns the optional argument value, or blank if the optional argument was not specified. + * * <p> * If the optional arg has multiple values, returns values as a comma-delimited list. * @@ -193,6 +201,7 @@ public final class Args extends ObjectMap { /** * Returns the optional argument value converted to the specified object type. + * * <p> * If the optional arg has multiple values, returns only the first converted value. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 e4f94af..8637929 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 @@ -23,6 +23,7 @@ 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... * <p class='bcode'> @@ -30,6 +31,7 @@ import org.apache.juneau.internal.*; * 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)}. @@ -108,6 +110,8 @@ public class IOPipe { /** * Specifies whether the content should be piped line-by-line. + * + * <p> * This can be useful if you're trying to pipe console-based input. * * @param byLines Pipe content line-by-line. Default is <jk>false</jk>. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/utils/ManifestFile.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/ManifestFile.java b/juneau-core/src/main/java/org/apache/juneau/utils/ManifestFile.java index fb024ba..1690a19 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/ManifestFile.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/ManifestFile.java @@ -23,6 +23,7 @@ import org.apache.juneau.*; /** * Utility class for working with Jar manifest files. + * * <p> * Copies the contents of a {@link Manifest} into an {@link ObjectMap} so that the various convenience methods on that * class can be used to retrieve values. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 0df8d33..2a10f00 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 @@ -24,6 +24,7 @@ import org.apache.juneau.annotation.*; /** * Wraps a {@link ResourceBundle} to provide some useful additional functionality. + * * <ul class='spaced-list'> * <li> * Instead of throwing {@link MissingResourceException}, the {@link #getString(String)} method @@ -72,8 +73,8 @@ public class MessageBundle extends ResourceBundle { private final ConcurrentHashMap<Locale,MessageBundle> localizedBundles = new ConcurrentHashMap<Locale,MessageBundle>(); /** - * Sets the locale for this thread so that calls to {@link #getClientString(String, Object...)} return - * messages in that locale. + * Sets the locale for this thread so that calls to {@link #getClientString(String, Object...)} return messages in + * that locale. * * @param locale The new client locale. */ @@ -85,10 +86,10 @@ public class MessageBundle extends ResourceBundle { * Constructor. * * @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 - * relative to the package of the <l>forClass</l> (e.g. <js>"MyMessages"</js> if <l>forClass</l> is - * <js>"com.foo.MyClass"</js>). + * @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 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) { this(forClass, bundlePath, Locale.getDefault()); @@ -136,7 +137,10 @@ public class MessageBundle extends ResourceBundle { /** * Add another bundle path to this resource bundle. + * + * <p> * Order of property lookup is first-to-last. + * * <p> * This method must be called from the same thread as the call to the constructor. * This eliminates the need for synchronization. @@ -166,9 +170,10 @@ public class MessageBundle extends ResourceBundle { * * @param key The resource bundle key. * @param args Optional {@link MessageFormat}-style arguments. - * @return The resolved value. Never <jk>null</jk>. - * <js>"{!!key}"</js> if the bundle is missing. - * <js>"{!key}"</js> if the key is missing. + * @return + * The resolved value. Never <jk>null</jk>. + * <js>"{!!key}"</js> if the bundle is missing. + * <js>"{!key}"</js> if the key is missing. */ public String getString(String key, Object...args) { String s = getString(key); @@ -183,9 +188,10 @@ public class MessageBundle extends ResourceBundle { * @param locale The locale of the resource bundle to retrieve message from. * @param key The resource bundle key. * @param args Optional {@link MessageFormat}-style arguments. - * @return The resolved value. Never <jk>null</jk>. - * <js>"{!!key}"</js> if the bundle is missing. - * <js>"{!key}"</js> if the key is missing. + * @return + * The resolved value. Never <jk>null</jk>. + * <js>"{!!key}"</js> if the bundle is missing. + * <js>"{!key}"</js> if the key is missing. */ public String getString(Locale locale, String key, Object...args) { if (locale == null) @@ -194,14 +200,14 @@ public class MessageBundle extends ResourceBundle { } /** - * Same as {@link #getString(String, Object...)} but uses the locale specified on the call to - * {@link #setClientLocale(Locale)}. + * Same as {@link #getString(String, Object...)} but uses the locale specified on the call to {@link #setClientLocale(Locale)}. * * @param key The resource bundle key. * @param args Optional {@link MessageFormat}-style arguments. - * @return The resolved value. Never <jk>null</jk>. - * <js>"{!!key}"</js> if the bundle is missing. - * <js>"{!key}"</js> if the key is missing. + * @return + * The resolved value. Never <jk>null</jk>. + * <js>"{!!key}"</js> if the bundle is missing. + * <js>"{!key}"</js> if the key is missing. */ public String getClientString(String key, Object...args) { return getString(clientLocale.get(), key, args); @@ -283,10 +289,12 @@ public class MessageBundle extends ResourceBundle { /** * Returns this resource bundle as an {@link ObjectMap}. + * * <p> * Useful for debugging purposes. * Note that any class that implements a <code>toObjectMap()</code> method will automatically be serialized by * calling this method and serializing the result. + * * <p> * This method always constructs a new {@link ObjectMap} on each call. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/utils/MetadataMap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/MetadataMap.java b/juneau-core/src/main/java/org/apache/juneau/utils/MetadataMap.java index 127536b..459f200 100644 --- a/juneau-core/src/main/java/org/apache/juneau/utils/MetadataMap.java +++ b/juneau-core/src/main/java/org/apache/juneau/utils/MetadataMap.java @@ -20,8 +20,10 @@ import org.apache.juneau.*; /** * Utility class for quick lookup of class metadata instances. + * * <p> * Class instances are created once and then cached. + * * <p> * Classes must have a constructor that takes in a single argument. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 26879ca..c1350a0 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 @@ -17,8 +17,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 the value if possible. + * * <p> * The following conversions are valid: * <table class='styled'> @@ -165,8 +167,9 @@ public class ObjectUtils { * Converts the specified object to the specified type. * * @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. + * @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. * @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. @@ -175,5 +178,4 @@ public class ObjectUtils { public static <T> T convertToType(Object outer, Object value, Class<T> type) { return session.convertToType(outer, value, type); } - } http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 3c4a32c..1ee714e 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 @@ -61,24 +61,27 @@ public final class PojoIntrospector { * Primary method. Invokes the specified method on this bean. * * @param method The method being invoked. - * @param args The arguments to pass as parameters to the method. - * These will automatically be converted to the appropriate object type if possible. - * Can be <jk>null</jk> if method has no arguments. + * @param args + * The arguments to pass as parameters to the method. + * These will automatically be converted to the appropriate object type if possible. + * 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: - * <ul class='spaced-list'> - * <li> - * The number of actual and formal parameters differ. - * <li> - * An unwrapping conversion for primitive arguments fails. - * <li> - * A parameter value cannot be converted to the corresponding formal parameter type by a method invocation - * conversion. - * <li> - * The constructor pertains to an enum type. - * </ul> + * @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: + * <ul class='spaced-list'> + * <li> + * The number of actual and formal parameters differ. + * <li> + * An unwrapping conversion for primitive arguments fails. + * <li> + * A parameter value cannot be converted to the corresponding formal parameter type by a method invocation + * conversion. + * <li> + * The constructor pertains to an enum type. + * </ul> * @throws InvocationTargetException If the underlying constructor throws an exception. * @throws ParseException If the input contains a syntax error or is malformed. * @throws IOException @@ -95,25 +98,28 @@ public final class PojoIntrospector { * Convenience method for invoking argument from method signature (@see {@link ClassUtils#getMethodSignature(Method)}. * * @param method The method being invoked. - * @param args The arguments to pass as parameters to the method. - * These will automatically be converted to the appropriate object type if possible. - * Can be <jk>null</jk> if method has no arguments. + * @param args + * The arguments to pass as parameters to the method. + * These will automatically be converted to the appropriate object type if possible. + * 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. - * @throws IllegalArgumentException If one of the following occurs: - * <ul class='spaced-list'> - * <li> - * The number of actual and formal parameters differ. - * <li> - * An unwrapping conversion for primitive arguments fails. - * <li> - * A parameter value cannot be converted to the corresponding formal parameter type by a method invocation - * conversion. - * <li> - * The constructor pertains to an enum type. - * </ul> + * @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: + * <ul class='spaced-list'> + * <li> + * The number of actual and formal parameters differ. + * <li> + * An unwrapping conversion for primitive arguments fails. + * <li> + * A parameter value cannot be converted to the corresponding formal parameter type by a method invocation + * conversion. + * <li> + * The constructor pertains to an enum type. + * </ul> * @throws InvocationTargetException If the underlying constructor throws an exception. * @throws ParseException If the input contains a syntax error or is malformed. * @throws IOException http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 9b83677..d448a7c 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 @@ -25,8 +25,10 @@ import org.apache.juneau.internal.*; /** * Designed to provide search/view/sort/paging filtering on tabular in-memory POJO models. + * * <p> * It can also perform just view filtering on beans/maps. + * * <p> * Examples of tabular POJO models: * <ul> @@ -35,6 +37,7 @@ import org.apache.juneau.internal.*; * <li><tt>Map[]</tt> * <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... * <p class='bcode'> @@ -46,11 +49,12 @@ import org.apache.juneau.internal.*; * <p> * ... can be thought of a table containing the following columns... * <p> - * <table class='styled code'> - * <tr><th>myInt</th><th>myString</th><th>myDate</th></tr> - * <tr><td>123</td><td>'foobar'</td><td>yyyy/MM/dd HH:mm:ss</td></tr> - * <tr><td colspan=3>...</td></tr> - * </table> + * <table class='styled code'> + * <tr><th>myInt</th><th>myString</th><th>myDate</th></tr> + * <tr><td>123</td><td>'foobar'</td><td>yyyy/MM/dd HH:mm:ss</td></tr> + * <tr><td colspan=3>...</td></tr> + * </table> + * * <p> * From this table, you can perform the following functions: * <ul class='spaced-list'> @@ -65,7 +69,7 @@ import org.apache.juneau.internal.*; * </ul> * * <h5 class='topic'>Search</h5> - * <p> + * * The search capabilities 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>Multiple search patterns are ANDed (i.e. all patterns must match for the row to be returned). @@ -81,7 +85,7 @@ import org.apache.juneau.internal.*; * </ul> * * <h5 class='topic'>String Patterns</h5> - * <p> + * * 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. @@ -107,7 +111,7 @@ import org.apache.juneau.internal.*; * </ul> * * <h5 class='topic'>Numeric Patterns</h5> - * <p> + * * Any object of type {@link Number} (or numeric primitives) can be searched using numeric patterns. * * <h6 class='topic'>Example numeric query patterns:</h6> @@ -131,11 +135,12 @@ import org.apache.juneau.internal.*; * </ul> * * <h5 class='topic'>Date Patterns</h5> - * <p> + * * 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> @@ -162,7 +167,7 @@ import org.apache.juneau.internal.*; * </ul> * * <h5 class='topic'>View</h5> - * <p> + * * 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>. * @@ -173,7 +178,7 @@ import org.apache.juneau.internal.*; * </ul> * * <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 strings with an optional <js>'+'</js> or <js>'-'</js> suffix representing * ascending and descending order accordingly. @@ -187,7 +192,7 @@ import org.apache.juneau.internal.*; * </ul> * * <h5 class='topic'>Paging</h5> - * <p> + * * Use the <tt>position</tt> and <tt>limit</tt> parameters to specify a subset of rows to return. */ @SuppressWarnings({"unchecked","rawtypes"}) @@ -672,6 +677,8 @@ public final class PojoQuery { /** * Returns <jk>true</jk> if the specified date matches the pattern passed in through the constructor. + * + * <p> * <br>The Object can be of type {@link Date} or {@link Calendar}. * <br>Always returns <jk>false</jk> on <jk>null</jk> input. */ @@ -1124,6 +1131,8 @@ public final class PojoQuery { /** * Replaces tokens in a string with a different token. + * + * <p> * replace("A and B and C", "and", "or") -> "A or B or C" * replace("andandand", "and", "or") -> "ororor" * replace(null, "and", "or") -> null
