com.phloc.datetime.config.PDTConfig Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.phloc.datetime.config;

import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.ThreadSafe;

import org.joda.time.Chronology;
import org.joda.time.DateTimeZone;
import org.joda.time.chrono.GJChronology;
import org.joda.time.chrono.ISOChronology;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.phloc.commons.annotations.PresentForCodeCoverage;
import com.phloc.commons.state.ESuccess;

/**
 * This class provides the most basic settings for date time operating: the
 * date-time-zone and the chronology to use.
 *
 * @author Philip Helger
 */
@ThreadSafe
public final class PDTConfig
{
  /**
   * The default-default date time zone.
   */
  public static final String DEFAULT_DATETIMEZONEID = "Europe/Vienna";

  private static final Logger s_aLogger = LoggerFactory.getLogger (PDTConfig.class);
  private static final ReadWriteLock s_aRWLock = new ReentrantReadWriteLock ();
  private static DateTimeZone s_aDateTimeZone = DateTimeZone.forID (DEFAULT_DATETIMEZONEID);
  private static volatile boolean s_bUseISOChronology = false;

  @PresentForCodeCoverage
  @SuppressWarnings ("unused")
  private static final PDTConfig s_aInstance = new PDTConfig ();

  private PDTConfig ()
  {}

  /**
   * Set the default date time zone to use.
   *
   * @param sDateTimeZoneID
   *        Must be a valid, non-null time zone.
   * @return {@link ESuccess}
   */
  @Nonnull
  public static ESuccess setDefaultDateTimeZoneID (final String sDateTimeZoneID)
  {
    s_aRWLock.writeLock ().lock ();
    try
    {
      // Try to resolve ID -> throws IAE if unknown
      s_aDateTimeZone = DateTimeZone.forID (sDateTimeZoneID);
      return ESuccess.SUCCESS;
    }
    catch (final IllegalArgumentException ex)
    {
      // time zone ID is unknown
      s_aLogger.warn ("Unsupported dateTimeZone ID '" + sDateTimeZoneID + "'");
      return ESuccess.FAILURE;
    }
    finally
    {
      s_aRWLock.writeLock ().unlock ();
    }
  }

  /**
   * @return The default date time zone to use. Never null. The
   *         default default is {@link #DEFAULT_DATETIMEZONEID}.
   */
  @Nonnull
  public static DateTimeZone getDefaultDateTimeZone ()
  {
    s_aRWLock.readLock ().lock ();
    try
    {
      return s_aDateTimeZone;
    }
    finally
    {
      s_aRWLock.readLock ().unlock ();
    }
  }

  /**
   * @return The default UTC time zone.
   */
  @Nonnull
  public static DateTimeZone getDateTimeZoneUTC ()
  {
    return DateTimeZone.UTC;
  }

  public static boolean isUseISOChronology ()
  {
    return s_bUseISOChronology;
  }

  public static void setUseISOChronology (final boolean bUse)
  {
    s_bUseISOChronology = bUse;
  }

  /**
   * @return The default GJ chronology using the result of
   *         {@link #getDefaultDateTimeZone()}
   */
  @Nonnull
  public static Chronology getDefaultChronology ()
  {
    if (s_bUseISOChronology)
      return ISOChronology.getInstance (getDefaultDateTimeZone ());
    return GJChronology.getInstance (getDefaultDateTimeZone ());
  }

  /**
   * @return The default chronology with the system date time zone
   */
  @Nonnull
  public static Chronology getDefaultChronologyWithoutDateTimeZone ()
  {
    if (s_bUseISOChronology)
      return ISOChronology.getInstance ();
    return GJChronology.getInstance ();
  }

  /**
   * @return The default chronology with UTC date time zone
   */
  @Nonnull
  public static Chronology getDefaultChronologyUTC ()
  {
    if (s_bUseISOChronology)
      return ISOChronology.getInstanceUTC ();
    return GJChronology.getInstanceUTC ();
  }
}