net.time4j.IntegerDateElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of time4j-core Show documentation
There is a newer version: 4.38
/*
 * -----------------------------------------------------------------------
 * Copyright © 2013-2014 Meno Hochschild, 
 * -----------------------------------------------------------------------
 * This file (IntegerDateElement.java) is part of project Time4J.
 *
 * Time4J is free software: You can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * Time4J is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Time4J. If not, see .
 * -----------------------------------------------------------------------
 */

package net.time4j;

import net.time4j.base.GregorianMath;
import net.time4j.engine.ChronoElement;
import net.time4j.engine.ChronoEntity;
import net.time4j.engine.ChronoFunction;
import net.time4j.engine.ChronoOperator;
import net.time4j.engine.Chronology;
import net.time4j.engine.ElementRule;
import net.time4j.format.NumericalElement;

import java.io.InvalidObjectException;
import java.io.ObjectStreamException;
import java.math.BigDecimal;


/**
 * Allgemeines verstellbares chronologisches Element auf Integer-Basis. 
 *
 * @author      Meno Hochschild
 * @concurrency 
 */
final class IntegerDateElement
    extends AbstractDateElement
    implements ProportionalElement,
               NumericalElement {

    //~ Statische Felder/Initialisierungen --------------------------------

    /** Element-Index */
    static final int YEAR = 14;
    /** Element-Index */
    static final int MONTH = 15;
    /** Element-Index */
    static final int DAY_OF_MONTH = 16;
    /** Element-Index */
    static final int DAY_OF_YEAR = 17;
    /** Element-Index */
    static final int DAY_OF_QUARTER = 18;
    /** Element-Index */
    static final int YEAR_OF_ERA = 19;

    private static final long serialVersionUID = -1337148214680014674L;

    //~ Instanzvariablen --------------------------------------------------

    private transient final int index;
    private transient final Integer defaultMin;
    private transient final Integer defaultMax;
    private transient final char symbol;
    private transient final ChronoFunction, BigDecimal> rf;

    //~ Konstruktoren -----------------------------------------------------

    private IntegerDateElement(
        String name,
        int index,
        Integer defaultMin,
        Integer defaultMax,
        char symbol
    ) {
        super(name);

        this.index = index;
        this.defaultMin = defaultMin;
        this.defaultMax = defaultMax;
        this.symbol = symbol;

        this.rf = new ProportionalFunction(this, false);

    }

    //~ Methoden ----------------------------------------------------------

    @Override
    public Class getType() {

        return Integer.class;

    }

    @Override
    public char getSymbol() {

        return this.symbol;

    }

    @Override
    public Integer getDefaultMinimum() {

        return this.defaultMin;

    }

    @Override
    public Integer getDefaultMaximum() {

        return this.defaultMax;

    }

    @Override
    public boolean isDateElement() {

        return true;

    }

    @Override
    public boolean isTimeElement() {

        return false;

    }

    @Override
    public int numerical(Integer value) {

        return value.intValue();

    }

    @Override
    public ChronoFunction, BigDecimal> ratio() {

        return this.rf;

    }

    @Override
    public ChronoOperator roundedUp(int stepwidth) {

        return new RoundingOperator(
            this,
            Boolean.TRUE,
            stepwidth
        );

    }

    @Override
    public ChronoOperator roundedHalf(int stepwidth) {

        return new RoundingOperator(
            this,
            null,
            stepwidth
        );

    }

    @Override
    public ChronoOperator roundedDown(int stepwidth) {

        return new RoundingOperator(
            this,
            Boolean.FALSE,
            stepwidth
        );

    }

    @Override
    protected > ElementRule derive(
        Chronology chronology
    ) {

        if (
            (this.index == YEAR_OF_ERA)
            && chronology.isRegistered(PlainDate.CALENDAR_DATE)
        ) {
            return new ElementRule() {
                @Override
                public Integer getValue(T context) {
                    int year = context.get(PlainDate.CALENDAR_DATE).getYear();
                    return Integer.valueOf((year <= 0) ? (1 - year) : year);
                }
                @Override
                public Integer getMinimum(T context) {
                    return Integer.valueOf(1);
                }
                @Override
                public Integer getMaximum(T context) {
                    return Integer.valueOf(GregorianMath.MAX_YEAR);
                }
                @Override
                public boolean isValid(T context, Integer value) {
                    return (
                        (value != null)
                        && (value.compareTo(this.getMaximum(context)) <= 0)
                        && (value.compareTo(this.getMinimum(context)) >= 0)
                    );
                }
                @Override
                public T withValue(T context, Integer value, boolean lenient) {
                    if (value == null) {
                        throw new NullPointerException("Missing year of era.");
                    } else if (!this.isValid(context, value)) {
                        throw new IllegalArgumentException(
                            "Invalid year of era: " + value);
                    } else {
                        PlainDate date = context.get(PlainDate.CALENDAR_DATE);
                        if (date.getYear() <= 0) {
                            int year = 1 - value.intValue();
                            date = date.with(PlainDate.YEAR, year);
                        } else {
                            date = date.with(PlainDate.YEAR, value);
                        }
                        return context.with(PlainDate.CALENDAR_DATE, date);
                    }
                }
                @Override
                public ChronoElement getChildAtFloor(T context) {
                    return PlainDate.MONTH_AS_NUMBER;
                }
                @Override
                public ChronoElement getChildAtCeiling(T context) {
                    return PlainDate.MONTH_AS_NUMBER;
                }
            };
        }

        return null;

    }

    /**
     * Liefert einen Zugriffsindex zur Optimierung der Elementsuche. 
     *
     * @return  int
     */
    int getIndex() {

        return this.index;

    }

    /**
     * Erzeugt ein neues Datumselement. 
     *
     * @param   name        name of element
     * @param   index       index of element
     * @param   dmin        default minimum
     * @param   dmax        default maximum
     * @param   symbol      format symbol
     * @return  new element instance
     */
    static IntegerDateElement create(
        String name,
        int index,
        int dmin,
        int dmax,
        char symbol
    ) {

        return new IntegerDateElement(
            name,
            index,
            Integer.valueOf(dmin),
            Integer.valueOf(dmax),
            symbol
        );

    }

    private Object readResolve() throws ObjectStreamException {

        Object element = PlainDate.lookupElement(this.name());

        if (element == null) {
            throw new InvalidObjectException(this.name());
        } else {
            return element;
        }

    }

}