org.joda.time.base
Class BasePartial

java.lang.Object
  org.joda.time.base.AbstractPartial
      org.joda.time.base.BasePartial

All Implemented Interfaces:

Comparable, ReadablePartial, Serializable

Direct Known Subclasses:

TimeOfDay, YearMonthDay

public abstract class BasePartial

extends AbstractPartial

implements ReadablePartial, Serializable

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.

Since:

1.0

Author:

Stephen Colebourne

See Also:

Serialized Form

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.
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, getFields, getFieldType, getFieldTypes, hashCode, indexOf, isAfter, isBefore, isEqual, isSupported, toDateTime, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.joda.time.ReadablePartial

equals, get, getField, getFieldType, hashCode, isSupported, size, toDateTime, toString

Method Detail

getValue

public int getValue(int index)

Gets the value of the field at the specifed index.

Specified by:

getValue in interface ReadablePartial

Parameters:

index - the index

Returns:

the value

Throws:

IndexOutOfBoundsException - if the index is invalid

getValues

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()

Overrides:

getValues in class AbstractPartial

Returns:

the current values of each field (cloned), largest to smallest

getChronology

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.

Specified by:

getChronology in interface ReadablePartial

Returns:

the chronology, never null

toString

public String toString(String pattern)

Output the date using the specified format pattern.

Parameters:

pattern - the pattern specification, null means use toString

See Also:

DateTimeFormat

toString

public String toString(String pattern,
                       Locale locale)
                throws IllegalArgumentException

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:

DateTimeFormat