1 /*
   2  * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 /*
  27  * This file is available under and governed by the GNU General Public
  28  * License version 2 only, as published by the Free Software Foundation.
  29  * However, the following notice accompanied the original version of this
  30  * file:
  31  *
  32  * Copyright (c) 2009-2012, Stephen Colebourne & Michael Nascimento Santos
  33  *
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions are met:
  38  *
  39  *  * Redistributions of source code must retain the above copyright notice,
  40  *    this list of conditions and the following disclaimer.
  41  *
  42  *  * Redistributions in binary form must reproduce the above copyright notice,
  43  *    this list of conditions and the following disclaimer in the documentation
  44  *    and/or other materials provided with the distribution.
  45  *
  46  *  * Neither the name of JSR-310 nor the names of its contributors
  47  *    may be used to endorse or promote products derived from this software
  48  *    without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  54  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  55  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  56  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  57  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  58  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  59  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  60  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  */
  62 package build.tools.tzdb;
  63 
  64 import java.util.Objects;
  65 
  66 /**
  67  * A definition of the way a local time can be converted to the actual
  68  * transition date-time.
  69  * <p>
  70  * Time zone rules are expressed in one of three ways:
  71  * <p><ul>
  72  * <li>Relative to UTC</li>
  73  * <li>Relative to the standard offset in force</li>
  74  * <li>Relative to the wall offset (what you would see on a clock on the wall)</li>
  75  * </ul><p>
  76  */
  77 public enum TimeDefinition {
  78     /** The local date-time is expressed in terms of the UTC offset. */
  79     UTC,
  80     /** The local date-time is expressed in terms of the wall offset. */
  81     WALL,
  82     /** The local date-time is expressed in terms of the standard offset. */
  83     STANDARD;
  84 
  85     /**
  86      * Converts the specified local date-time to the local date-time actually
  87      * seen on a wall clock.
  88      * <p>
  89      * This method converts using the type of this enum.
  90      * The output is defined relative to the 'before' offset of the transition.
  91      * <p>
  92      * The UTC type uses the UTC offset.
  93      * The STANDARD type uses the standard offset.
  94      * The WALL type returns the input date-time.
  95      * The result is intended for use with the wall-offset.
  96      *
  97      * @param dateTime  the local date-time, not null
  98      * @param standardOffset  the standard offset, not null
  99      * @param wallOffset  the wall offset, not null
 100      * @return the date-time relative to the wall/before offset, not null
 101      */
 102     public LocalDateTime createDateTime(LocalDateTime dateTime, ZoneOffset standardOffset, ZoneOffset wallOffset) {
 103         switch (this) {
 104             case UTC: {
 105                 int difference = wallOffset.getTotalSeconds() - ZoneOffset.UTC.getTotalSeconds();
 106                 return dateTime.plusSeconds(difference);
 107             }
 108             case STANDARD: {
 109                 int difference = wallOffset.getTotalSeconds() - standardOffset.getTotalSeconds();
 110                 return dateTime.plusSeconds(difference);
 111             }
 112             default:  // WALL
 113                 return dateTime;
 114         }
 115     }
 116 
 117 }