| org.joda.time.ReadablePartial
All known Subclasses: org.joda.time.TimeOfDay, org.joda.time.Partial, org.joda.time.LocalTime, org.joda.time.LocalDate, org.joda.time.YearMonthDay, org.joda.time.base.AbstractPartial, org.joda.time.base.BasePartial, org.joda.time.LocalDateTime, org.joda.time.MockPartial,
| ReadablePartial | | public interface ReadablePartial (Code) | | Defines a partial time that does not support every datetime field, and is
thus a local time.
A ReadablePartial supports a subset of those fields on the chronology.
It cannot be compared to a ReadableInstant, as it does not fully
specify an instant in time. The time it does specify is a local time, and does
not include a time zone.
A ReadablePartial can be converted to a ReadableInstant
using the toDateTime method. This works by providing a full base
instant that can be used to 'fill in the gaps' and specify a time zone.
author:
Stephen Colebourne
since:
1.0 |
| Method Summary | |
| boolean | equals(Object partial)
Compares this partial with the specified object for equality based
on the supported fields, chronology and values. | | int | get(DateTimeFieldType field)
Gets the value of one of the fields. | | Chronology | getChronology()
Gets the chronology of the partial which is never null. | | DateTimeField | getField(int index)
Gets the field at the specified index. | | DateTimeFieldType | getFieldType(int index)
Gets the field type at the specified index. | | int | getValue(int index)
Gets the value at the specified index. | | int | hashCode()
Gets a hash code for the partial that is compatible with the
equals method. | | boolean | isSupported(DateTimeFieldType field)
Checks whether the field type specified is supported by this partial. | | int | size()
Gets the number of fields that this partial supports. | | DateTime | toDateTime(ReadableInstant baseInstant)
Converts this partial to a full datetime by resolving it against another
datetime.
This method takes the specified datetime and sets the fields from this
instant on top. | | String | toString()
Get the value as a String in a recognisable ISO8601 format, only
displaying supported fields. |
| equals | | boolean equals(Object partial)(Code) | | Compares this partial with the specified object for equality based
on the supported fields, chronology and values.
Two instances of ReadablePartial are equal if they have the same
chronology, same field types (in same order) and same values.
Parameters:
partial - the object to compare to true if equal |
| get | | int get(DateTimeFieldType field)(Code) | | Gets the value of one of the fields.
The field type specified must be one of those that is supported by the partial.
Parameters:
field - a DateTimeFieldType instance that is supported by this partial the value of that field
throws:
IllegalArgumentException - if the field is null or not supported |
| getChronology | | 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 |
| getField | | DateTimeField getField(int index)(Code) | | Gets the field at the specified index.
Parameters:
index - the index to retrieve the field at the specified index
throws:
IndexOutOfBoundsException - if the index is invalid |
| getValue | | int getValue(int index)(Code) | | Gets the value at the specified index.
Parameters:
index - the index to retrieve the value of the field at the specified index
throws:
IndexOutOfBoundsException - if the index is invalid |
| hashCode | | int hashCode()(Code) | | Gets a hash code for the partial that is compatible with the
equals method.
The formula used must be:
int total = 157;
for (int i = 0; i < fields.length; i++) {
total = 23 * total + values[i];
total = 23 * total + fieldTypes[i].hashCode();
}
total += chronology.hashCode();
return total;
a suitable hash code |
| isSupported | | boolean isSupported(DateTimeFieldType field)(Code) | | Checks whether the field type specified is supported by this partial.
Parameters:
field - the field to check, may be null which returns false true if the field is supported |
| size | | int size()(Code) | | Gets the number of fields that this partial supports.
the number of fields supported |
| toDateTime | | DateTime toDateTime(ReadableInstant baseInstant)(Code) | | Converts this partial to a full datetime by resolving it against another
datetime.
This method takes the specified datetime and sets the fields from this
instant on top. The chronology from the base instant is used.
For example, if this partial represents a time, then the result of this
method will be the datetime from the specified base instant plus the
time from this partial.
Parameters:
baseInstant - the instant that provides the missing fields, null means now the combined datetime |
| toString | | String toString()(Code) | | Get the value as a String in a recognisable ISO8601 format, only
displaying supported fields.
The string output is in ISO8601 format to enable the String
constructor to correctly parse it.
the value as an ISO8601 string |
|
|