org.gvsig.timesupport

Interface AbsoluteInstant

All Superinterfaces:

java.lang.Cloneable, Instant, Time

All Known Implementing Classes:

DefaultAbsoluteInstant

public interface AbsoluteInstant
extends Instant, Cloneable

It defines a partial time that does not support every datetime field, and is thus a local time. It cannot be compared to a RelativeInstant, 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. An AbsoluteInstant supports a subset of the fields on the chronology.

A huge part of the documentation of this class has been retrieved from the joda-time library.

See Also:

http://joda-time.sourceforge.net, https://gvsig.org/web/projects/gvsig-desktop/docs/devel/org-gvsig-sensors/1-0.0/analysis-and-design/detailed-view/time-support/libraries/org-gvsig-timesupport-lib

Method Summary

Modifier and Type	Method and Description
int	getDays() Gets the number of days of this absolute instant.
AbsoluteInstantType	getFieldType(int index) Gets the field type at the specified index.
int	getHours() Gets the number of hours of this absolute instant.
int	getMillis() Gets the number of millis of this absolute instant.
int	getMinutes() Gets the number of minutes of this absolute instant.
int	getMonths() Gets the number of months of this absolute instant.
int	getSeconds() Gets the number of seconds of this absolute instant.
int	getValue(int index) Gets the value of the field at the specifed index.
int	getWeeks() Gets the number of weeks of this absolute instant.
int	getYears() Gets the number of years of this absolute instant.
AbsoluteInstant	minus(AbsoluteInterval interval) Gets a copy of this instance with the specified period take away.
AbsoluteInstant	plus(AbsoluteInterval interval) Gets a copy of this instance with the specified period added.
int	size() Gets the number of fields in this absolute instant.
Duration	toStandardDuration() Gets the duration of the instant.

Methods inherited from interface org.gvsig.timesupport.Instant

isAfter, isBefore, isEqual, toString

Methods inherited from interface org.gvsig.timesupport.Time

getChronology, intersects, isAbsolute, isInstant, isInterval, isRelative

Methods inherited from interface org.gvsig.tools.lang.Cloneable

clone, cloneQuietly, cloneQuietly

Method Detail

size

int size()

Gets the number of fields in this absolute instant.

Returns:

the field count

getFieldType

AbsoluteInstantType getFieldType(int index)

Gets the field type at the specified index.

Parameters:

index - the index to retrieve

Returns:

the field at the specified index

getValue

int getValue(int index)

Gets the value of the field at the specifed index.

Parameters:

index - the index

Returns:

the value

Throws:

java.lang.IndexOutOfBoundsException - if the index is invalid

getYears

int getYears()

Gets the number of years of this absolute instant.

Returns:

the number of years

getMonths

int getMonths()

Gets the number of months of this absolute instant.

Returns:

the number of months

getWeeks

int getWeeks()

Gets the number of weeks of this absolute instant.

Returns:

the number of weeks

getDays

int getDays()

Gets the number of days of this absolute instant.

Returns:

the number of days

getHours

int getHours()

Gets the number of hours of this absolute instant.

Returns:

the number of hours

getMinutes

int getMinutes()

Gets the number of minutes of this absolute instant.

Returns:

the number of minutes

getSeconds

int getSeconds()

Gets the number of seconds of this absolute instant.

Returns:

the number of seconds

getMillis

int getMillis()

Gets the number of millis of this absolute instant.

Returns:

the number of millis

toStandardDuration

Duration toStandardDuration()

Gets the duration of the instant. It returns a duration assuming a 365 days year, 12 months year, 30 days month, 7 day week, 24 hour day, 60 minute hour, 60 second minute and 1000 millis second.

Returns:

a duration equivalent to this instant from the time 0

minus

AbsoluteInstant minus(AbsoluteInterval interval)

Gets a copy of this instance with the specified period take away. If the amount is zero or null, then this is returned. *

Parameters:

period - the period to reduce this instant by

Returns:

a copy of this instance with the period taken away

Throws:

java.lang.ArithmeticException - if the new instant exceeds the capacity of a long

plus

AbsoluteInstant plus(AbsoluteInterval interval)

Gets a copy of this instance with the specified period added. If the amount is zero or null, then this is returned.

Parameters:

period - the duration to add to this one, null means zero

Returns:

a copy of this instance with the period added

Throws:

java.lang.ArithmeticException - if the new instant exceeds the capacity of a long