From b4b51a8fc9eed7274a045b2f3192d77782b0e4fa Mon Sep 17 00:00:00 2001
From: "Gary D. Gregory"
Date: Wed, 30 Apr 2014 21:49:35 +0000
Subject: [PATCH] ISO 8601 misspelled throughout the Javadocs
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1591488 13f79535-47bb-0310-9956-ffa450edef68
---
src/changes/changes.xml | 1 +
.../commons/lang3/time/DateFormatUtils.java | 22 +++++++++----------
.../lang3/time/DurationFormatUtils.java | 8 +++----
.../commons/lang3/time/FastDateFormat.java | 2 +-
.../commons/lang3/time/FastDatePrinter.java | 2 +-
.../apache/commons/lang3/time/StopWatch.java | 4 ++--
.../lang3/time/DurationFormatUtilsTest.java | 2 +-
7 files changed, 21 insertions(+), 20 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index f2594a0de..4e7b48b04 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -22,6 +22,7 @@
+ ISO 8601 misspelled throughout the Javadocs
Add zero copy read method to StrBuilder
Add zero copy write method to StrBuilder
Javadoc is not clear on preferred pattern to instantiate FastDateParser / FastDatePrinter
diff --git a/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java b/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java
index be671a928..47aaf4551 100644
--- a/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java
+++ b/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java
@@ -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 yyyy-MM-dd'T'HH:mm:ss.
*/
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 yyyy-MM-dd'T'HH:mm:ssZZ.
*/
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 yyyy-MM-dd.
*/
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 yyyy-MM-ddZZ.
- * 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 'T'HH:mm:ss.
*/
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 'T'HH:mm:ssZZ.
*/
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 HH:mm:ss.
- * 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 HH:mm:ssZZ.
- * 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
diff --git a/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java b/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java
index 80fe90727..4fe626f19 100644
--- a/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java
+++ b/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java
@@ -61,7 +61,7 @@ public DurationFormatUtils() {
/**
* Pattern used with FastDateFormat
and SimpleDateFormat
- * for the ISO8601 period format used in durations.
+ * for the ISO 8601 period format used in durations.
*
* @see org.apache.commons.lang3.time.FastDateFormat
* @see java.text.SimpleDateFormat
@@ -72,7 +72,7 @@ public DurationFormatUtils() {
/**
* Formats the time gap as a string.
*
- * The format used is ISO8601-like:
+ *
The format used is ISO 8601-like:
* H:m:s.S.
*
* @param durationMillis the duration to format
@@ -85,7 +85,7 @@ public static String formatDurationHMS(final long durationMillis) {
/**
* Formats the time gap as a string.
*
- * The format used is the ISO8601 period format.
+ * The format used is the ISO 8601 period format.
*
* This method formats durations using the days and lower fields of the
* ISO format pattern, such as P7D6TH5M4.321S.
@@ -221,7 +221,7 @@ public static String formatDurationWords(
/**
* Formats the time gap as a string.
*
- * The format used is the ISO8601 period format.
+ * The format used is the ISO 8601 period format.
*
* @param startMillis the start of the duration to format
* @param endMillis the end of the duration to format
diff --git a/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java b/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
index bc88b20e1..7f1722059 100644
--- a/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
+++ b/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
@@ -57,7 +57,7 @@
* This pattern letter can be used here (on all JDK versions).
*
* 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.
*
diff --git a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
index cea70c465..2f2bafd9e 100644
--- a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
+++ b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
@@ -61,7 +61,7 @@
* This pattern letter can be used here (on all JDK versions).
*
* 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.
*
diff --git a/src/main/java/org/apache/commons/lang3/time/StopWatch.java b/src/main/java/org/apache/commons/lang3/time/StopWatch.java
index 5d90ccf04..953479344 100644
--- a/src/main/java/org/apache/commons/lang3/time/StopWatch.java
+++ b/src/main/java/org/apache/commons/lang3/time/StopWatch.java
@@ -407,7 +407,7 @@ public long getStartTime() {
*
*
*
- * The format used is ISO8601-like, hours:minutes:seconds.milliseconds.
+ * The format used is ISO 8601-like, hours:minutes:seconds.milliseconds.
*
*
* @return the time as a String
@@ -423,7 +423,7 @@ public String toString() {
*
*
*
- * The format used is ISO8601-like, hours:minutes:seconds.milliseconds.
+ * The format used is ISO 8601-like, hours:minutes:seconds.milliseconds.
*
*
* @return the split time as a String
diff --git a/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java b/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java
index 443c9dc28..95537108b 100644
--- a/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java
+++ b/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java
@@ -351,7 +351,7 @@ public void testLexx() {
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),