| java.lang.Object
 org.joda.time.base.AbstractPartial
org.joda.time.base.BasePartial
All known Subclasses: org.joda.time.TimeOfDay, org.joda.time.YearMonthDay,
| BasePartial | | abstract public class BasePartial extends AbstractPartial implements ReadablePartial,Serializable(Code) | | 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
org.joda.time.ReadablePartial interface should be used when different
kinds of partial objects are to be referenced.
BasePartial subclasses may be mutable and not thread-safe.
author:
Stephen Colebourne
since:
1.0 |
| Constructor Summary | |
| 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. | | protected | BasePartial(Chronology chronology)
Constructs a partial with the current time, using the specified chronology
and zone to extract the fields. | | 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. | | 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. | | protected | BasePartial(int[] values, Chronology chronology)
Constructs a partial with specified time field values and chronology. | | protected | BasePartial(BasePartial base, int[] values)
Private constructor to be used by subclasses only which performs no validation. | | protected | BasePartial(BasePartial base, Chronology chrono)
Private constructor to be used by subclasses only which performs no validation. |
| Method Summary | |
| public Chronology | getChronology()
Gets the chronology of the partial which is never null. | | public int | getValue(int index)
Gets the value of the field at the specifed index. | | public 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 specifed index. | | protected void | setValues(int[] values)
Sets the values of all fields. | | public String | toString(String pattern)
Output the date using the specified format pattern. | | public String | toString(String pattern, Locale locale)
Output the date using the specified format pattern. |
| BasePartial | | protected BasePartial()(Code) | | 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).
|
| BasePartial | | protected BasePartial(Chronology chronology)(Code) | | 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 |
| BasePartial | | protected BasePartial(long instant)(Code) | | 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 |
| BasePartial | | protected BasePartial(long instant, Chronology chronology)(Code) | | 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
Parameters:
chronology - the chronology, null means ISOChronology in the default zone |
| BasePartial | | protected BasePartial(Object instant, Chronology chronology)(Code) | | Constructs a partial from an Object that represents a time, using the
specified chronology.
The recognised object types are defined in
org.joda.time.convert.ConverterManager 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
Parameters:
chronology - the chronology, null means use converter
throws:
IllegalArgumentException - if the date is invalid |
| BasePartial | | protected BasePartial(Object instant, Chronology chronology, DateTimeFormatter parser)(Code) | | Constructs a partial from an Object that represents a time, using the
specified chronology.
The recognised object types are defined in
org.joda.time.convert.ConverterManager 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
Parameters:
chronology - the chronology, null means use converter
Parameters:
parser - if converting from a String, the given parser is preferred
throws:
IllegalArgumentException - if the date is invalid
since:
1.3 |
| BasePartial | | protected BasePartial(int[] values, Chronology chronology)(Code) | | 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
Parameters:
chronology - the chronology, null means ISOChronology in the default zone
throws:
IllegalArgumentException - if the values are invalid |
| BasePartial | | protected BasePartial(BasePartial base, int[] values)(Code) | | 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
Parameters:
values - the new set of values, not cloned, null means use base |
| BasePartial | | protected BasePartial(BasePartial base, Chronology chrono)(Code) | | 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
Parameters:
chrono - the chronology to use, null means use base |
| getChronology | | public Chronology getChronology()(Code) | | 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.
the chronology, never null |
| getValue | | public int getValue(int index)(Code) | | Gets the value of the field at the specifed index.
Parameters:
index - the index the value
throws:
IndexOutOfBoundsException - if the index is invalid |
| getValues | | public int[] getValues()(Code) | | 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()
the current values of each field (cloned), largest to smallest |
| setValue | | protected void setValue(int index, int value)(Code) | | Sets the value of the field at the specifed index.
Parameters:
index - the index
Parameters:
value - the value to set
throws:
IndexOutOfBoundsException - if the index is invalid |
| setValues | | protected void setValues(int[] values)(Code) | | Sets the values of all fields.
Parameters:
values - the array of values |
|
|