Summary: Methods | [Expand All]
public interface

ReadablePartial

org.joda.time.ReadablePartial
Known Indirect Subclasses

Class Overview

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.

Summary

Public Methods
abstract boolean equals(Object partial)
Compares this partial with the specified object for equality based on the supported fields, chronology and values.
abstract int get(DateTimeFieldType field)
Gets the value of one of the fields.
abstract Chronology getChronology()
Gets the chronology of the partial which is never null.
abstract DateTimeField getField(int index)
Gets the field at the specified index.
abstract DateTimeFieldType getFieldType(int index)
Gets the field type at the specified index.
abstract int getValue(int index)
Gets the value at the specified index.
abstract int hashCode()
Gets a hash code for the partial that is compatible with the equals method.
abstract boolean isSupported(DateTimeFieldType field)
Checks whether the field type specified is supported by this partial.
abstract int size()
Gets the number of fields that this partial supports.
abstract DateTime toDateTime(ReadableInstant baseInstant)
Converts this partial to a full datetime by resolving it against another datetime.
abstract String toString()
Get the value as a String in a recognisable ISO8601 format, only displaying supported fields.

Public Methods

public abstract boolean equals (Object partial)

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
Returns
  • true if equal

public abstract int get (DateTimeFieldType field)

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
Returns
  • the value of that field
Throws
IllegalArgumentException if the field is null or not supported

public abstract 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 abstract DateTimeField getField (int index)

Gets the field at the specified index.

Parameters
index the index to retrieve
Returns
  • the field at the specified index
Throws
IndexOutOfBoundsException if the index is invalid

public abstract DateTimeFieldType getFieldType (int index)

Gets the field type at the specified index.

Parameters
index the index to retrieve
Returns
  • the field at the specified index
Throws
IndexOutOfBoundsException if the index is invalid

public abstract int getValue (int index)

Gets the value at the specified index.

Parameters
index the index to retrieve
Returns
  • the value of the field at the specified index
Throws
IndexOutOfBoundsException if the index is invalid

public abstract int hashCode ()

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;

Returns
  • a suitable hash code

public abstract boolean isSupported (DateTimeFieldType field)

Checks whether the field type specified is supported by this partial.

Parameters
field the field to check, may be null which returns false
Returns
  • true if the field is supported

public abstract int size ()

Gets the number of fields that this partial supports.

Returns
  • the number of fields supported

public abstract 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. 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
Returns
  • the combined datetime

public abstract String toString ()

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.

Returns
  • the value as an ISO8601 string