org.joda.time.base
Class BaseSingleFieldPeriod
java.lang.Object
org.joda.time.base.BaseSingleFieldPeriod
- Comparable, ReadablePeriod, Serializable
public abstract class BaseSingleFieldPeriod
extends java.lang.Object
BaseSingleFieldPeriod is an abstract implementation of ReadablePeriod that
manages a single duration field, such as days or minutes.
This class should generally not be used directly by API users.
The
ReadablePeriod
interface should be used when different
kinds of period objects are to be referenced.
BaseSingleFieldPeriod subclasses may be mutable and not thread-safe.
BaseSingleFieldPeriod
protected BaseSingleFieldPeriod(int period)
Creates a new instance representing the specified period.
period
- the period to represent
between
protected static int between(ReadableInstant start,
ReadableInstant end,
DurationFieldType field)
Calculates the number of whole units between the two specified datetimes.
start
- the start instant, validated to not be nullend
- the end instant, validated to not be nullfield
- the field type to use, must not be null
between
protected static int between(ReadablePartial start,
ReadablePartial end,
ReadablePeriod zeroInstance)
Calculates the number of whole units between the two specified partial datetimes.
The two partials must contain the same fields, for example you can specify
two
LocalDate
objects.
start
- the start partial date, validated to not be nullend
- the end partial date, validated to not be nullzeroInstance
- the zero instance constant, must not be null
compareTo
public int compareTo(Object other)
Compares this period to another object of the same class.
other
- the other period, must not be null
- zero if equal, positive if greater, negative if less
equals
public boolean equals(Object period)
Compares this object with the specified object for equality based on the
value of each field. All ReadablePeriod instances are accepted, but only
those with a matching PeriodType
can return true.
- equals in interface ReadablePeriod
period
- a readable period to check against
- true if all the field values are equal, false if
not or the period is null or of an incorrect type
get
public int get(DurationFieldType type)
Gets the value of a duration field represented by this period.
If the field type specified does not match the type used by this class
then zero is returned.
- get in interface ReadablePeriod
type
- the field type to query, null returns zero
- the value of that field, zero if field not supported
getFieldType
public abstract DurationFieldType getFieldType()
Gets the single duration field type.
- the duration field type, not null
getFieldType
public DurationFieldType getFieldType(int index)
Gets the field type at the specified index.
The only index supported by this period is zero which returns the
field type of this class.
- getFieldType in interface ReadablePeriod
index
- the index to retrieve, which must be zero
- the field at the specified index
getValue
protected int getValue()
Gets the amount of this period.
getValue
public int getValue(int index)
Gets the value at the specified index.
The only index supported by this period is zero.
- getValue in interface ReadablePeriod
index
- the index to retrieve, which must be zero
- the value of the field at the specified index
hashCode
public int hashCode()
Gets a hash code for the period as defined by ReadablePeriod.
- hashCode in interface ReadablePeriod
isSupported
public boolean isSupported(DurationFieldType type)
Checks whether the duration field specified is supported by this period.
- isSupported in interface ReadablePeriod
type
- the type to check, may be null which returns false
- true if the field is supported
setValue
protected void setValue(int value)
Sets the amount of this period.
To make a subclass immutable you must declare it final, or block this method.
size
public int size()
Gets the number of fields that this period supports, which is one.
- size in interface ReadablePeriod
- the number of fields supported, which is one
standardPeriodIn
protected static int standardPeriodIn(ReadablePeriod period,
long millisPerUnit)
Creates a new instance representing the number of complete standard length units
in the specified period.
This factory method converts all fields from the period to hours using standardised
durations for each field. Only those fields which have a precise duration in
the ISO UTC chronology can be converted.
- One week consists of 7 days.
- One day consists of 24 hours.
- One hour consists of 60 minutes.
- One minute consists of 60 seconds.
- One second consists of 1000 milliseconds.
Months and Years are imprecise and periods containing these values cannot be converted.
period
- the period to get the number of hours from, must not be nullmillisPerUnit
- the number of milliseconds in one standard unit of this period
toMutablePeriod
public MutablePeriod toMutablePeriod()
Get this object as a
MutablePeriod
.
This will always return a new
MutablePeriod
with the same fields.
The period will use
PeriodType.standard()
.
- toMutablePeriod in interface ReadablePeriod
- a MutablePeriod using the same field set and values
toPeriod
public Period toPeriod()
Get this period as an immutable Period
object.
The period will use PeriodType.standard()
.
- toPeriod in interface ReadablePeriod
- a
Period
representing the same number of days
Copyright (c) 2001-2006 - Joda.org