Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

<action issue="LANG-1001" type="fix" dev="ggregory" due-to="Michael Osipov">ISO 8601 misspelled throughout the Javadocs</action> 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1591488 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2014-04-30 21:49:35 +00:00
parent 6125951060
commit b4b51a8fc9
7 changed files with 21 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/changes/changes.xml
View File

@ -22,6 +22,7 @@
<body>
<release version="3.4" date="tba" description="tba">
<action issue="LANG-1001" type="fix" dev="ggregory" due-to="Michael Osipov">ISO 8601 misspelled throughout the Javadocs</action>
<action issue="LANG-994" type="add" dev="britter" due-to="Mikhail Mazursky">Add zero copy read method to StrBuilder</action>
<action issue="LANG-993" type="add" dev="britter" due-to="Mikhail Mazursky">Add zero copy write method to StrBuilder</action>
<action issue="LANG-998" type="update" dev="chas">Javadoc is not clear on preferred pattern to instantiate FastDateParser / FastDatePrinter</action>

22
src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java
View File

@ -41,62 +41,62 @@ public class DateFormatUtils {
*/
private static final TimeZone UTC_TIME_ZONE = TimeZone.getTimeZone("GMT");
/**
* ISO8601 formatter for date-time without time zone.
* ISO 8601 formatter for date-time without time zone.
* The format used is <tt>yyyy-MM-dd'T'HH:mm:ss</tt>.
*/
public static final FastDateFormat ISO_DATETIME_FORMAT
= FastDateFormat.getInstance("yyyy-MM-dd'T'HH:mm:ss");
/**
* ISO8601 formatter for date-time with time zone.
* ISO 8601 formatter for date-time with time zone.
* The format used is <tt>yyyy-MM-dd'T'HH:mm:ssZZ</tt>.
*/
public static final FastDateFormat ISO_DATETIME_TIME_ZONE_FORMAT
= FastDateFormat.getInstance("yyyy-MM-dd'T'HH:mm:ssZZ");
/**
* ISO8601 formatter for date without time zone.
* ISO 8601 formatter for date without time zone.
* The format used is <tt>yyyy-MM-dd</tt>.
*/
public static final FastDateFormat ISO_DATE_FORMAT
= FastDateFormat.getInstance("yyyy-MM-dd");
/**
* ISO8601-like formatter for date with time zone.
* ISO 8601-like formatter for date with time zone.
* The format used is <tt>yyyy-MM-ddZZ</tt>.
* This pattern does not comply with the formal ISO8601 specification
* This pattern does not comply with the formal ISO 8601 specification
* as the standard does not allow a time zone without a time.
*/
public static final FastDateFormat ISO_DATE_TIME_ZONE_FORMAT
= FastDateFormat.getInstance("yyyy-MM-ddZZ");
/**
* ISO8601 formatter for time without time zone.
* ISO 8601 formatter for time without time zone.
* The format used is <tt>'T'HH:mm:ss</tt>.
*/
public static final FastDateFormat ISO_TIME_FORMAT
= FastDateFormat.getInstance("'T'HH:mm:ss");
/**
* ISO8601 formatter for time with time zone.
* ISO 8601 formatter for time with time zone.
* The format used is <tt>'T'HH:mm:ssZZ</tt>.
*/
public static final FastDateFormat ISO_TIME_TIME_ZONE_FORMAT
= FastDateFormat.getInstance("'T'HH:mm:ssZZ");
/**
* ISO8601-like formatter for time without time zone.
* ISO 8601-like formatter for time without time zone.
* The format used is <tt>HH:mm:ss</tt>.
* This pattern does not comply with the formal ISO8601 specification
* This pattern does not comply with the formal ISO 8601 specification
* as the standard requires the 'T' prefix for times.
*/
public static final FastDateFormat ISO_TIME_NO_T_FORMAT
= FastDateFormat.getInstance("HH:mm:ss");
/**
* ISO8601-like formatter for time with time zone.
* ISO 8601-like formatter for time with time zone.
* The format used is <tt>HH:mm:ssZZ</tt>.
* This pattern does not comply with the formal ISO8601 specification
* This pattern does not comply with the formal ISO 8601 specification
* as the standard requires the 'T' prefix for times.
*/
public static final FastDateFormat ISO_TIME_NO_T_TIME_ZONE_FORMAT

8
src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java
View File

@ -61,7 +61,7 @@ public class DurationFormatUtils {
/**
* <p>Pattern used with <code>FastDateFormat</code> and <code>SimpleDateFormat</code>
* for the ISO8601 period format used in durations.</p>
* for the ISO 8601 period format used in durations.</p>
*
* @see org.apache.commons.lang3.time.FastDateFormat
* @see java.text.SimpleDateFormat
@ -72,7 +72,7 @@ public class DurationFormatUtils {
/**
* <p>Formats the time gap as a string.</p>
*
* <p>The format used is ISO8601-like:
* <p>The format used is ISO 8601-like:
* <i>H</i>:<i>m</i>:<i>s</i>.<i>S</i>.</p>
*
* @param durationMillis the duration to format
@ -85,7 +85,7 @@ public class DurationFormatUtils {
/**
* <p>Formats the time gap as a string.</p>
*
* <p>The format used is the ISO8601 period format.</p>
* <p>The format used is the ISO 8601 period format.</p>
*
* <p>This method formats durations using the days and lower fields of the
* ISO format pattern, such as P7D6TH5M4.321S.</p>
@ -221,7 +221,7 @@ public class DurationFormatUtils {
/**
* <p>Formats the time gap as a string.</p>
*
* <p>The format used is the ISO8601 period format.</p>
* <p>The format used is the ISO 8601 period format.</p>
*
* @param startMillis the start of the duration to format
* @param endMillis the end of the duration to format

2
src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
View File

@ -57,7 +57,7 @@ import java.util.TimeZone;
* This pattern letter can be used here (on all JDK versions).</p>
*
* <p>In addition, the pattern {@code 'ZZ'} has been made to represent
* ISO8601 full format time zones (eg. {@code +08:00} or {@code -11:00}).
* ISO 8601 full format time zones (eg. {@code +08:00} or {@code -11:00}).
* This introduces a minor incompatibility with Java 1.4, but at a gain of
* useful functionality.</p>
*

2
src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
View File

@ -61,7 +61,7 @@ import org.apache.commons.lang3.Validate;
* This pattern letter can be used here (on all JDK versions).</p>
*
* <p>In addition, the pattern {@code 'ZZ'} has been made to represent
* ISO8601 full format time zones (eg. {@code +08:00} or {@code -11:00}).
* ISO 8601 full format time zones (eg. {@code +08:00} or {@code -11:00}).
* This introduces a minor incompatibility with Java 1.4, but at a gain of
* useful functionality.</p>
*

4
src/main/java/org/apache/commons/lang3/time/StopWatch.java
View File

@ -407,7 +407,7 @@ public class StopWatch {
* </p>
*
* <p>
* The format used is ISO8601-like, <i>hours</i>:<i>minutes</i>:<i>seconds</i>.<i>milliseconds</i>.
* The format used is ISO 8601-like, <i>hours</i>:<i>minutes</i>:<i>seconds</i>.<i>milliseconds</i>.
* </p>
*
* @return the time as a String
@ -423,7 +423,7 @@ public class StopWatch {
* </p>
*
* <p>
* The format used is ISO8601-like, <i>hours</i>:<i>minutes</i>:<i>seconds</i>.<i>milliseconds</i>.
* The format used is ISO 8601-like, <i>hours</i>:<i>minutes</i>:<i>seconds</i>.<i>milliseconds</i>.
* </p>
*
* @return the split time as a String

2
src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java
View File

@ -351,7 +351,7 @@ public class DurationFormatUtilsTest {
new DurationFormatUtils.Token(DurationFormatUtils.s, 1),
new DurationFormatUtils.Token(DurationFormatUtils.S, 1)}, DurationFormatUtils.lexx("yMdHmsS"));
// tests the ISO8601-like
// tests the ISO 8601-like
assertArrayEquals(new DurationFormatUtils.Token[]{
new DurationFormatUtils.Token(DurationFormatUtils.H, 1),
new DurationFormatUtils.Token(new StringBuilder(":"), 1),