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

org.joda.time.base.AbstractPeriod Maven / Gradle / Ivy

/*
 *  Copyright 2001-2010 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.base;

import org.joda.convert.ToString;
import org.joda.time.DurationFieldType;
import org.joda.time.MutablePeriod;
import org.joda.time.Period;
import org.joda.time.ReadablePeriod;
import org.joda.time.format.ISOPeriodFormat;
import org.joda.time.format.PeriodFormatter;

/**
 * AbstractPeriod provides the common behaviour for period classes.
 * 

* This class should generally not be used directly by API users. The * {@link ReadablePeriod} interface should be used when different * kinds of periods are to be referenced. *

* AbstractPeriod subclasses may be mutable and not thread-safe. * * @author Brian S O'Neill * @author Stephen Colebourne * @since 1.0 */ public abstract class AbstractPeriod implements ReadablePeriod { /** * Constructor. */ protected AbstractPeriod() { super(); } //----------------------------------------------------------------------- /** * Gets the number of fields that this period supports. * * @return the number of fields supported * @since 2.0 (previously on BasePeriod) */ public int size() { return getPeriodType().size(); } /** * Gets the field type at the specified index. * * @param index the index to retrieve * @return the field at the specified index * @throws IndexOutOfBoundsException if the index is invalid * @since 2.0 (previously on BasePeriod) */ public DurationFieldType getFieldType(int index) { return getPeriodType().getFieldType(index); } /** * Gets an array of the field types that this period supports. *

* The fields are returned largest to smallest, for example Hours, Minutes, Seconds. * * @return the fields supported in an array that may be altered, largest to smallest */ public DurationFieldType[] getFieldTypes() { DurationFieldType[] result = new DurationFieldType[size()]; for (int i = 0; i < result.length; i++) { result[i] = getFieldType(i); } return result; } /** * Gets an array of the value of each of the fields that this period supports. *

* The fields are returned largest to smallest, for example Hours, Minutes, Seconds. * Each value corresponds to the same array index as getFields() * * @return the current values of each field in an array that may be altered, largest to smallest */ public int[] getValues() { int[] result = new int[size()]; for (int i = 0; i < result.length; i++) { result[i] = getValue(i); } return result; } //----------------------------------------------------------------------- /** * Gets the value of one of the fields. *

* If the field type specified is not supported by the period then zero * is returned. * * @param type the field type to query, null returns zero * @return the value of that field, zero if field not supported */ public int get(DurationFieldType type) { int index = indexOf(type); if (index == -1) { return 0; } return getValue(index); } /** * Checks whether the field specified is supported by this period. * * @param type the type to check, may be null which returns false * @return true if the field is supported */ public boolean isSupported(DurationFieldType type) { return getPeriodType().isSupported(type); } /** * Gets the index of the field in this period. * * @param type the type to check, may be null which returns -1 * @return the index of -1 if not supported */ public int indexOf(DurationFieldType type) { return getPeriodType().indexOf(type); } //----------------------------------------------------------------------- /** * Get this period as an immutable Period object. * * @return a Period using the same field set and values */ public Period toPeriod() { return new Period(this); } /** * Get this object as a MutablePeriod. *

* This will always return a new MutablePeriod with the same fields. * * @return a MutablePeriod using the same field set and values */ public MutablePeriod toMutablePeriod() { return new MutablePeriod(this); } //----------------------------------------------------------------------- /** * Compares this object with the specified object for equality based * on the value of each field. All ReadablePeriod instances are accepted. *

* Note that a period of 1 day is not equal to a period of 24 hours, * nor is 1 hour equal to 60 minutes. Only periods with the same amount * in each field are equal. *

* This is because periods represent an abstracted definition of a time * period (eg. a day may not actually be 24 hours, it might be 23 or 25 * at daylight savings boundary). *

* To compare the actual duration of two periods, convert both to * {@link org.joda.time.Duration Duration}s, an operation that emphasises * that the result may differ according to the date you choose. * * @param period a readable period to check against * @return true if all the field values are equal, false if * not or the period is null or of an incorrect type */ public boolean equals(Object period) { if (this == period) { return true; } if (period instanceof ReadablePeriod == false) { return false; } ReadablePeriod other = (ReadablePeriod) period; if (size() != other.size()) { return false; } for (int i = 0, isize = size(); i < isize; i++) { if (getValue(i) != other.getValue(i) || getFieldType(i) != other.getFieldType(i)) { return false; } } return true; } /** * Gets a hash code for the period as defined by ReadablePeriod. * * @return a hash code */ public int hashCode() { int total = 17; for (int i = 0, isize = size(); i < isize; i++) { total = 27 * total + getValue(i); total = 27 * total + getFieldType(i).hashCode(); } return total; } //----------------------------------------------------------------------- /** * Gets the value as a String in the ISO8601 duration format. *

* For example, "PT6H3M7S" represents 6 hours, 3 minutes, 7 seconds. *

* For more control over the output, see * {@link org.joda.time.format.PeriodFormatterBuilder PeriodFormatterBuilder}. * * @return the value as an ISO8601 string */ @ToString public String toString() { return ISOPeriodFormat.standard().print(this); } //----------------------------------------------------------------------- /** * Uses the specified formatter to convert this period to a String. * * @param formatter the formatter to use, null means use toString(). * @return the formatted string * @since 1.5 */ public String toString(PeriodFormatter formatter) { if (formatter == null) { return toString(); } return formatter.print(this); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy