Author: chas
Date: Thu Apr 24 00:17:12 2014
New Revision: 1589551
URL: http://svn.apache.org/r1589551
Log:
LANG-998 - Javadoc is not clear on preferred pattern to instantiate
FastDateParser / FastDatePrinter
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDateParser.java
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java?rev=1589551&r1=1589550&r2=1589551&view=diff
==============================================================================
---
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
(original)
+++
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
Thu Apr 24 00:17:12 2014
@@ -30,6 +30,16 @@ import java.util.TimeZone;
* <p>FastDateFormat is a fast and thread-safe version of
* {@link java.text.SimpleDateFormat}.</p>
*
+ * <p>To obtain an instance of FastDateFormat, use one of the static factory
methods:
+ * {@link #getInstance(String, TimeZone, Locale)}, {@link
#getDateInstance(int, TimeZone, Locale)},
+ * {@link #getTimeInstance(int, TimeZone, Locale)}, or {@link
#getDateTimeInstance(int, int, TimeZone, Locale)}
+ * </p>
+ *
+ * <p>Since FastDateFormat is thread safe, you can use a static member
instance:</p>
+ * <code>
+ * private static final FastDateFormat DATE_FORMATTER =
FastDateFormat.getDateTimeInstance(FastDateFormat.LONG, FastDateFormat.SHORT);
+ * </code>
+ *
* <p>This class can be used as a direct replacement to
* {@code SimpleDateFormat} in most formatting and parsing situations.
* This class is especially useful in multi-threaded server environments.
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDateParser.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDateParser.java?rev=1589551&r1=1589550&r2=1589551&view=diff
==============================================================================
---
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDateParser.java
(original)
+++
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDateParser.java
Thu Apr 24 00:17:12 2014
@@ -41,6 +41,14 @@ import java.util.regex.Pattern;
* <p>FastDateParser is a fast and thread-safe version of
* {@link java.text.SimpleDateFormat}.</p>
*
+ * <p>To obtain a proxy to a FastDateParser, use {@link
FastDateFormat#getInstance(String, TimeZone, Locale)}
+ * or another variation of the factory methods of {@link FastDateFormat}.</p>
+ *
+ * <p>Since FastDateParser is thread safe, you can use a static member
instance:</p>
+ * <code>
+ * private static final DateParser DATE_PARSER =
FastDateFormat.getInstance("yyyy-MM-dd");
+ * </code>
+ *
* <p>This class can be used as a direct replacement for
* <code>SimpleDateFormat</code> in most parsing situations.
* This class is especially useful in multi-threaded server environments.
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java?rev=1589551&r1=1589550&r2=1589551&view=diff
==============================================================================
---
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
(original)
+++
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
Thu Apr 24 00:17:12 2014
@@ -38,6 +38,14 @@ import org.apache.commons.lang3.Validate
* <p>FastDatePrinter is a fast and thread-safe version of
* {@link java.text.SimpleDateFormat}.</p>
*
+ * <p>To obtain a proxy to a FastDatePrinter, use {@link
FastDateFormat#getInstance(String, TimeZone, Locale)}
+ * or another variation of the factory methods of {@link FastDateFormat}.</p>
+ *
+ * <p>Since FastDatePrinter is thread safe, you can use a static member
instance:</p>
+ * <code>
+ * private static final DatePrinter DATE_PRINTER =
FastDateFormat.getInstance("yyyy-MM-dd");
+ * </code>
+ *
* <p>This class can be used as a direct replacement to
* {@code SimpleDateFormat} in most formatting situations.
* This class is especially useful in multi-threaded server environments.
