| java.lang.Object | ||
| ↳ | org.joda.time.base.AbstractPartial | |
| ↳ | org.joda.time.base.BasePartial | |
 Known Direct Subclasses
|
Class Overview
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.
Summary
| Protected Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a partial with the current time, using ISOChronology in
the default zone to extract the fields.
| |||||||||||
Constructs a partial with the current time, using the specified chronology
and zone to extract the fields.
| |||||||||||
Constructs a partial extracting the partial fields from the specified
milliseconds using the ISOChronology in the default zone.
| |||||||||||
Constructs a partial extracting the partial fields from the specified
milliseconds using the chronology provided.
| |||||||||||
Constructs a partial from an Object that represents a time, using the
specified chronology.
| |||||||||||
Constructs a partial from an Object that represents a time, using the
specified chronology.
| |||||||||||
Constructs a partial with specified time field values and chronology.
| |||||||||||
Private constructor to be used by subclasses only which performs no validation.
| |||||||||||
Private constructor to be used by subclasses only which performs no validation.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the chronology of the partial which is never null.
| |||||||||||
Gets the value of the field at the specifed index.
| |||||||||||
Gets an array of the value of each of the fields that this partial supports.
| |||||||||||
Output the date using the specified format pattern.
| |||||||||||
Output the date using the specified format pattern.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Sets the value of the field at the specifed index.
| |||||||||||
Sets the values of all fields.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
org.joda.time.base.AbstractPartial
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.Comparable
| |||||||||||
|
From interface
org.joda.time.ReadablePartial
| |||||||||||
Protected Constructors
protected BasePartial ()
Constructs a partial with the current time, using ISOChronology in the default zone to extract the fields.
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)
Constructs a partial with the current time, using the specified chronology and zone to extract the fields.
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).
Parameters
| chronology | the chronology, null means ISOChronology in the default zone |
|---|
protected BasePartial (long instant)
Constructs a partial extracting the partial fields from the specified milliseconds using the ISOChronology in the default zone.
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).
Parameters
| instant | the milliseconds from 1970-01-01T00:00:00Z |
|---|
protected BasePartial (long instant, Chronology chronology)
Constructs a partial extracting the partial fields from the specified milliseconds using the chronology provided.
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).
Parameters
| instant | the milliseconds from 1970-01-01T00:00:00Z |
|---|---|
| chronology | the chronology, null means ISOChronology in the default zone |
protected BasePartial (Object instant, Chronology chronology)
Constructs a partial from an Object that represents a time, using the specified 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).
Parameters
| instant | the datetime object |
|---|---|
| chronology | the chronology, null means use converter |
Throws
| IllegalArgumentException | if the date is invalid |
|---|
protected BasePartial (Object instant, Chronology chronology, DateTimeFormatter parser)
Constructs a partial from an Object that represents a time, using the specified 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).
Parameters
| instant | the datetime object |
|---|---|
| chronology | the chronology, null means use converter |
| parser | if converting from a String, the given parser is preferred |
Throws
| IllegalArgumentException | if the date is invalid |
|---|
protected BasePartial (int[] values, Chronology chronology)
Constructs a partial with specified time field values and 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.
Parameters
| values | the new set of values |
|---|---|
| chronology | the chronology, null means ISOChronology in the default zone |
Throws
| IllegalArgumentException | if the values are invalid |
|---|
protected BasePartial (BasePartial base, int[] values)
Private constructor to be used by subclasses only which performs no validation.
Data is assigned (not cloned) to the new instance.
Parameters
| base | the base partial |
|---|---|
| values | the new set of values, not cloned, null means use base |
protected BasePartial (BasePartial base, Chronology chrono)
Private constructor to be used by subclasses only which performs no validation.
Data is assigned (not cloned) to the new instance. This should not be used by mutable subclasses.
Parameters
| base | the base partial |
|---|---|
| chrono | the chronology to use, null means use base |
Public Methods
public Chronology getChronology ()
Gets the chronology of the partial which is never null.
The Chronology is the calculation engine behind the partial and
provides conversion and validation of the fields in a particular calendar system.
Returns
- the chronology, never null
public int getValue (int index)
Gets the value of the field at the specifed index.
Parameters
| index | the index |
|---|
Returns
- the value
Throws
| IndexOutOfBoundsException | if the index is invalid |
|---|
public int[] getValues ()
Gets an array of the value of each of the fields that this partial supports.
The fields are returned largest to smallest, for example Hour, Minute, Second.
Each value corresponds to the same array index as getFields()
Returns
- the current values of each field (cloned), largest to smallest
public String toString (String pattern, Locale locale)
Output the date using the specified format pattern.
Parameters
| pattern | the pattern specification, null means use toString |
|---|---|
| locale | Locale to use, null means default |
Throws
| IllegalArgumentException |
|---|
See Also
public String toString (String pattern)
Output the date using the specified format pattern.
Parameters
| pattern | the pattern specification, null means use toString |
|---|
See Also
Protected Methods
protected void setValue (int index, int value)
Sets the value of the field at the specifed index.
Parameters
| index | the index |
|---|---|
| value | the value to set |
Throws
| IndexOutOfBoundsException | if the index is invalid |
|---|
protected void setValues (int[] values)
Sets the values of all fields.
Parameters
| values | the array of values |
|---|