aboutsummaryrefslogtreecommitdiff
path: root/src/main
diff options
context:
space:
mode:
authorAndrew Thomas <mastermonopoly@gmail.com>2022-08-27 11:41:05 -0700
committerGitHub <noreply@github.com>2022-08-27 14:41:05 -0400
commit44c5d39becfcfdcc8b2bd0cab4aa705a36f59da3 (patch)
tree8a94530a47f4fe4199eb9138ad89a91f06cbe96f /src/main
parent9a372f674951deee557cea93f6517674c0c5e315 (diff)
downloadapache-commons-lang-44c5d39becfcfdcc8b2bd0cab4aa705a36f59da3.tar.gz
LANG-1638: Added docs regarding week year support (#924)
* LANG-1638: Added docs regarding week year support * Moved comment from method to class level * Added link to explanation of week vs calendar year
Diffstat (limited to 'src/main')
-rw-r--r--src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java4
1 files changed, 4 insertions, 0 deletions
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 1410e0c3a..1688c31e4 100644
--- a/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java
+++ b/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java
@@ -30,6 +30,10 @@ import java.util.TimeZone;
* <p>Note that the JDK has a bug wherein calling Calendar.get(int) will
* override any previously called Calendar.clear() calls. See LANG-755.</p>
*
+ * <p>Note that when using capital YYYY instead of lowercase yyyy, the formatter
+ * will assume current year as week year is not supported. See {@link java.util.GregorianCalendar}
+ * Week Year section for an explanation on the difference between calendar and week years.</p>
+ *
* @since 2.0
*/
public class DateFormatUtils {