All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.joda.time.convert.AbstractConverter Maven / Gradle / Ivy

There is a newer version: 2.12.15
Show newest version
/*
 *  Copyright 2001-2006 Stephen Colebourne
 *
 *  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 org.joda.time.convert;

import org.joda.time.Chronology;
import org.joda.time.DateTimeUtils;
import org.joda.time.DateTimeZone;
import org.joda.time.PeriodType;
import org.joda.time.ReadablePartial;
import org.joda.time.chrono.ISOChronology;
import org.joda.time.format.DateTimeFormatter;

/**
 * AbstractConverter simplifies the process of implementing a converter.
 *
 * @author Stephen Colebourne
 * @since 1.0
 */
public abstract class AbstractConverter implements Converter {

    /**
     * Restricted constructor.
     */
    protected AbstractConverter() {
        super();
    }

    //-----------------------------------------------------------------------
    /**
     * Extracts the millis from an object of this converter's type.
     * 

* This implementation returns the current time. * * @param object the object to convert * @param chrono the chronology to use, which is always non-null * @return the millisecond value */ public long getInstantMillis(Object object, Chronology chrono) { return DateTimeUtils.currentTimeMillis(); } //----------------------------------------------------------------------- /** * Extracts the chronology from an object of this converter's type * where the time zone is specified. *

* This implementation returns the ISO chronology. * * @param object the object to convert * @param zone the specified zone to use, null means default zone * @return the chronology, never null */ public Chronology getChronology(Object object, DateTimeZone zone) { return ISOChronology.getInstance(zone); } /** * Extracts the chronology from an object of this converter's type * where the chronology is specified. *

* This implementation returns the chronology specified, or the * ISO chronology in the default zone if null passed in. * * @param object the object to convert * @param chrono the chronology to use, null means ISO default * @return the chronology, never null */ public Chronology getChronology(Object object, Chronology chrono) { return DateTimeUtils.getChronology(chrono); } //----------------------------------------------------------------------- /** * Extracts the values of the partial from an object of this converter's type. * The chrono parameter is a hint to the converter, should it require a * chronology to aid in conversion. *

* This implementation calls {@link #getInstantMillis(Object, Chronology)}. * * @param fieldSource a partial that provides access to the fields. * This partial may be incomplete and only getFieldType(int) should be used * @param object the object to convert * @param chrono the chronology to use, which is the non-null result of getChronology() * @return the array of field values that match the fieldSource, must be non-null valid * @throws ClassCastException if the object is invalid */ public int[] getPartialValues(ReadablePartial fieldSource, Object object, Chronology chrono) { long instant = getInstantMillis(object, chrono); return chrono.get(fieldSource, instant); } /** * Extracts the values of the partial from an object of this converter's type. * The chrono parameter is a hint to the converter, should it require a * chronology to aid in conversion. *

* This implementation calls {@link #getPartialValues(ReadablePartial, Object, Chronology)}. * * @param fieldSource a partial that provides access to the fields. * This partial may be incomplete and only getFieldType(int) should be used * @param object the object to convert * @param chrono the chronology to use, which is the non-null result of getChronology() * @param parser if converting from a String, the given parser is preferred * @return the array of field values that match the fieldSource, must be non-null valid * @throws ClassCastException if the object is invalid * @since 1.3 */ public int[] getPartialValues(ReadablePartial fieldSource, Object object, Chronology chrono, DateTimeFormatter parser) { return getPartialValues(fieldSource, object, chrono); } //----------------------------------------------------------------------- /** * Selects a suitable period type for the given object. * * @param object the object to examine * @return the period type, never null */ public PeriodType getPeriodType(Object object) { return PeriodType.standard(); } //----------------------------------------------------------------------- /** * Checks if the input is a ReadableInterval. *

* If it is, then the calling code should cast and copy the fields directly. * * @param object the object to convert * @param chrono the chronology to use, may be null * @return true if the input is a ReadableInterval */ public boolean isReadableInterval(Object object, Chronology chrono) { return false; } //----------------------------------------------------------------------- /** * Gets a debugging string version of this converter. * * @return a debugging string */ public String toString() { return "Converter[" + (getSupportedType() == null ? "null" : getSupportedType().getName()) + "]"; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy