com.barchart.feed.ddf.symbol.enums.DDF_TimeZone.java Source code

Introduction

Here is the source code for com.barchart.feed.ddf.symbol.enums.DDF_TimeZone.java

Source

/**
 * Copyright (C) 2011-2012 Barchart, Inc. <http://www.barchart.com/>
 *
 * All rights reserved. Licensed under the OSI BSD License.
 *
 * http://www.opensource.org/licenses/bsd-license.php
 */
package com.barchart.feed.ddf.symbol.enums;

import org.joda.time.DateTimeZone;

import com.barchart.feed.base.enums.EnumCodeString;
import com.barchart.feed.base.values.api.Value;
import com.barchart.util.common.math.MathExtra;

// TODO: Auto-generated Javadoc
/**
 * ddf centric time zones
 * 
 * http://en.wikipedia.org/wiki/Time_zone
 * 
 */
public enum DDF_TimeZone implements EnumCodeString, Value<DDF_TimeZone> {

    /**
     * UTC
     */
    UTC("UTC", DateTimeZone.UTC), //

    /**
     * ddf future-like symbols are encoded in Chicago time
     */
    CHICAGO("America/Chicago", DateTimeZone.forID("America/Chicago")), //

    /**
     * ddf stock-like symbols are encoded in New York time
     */
    NEW_YORK("America/New_York", DateTimeZone.forID("America/New_York")), //

    /**
     * default or local time zone
     */
    LOCAL("", DateTimeZone.getDefault()), //

    /** The ord. */
    ;

    public final byte ord;

    /** The code. */
    public final String code;

    /* (non-Javadoc)
     * @see com.barchart.util.enums.EnumCodeString#code()
     */
    @Override
    public final String code() {
        return code;
    }

    /** The zone. */
    public final DateTimeZone zone;

    public final long utcOffsetMillis;

    private DDF_TimeZone(final String code, final DateTimeZone zone) {
        this.ord = (byte) ordinal();
        this.code = code;
        // if (code == _Z_) {
        // this.zone = DateTimeZone.getDefault();
        // } else{
        // this.zone = DateTimeZone.getDefault();
        // }
        utcOffsetMillis = zone.getOffset(0);
        this.zone = zone;
    }

    private final static DDF_TimeZone[] ENUM_VALUES = values();

    public long getUTCOffset() {
        return utcOffsetMillis;
    }

    /**
     * Values unsafe.
     *
     * @return the dD f_ time zone[]
     */
    @Deprecated
    public final static DDF_TimeZone[] valuesUnsafe() {
        return ENUM_VALUES;
    }

    static {
        // validate use of byte ord
        MathExtra.castIntToByte(ENUM_VALUES.length);
    }

    /**
     * Checks if is known.
     *
     * @return true, if is known
     */
    public final boolean isKnown() {
        return this != LOCAL;
    }

    /**
     * From ord.
     *
     * @param ord the ord
     * @return the dD f_ time zone
     */
    public final static DDF_TimeZone fromOrd(final byte ord) {
        return ENUM_VALUES[ord];
    }

    /**
     * From code.
     *
     * @param code the code
     * @return the dD f_ time zone
     */
    public final static DDF_TimeZone fromCode(final String code) {
        for (final DDF_TimeZone known : ENUM_VALUES) {
            if (known.code.equalsIgnoreCase(code)) {
                return known;
            }
        }
        return LOCAL;
    }

    /* (non-Javadoc)
     * @see com.barchart.util.values.api.Value#freeze()
     */
    @Override
    public DDF_TimeZone freeze() {
        return this;
    }

    /* (non-Javadoc)
     * @see com.barchart.util.values.api.Value#isFrozen()
     */
    @Override
    public boolean isFrozen() {
        return true;
    }

    /* (non-Javadoc)
     * @see com.barchart.util.values.api.Value#isNull()
     */
    @Override
    public boolean isNull() {
        return this == LOCAL;
    }

}