|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.joda.time.base.AbstractPartial org.joda.time.base.BasePartial
public abstract class BasePartial
BasePartial is an abstract implementation of ReadablePartial that stores
data in array and Chronology
fields.
This class should generally not be used directly by API users.
The ReadablePartial
interface should be used when different
kinds of partial objects are to be referenced.
BasePartial subclasses may be mutable and not thread-safe.
Constructor Summary | |
---|---|
protected |
BasePartial()
Constructs a partial with the current time, using ISOChronology in the default zone to extract the fields. |
protected |
BasePartial(BasePartial base,
Chronology chrono)
Private constructor to be used by subclasses only which performs no validation. |
protected |
BasePartial(BasePartial base,
int[] values)
Private constructor to be used by subclasses only which performs no validation. |
protected |
BasePartial(Chronology chronology)
Constructs a partial with the current time, using the specified chronology and zone to extract the fields. |
protected |
BasePartial(int[] values,
Chronology chronology)
Constructs a partial with specified time field values and chronology. |
protected |
BasePartial(long instant)
Constructs a partial extracting the partial fields from the specified milliseconds using the ISOChronology in the default zone. |
protected |
BasePartial(long instant,
Chronology chronology)
Constructs a partial extracting the partial fields from the specified milliseconds using the chronology provided. |
protected |
BasePartial(Object instant,
Chronology chronology)
Constructs a partial from an Object that represents a time, using the specified chronology. |
protected |
BasePartial(Object instant,
Chronology chronology,
DateTimeFormatter parser)
Constructs a partial from an Object that represents a time, using the specified chronology. |
Method Summary | |
---|---|
Chronology |
getChronology()
Gets the chronology of the partial which is never null. |
int |
getValue(int index)
Gets the value of the field at the specifed index. |
int[] |
getValues()
Gets an array of the value of each of the fields that this partial supports. |
protected void |
setValue(int index,
int value)
Sets the value of the field at the specified index. |
protected void |
setValues(int[] values)
Sets the values of all fields. |
String |
toString(String pattern)
Output the date using the specified format pattern. |
String |
toString(String pattern,
Locale locale)
Output the date using the specified format pattern. |
Methods inherited from class org.joda.time.base.AbstractPartial |
---|
compareTo, equals, get, getField, getField, getFields, getFieldType, getFieldTypes, hashCode, indexOf, indexOf, indexOfSupported, indexOfSupported, isAfter, isBefore, isEqual, isSupported, toDateTime, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.joda.time.ReadablePartial |
---|
equals, get, getField, getFieldType, hashCode, isSupported, size, toDateTime, toString |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Constructor Detail |
---|
protected BasePartial()
The constructor uses the default time zone, resulting in the local time being initialised. Once the constructor is complete, all further calculations are performed without reference to a timezone (by switching to UTC).
protected BasePartial(Chronology chronology)
The constructor uses the time zone of the chronology specified. Once the constructor is complete, all further calculations are performed without reference to a timezone (by switching to UTC).
chronology
- the chronology, null means ISOChronology in the default zoneprotected BasePartial(long instant)
The constructor uses the default time zone, resulting in the local time being initialised. Once the constructor is complete, all further calculations are performed without reference to a timezone (by switching to UTC).
instant
- the milliseconds from 1970-01-01T00:00:00Zprotected BasePartial(long instant, Chronology chronology)
The constructor uses the time zone of the chronology specified. Once the constructor is complete, all further calculations are performed without reference to a timezone (by switching to UTC).
instant
- the milliseconds from 1970-01-01T00:00:00Zchronology
- the chronology, null means ISOChronology in the default zoneprotected BasePartial(Object instant, Chronology chronology)
The recognised object types are defined in
ConverterManager
and
include ReadableInstant, String, Calendar and Date.
The constructor uses the time zone of the chronology specified. Once the constructor is complete, all further calculations are performed without reference to a timezone (by switching to UTC).
instant
- the datetime objectchronology
- the chronology, null means use converter
IllegalArgumentException
- if the date is invalidprotected BasePartial(Object instant, Chronology chronology, DateTimeFormatter parser)
The recognised object types are defined in
ConverterManager
and
include ReadableInstant, String, Calendar and Date.
The constructor uses the time zone of the chronology specified. Once the constructor is complete, all further calculations are performed without reference to a timezone (by switching to UTC).
instant
- the datetime objectchronology
- the chronology, null means use converterparser
- if converting from a String, the given parser is preferred
IllegalArgumentException
- if the date is invalidprotected BasePartial(int[] values, Chronology chronology)
The constructor uses the time zone of the chronology specified. Once the constructor is complete, all further calculations are performed without reference to a timezone (by switching to UTC).
The array of values is assigned (not cloned) to the new instance.
values
- the new set of valueschronology
- the chronology, null means ISOChronology in the default zone
IllegalArgumentException
- if the values are invalidprotected BasePartial(BasePartial base, int[] values)
Data is assigned (not cloned) to the new instance.
base
- the base partialvalues
- the new set of values, not cloned, null means use baseprotected BasePartial(BasePartial base, Chronology chrono)
Data is assigned (not cloned) to the new instance. This should not be used by mutable subclasses.
base
- the base partialchrono
- the chronology to use, null means use baseMethod Detail |
---|
public int getValue(int index)
getValue
in interface ReadablePartial
index
- the index
IndexOutOfBoundsException
- if the index is invalidpublic int[] getValues()
The fields are returned largest to smallest, for example Hour, Minute, Second.
Each value corresponds to the same array index as getFields()
getValues
in class AbstractPartial
public Chronology getChronology()
The Chronology
is the calculation engine behind the partial and
provides conversion and validation of the fields in a particular calendar system.
getChronology
in interface ReadablePartial
protected void setValue(int index, int value)
In version 2.0 and later, this method copies the array into the original. This is because the instance variable has been changed to be final to satisfy the Java Memory Model. This only impacts subclasses that are mutable.
index
- the indexvalue
- the value to set
IndexOutOfBoundsException
- if the index is invalidprotected void setValues(int[] values)
In version 2.0 and later, this method copies the array into the original. This is because the instance variable has been changed to be final to satisfy the Java Memory Model. This only impacts subclasses that are mutable.
values
- the array of valuespublic String toString(String pattern)
pattern
- the pattern specification, null means use toString
DateTimeFormat
public String toString(String pattern, Locale locale) throws IllegalArgumentException
pattern
- the pattern specification, null means use toString
locale
- Locale to use, null means default
IllegalArgumentException
DateTimeFormat
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |