com.jn.langx.util.jodatime.base

类 AbstractPeriod

java.lang.Object

com.jn.langx.util.jodatime.base.AbstractPeriod

所有已实现的接口:

ReadablePeriod

直接已知子类:

BasePeriod

public abstract class AbstractPeriod
extends Object
implements ReadablePeriod

AbstractPeriod provides the common behaviour for period classes.

This class should generally not be used directly by API users. The ReadablePeriod interface should be used when different kinds of periods are to be referenced.

AbstractPeriod subclasses may be mutable and not thread-safe.

从以下版本开始:

1.0

作者:

Brian S O'Neill, Stephen Colebourne

构造器概要

构造器

限定符	构造器和说明
protected	AbstractPeriod() Constructor.

方法概要

限定符和类型	方法和说明
boolean	equals(Object period) Compares this object with the specified object for equality based on the value of each field.
int	get(DurationFieldType type) Gets the value of one of the fields.
DurationFieldType	getFieldType(int index) Gets the field type at the specified index.
DurationFieldType[]	getFieldTypes() Gets an array of the field types that this period supports.
int[]	getValues() Gets an array of the value of each of the fields that this period supports.
int	hashCode() Gets a hash code for the period as defined by ReadablePeriod.
int	indexOf(DurationFieldType type) Gets the index of the field in this period.
boolean	isSupported(DurationFieldType type) Checks whether the field specified is supported by this period.
int	size() Gets the number of fields that this period supports.
MutablePeriod	toMutablePeriod() Get this object as a MutablePeriod.
Period	toPeriod() Get this period as an immutable Period object.
String	toString() Gets the value as a String in the ISO8601 duration format.
String	toString(PeriodFormatter formatter) Uses the specified formatter to convert this period to a String.

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 com.jn.langx.util.jodatime.ReadablePeriod

getPeriodType, getValue

构造器详细资料

AbstractPeriod

protected AbstractPeriod()

Constructor.

方法详细资料

size

public int size()

Gets the number of fields that this period supports.

指定者:

size 在接口中 ReadablePeriod

返回:

the number of fields supported

从以下版本开始:

2.0 (previously on BasePeriod)

getFieldType

public DurationFieldType getFieldType(int index)

Gets the field type at the specified index.

指定者:

getFieldType 在接口中 ReadablePeriod

参数:

index - the index to retrieve

返回:

the field at the specified index

抛出:

IndexOutOfBoundsException - if the index is invalid

从以下版本开始:

2.0 (previously on BasePeriod)

getFieldTypes

public DurationFieldType[] getFieldTypes()

Gets an array of the field types that this period supports.

The fields are returned largest to smallest, for example Hours, Minutes, Seconds.

返回:

the fields supported in an array that may be altered, largest to smallest

getValues

public int[] getValues()

Gets an array of the value of each of the fields that this period supports.

The fields are returned largest to smallest, for example Hours, Minutes, Seconds. Each value corresponds to the same array index as getFields()

返回:

the current values of each field in an array that may be altered, largest to smallest

get

public int get(DurationFieldType type)

Gets the value of one of the fields.

If the field type specified is not supported by the period then zero is returned.

指定者:

get 在接口中 ReadablePeriod

参数:

type - the field type to query, null returns zero

返回:

the value of that field, zero if field not supported

isSupported

public boolean isSupported(DurationFieldType type)

Checks whether the field specified is supported by this period.

指定者:

isSupported 在接口中 ReadablePeriod

参数:

type - the type to check, may be null which returns false

返回:

true if the field is supported

indexOf

public int indexOf(DurationFieldType type)

Gets the index of the field in this period.

参数:

type - the type to check, may be null which returns -1

返回:

the index of -1 if not supported

toPeriod

public Period toPeriod()

Get this period as an immutable Period object.

指定者:

toPeriod 在接口中 ReadablePeriod

返回:

a Period using the same field set and values

toMutablePeriod

public MutablePeriod toMutablePeriod()

Get this object as a MutablePeriod.

This will always return a new MutablePeriod with the same fields.

指定者:

toMutablePeriod 在接口中 ReadablePeriod

返回:

a MutablePeriod using the same field set and values

equals

public boolean equals(Object period)

Compares this object with the specified object for equality based on the value of each field. All ReadablePeriod instances are accepted.

Note that a period of 1 day is not equal to a period of 24 hours, nor is 1 hour equal to 60 minutes. Only periods with the same amount in each field are equal.

This is because periods represent an abstracted definition of a time period (eg. a day may not actually be 24 hours, it might be 23 or 25 at daylight savings boundary).

To compare the actual duration of two periods, convert both to Durations, an operation that emphasises that the result may differ according to the date you choose.

指定者:

equals 在接口中 ReadablePeriod

覆盖:

equals 在类中 Object

参数:

period - a readable period to check against

返回:

true if all the field values are equal, false if not or the period is null or of an incorrect type

hashCode

public int hashCode()

Gets a hash code for the period as defined by ReadablePeriod.

指定者:

hashCode 在接口中 ReadablePeriod

覆盖:

hashCode 在类中 Object

返回:

a hash code

toString

public String toString()

Gets the value as a String in the ISO8601 duration format.

For example, "PT6H3M7S" represents 6 hours, 3 minutes, 7 seconds.

For more control over the output, see PeriodFormatterBuilder.

指定者:

toString 在接口中 ReadablePeriod

覆盖:

toString 在类中 Object

返回:

the value as an ISO8601 string

toString

public String toString(PeriodFormatter formatter)

Uses the specified formatter to convert this period to a String.

参数:

formatter - the formatter to use, null means use toString().

返回:

the formatted string

从以下版本开始:

1.5