Document mutability of UTC constant, which isn't ideal

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1077934 13f79535-47bb-0310-9956-ffa450edef68
2011-03-04 13:30:35 +00:00 · 2011-03-04 13:30:35 +00:00 · 5bc14f89d1
parent f446d290d6
commit 5bc14f89d1
1 changed files with 2 additions and 0 deletions
--- a/src/main/java/org/apache/commons/lang3/time/DateUtils.java
+++ b/src/main/java/org/apache/commons/lang3/time/DateUtils.java
@ -54,6 +54,8 @@ public class DateUtils {

    /**
     * The UTC time zone (often referred to as GMT).
+     * Since a {@code TimeZone} is mutable and this is a "constant", it is
+     * essential that this object is not altered.
     */
    public static final TimeZone UTC_TIME_ZONE = TimeZone.getTimeZone("GMT");
    /**