org.gvsig.timesupport.impl

Class DefaultRelativeInterval

java.lang.Object

org.gvsig.timesupport.impl.DefaultRelativeInterval

All Implemented Interfaces:

java.lang.Cloneable, Interval, RelativeInterval, Time

public class DefaultRelativeInterval
extends java.lang.Object
implements RelativeInterval

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
boolean	contains(Instant instant) Does this time interval contain the specified time instant.
boolean	contains(RelativeInstant instant) Does this time interval contain the specified instant
boolean	contains(RelativeInterval interval) Does this time interval contain the specified interval
boolean	equals(java.lang.Object obj)
Chronology	getChronology() Gets the chronology of the instant.
RelativeInstant	getEnd() Gets the end of this time interval, which is exclusive, as an Instant.
RelativeInstant	getStart() Gets the start of this time interval, which is inclusive, as an Instant.
boolean	intersects(RelativeInterval relativeInterval)
boolean	intersects(Time time) Does this time intersects with the time passed.
boolean	isAbsolute() Checks if the time is an absolute temporal type, that is an object that doesn't has a time zone.
boolean	isAfter(RelativeInstant instant) Is this time interval after the specified instant.
boolean	isAfter(RelativeInterval interval) Is this time interval entirely after the specified interval.
boolean	isBefore(RelativeInstant instant) Is this time interval before the specified instant.
boolean	isBefore(RelativeInterval interval) Is this time interval entirely before the specified interval.
boolean	isInstant() Checks if the time is an instant, that is an object that represents a position in a time scale.
boolean	isInterval() Checks if the time is an interval, that is an object that represents a period of time between two instants.
boolean	isRelative() Checks if the time is a relative temporal type, that is an object that has a Chronology that establish how a time object can be converted into other object with date time fields.
boolean	overlaps(RelativeInterval interval) Does this time interval overlap the specified time interval.
Duration	toDuration() Gets the duration of this time interval.
long	toDurationMillis() Gets the duration of this time interval in milliseconds.
Duration	toStandardDuration() Gets the duration of the interval.
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

cloneQuietly, cloneQuietly

Method Detail

toDurationMillis

public long toDurationMillis()

Description copied from interface: RelativeInterval

Gets the duration of this time interval in milliseconds. The duration is equal to the end millis minus the start millis.

Specified by:

toDurationMillis in interface RelativeInterval

Returns:

the duration of the time interval in milliseconds

contains

public boolean contains(RelativeInstant instant)

Description copied from interface: RelativeInterval

Does this time interval contain the specified instant. *

Specified by:

contains in interface RelativeInterval

Parameters:

instant - the instant, null means now

Returns:

true if this time interval contains the instant

isAfter

public boolean isAfter(RelativeInstant instant)

Description copied from interface: RelativeInterval

Is this time interval after the specified instant. Intervals are inclusive of the start instant and exclusive of the end.

Specified by:

isAfter in interface RelativeInterval

Parameters:

instant - the instant to compare to, null means now

Returns:

true if this time interval is after the instant

isAfter

public boolean isAfter(RelativeInterval interval)

Description copied from interface: RelativeInterval

Is this time interval entirely after the specified interval. Intervals are inclusive of the start instant and exclusive of the end. Only the end time of the specified interval is used in the comparison.

Specified by:

isAfter in interface RelativeInterval

Parameters:

interval - the interval to compare to, null means now

Returns:

true if this time interval is after the interval specified

isBefore

public boolean isBefore(RelativeInstant instant)

Description copied from interface: RelativeInterval

Is this time interval before the specified instant. Intervals are inclusive of the start instant and exclusive of the end.

Specified by:

isBefore in interface RelativeInterval

Parameters:

instant - the instant to compare to, null means now

Returns:

true if this time interval is before the instant

isBefore

public boolean isBefore(RelativeInterval interval)

Description copied from interface: RelativeInterval

Is this time interval entirely before the specified interval. Intervals are inclusive of the start instant and exclusive of the end. Only the end time of the specified interval is used in the comparison.

Specified by:

isBefore in interface RelativeInterval

Parameters:

interval - the interval to compare to, null means now

Returns:

true if this time interval is before the interval specified

toDuration

public Duration toDuration()

Description copied from interface: RelativeInterval

Gets the duration of this time interval.

Specified by:

toDuration in interface RelativeInterval

Returns:

the duration of the time interval

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

contains

public boolean contains(RelativeInterval interval)

Description copied from interface: RelativeInterval

Does this time interval contain the specified interval. *

Specified by:

contains in interface RelativeInterval

Returns:

true if this time interval contains the interval

overlaps

public boolean overlaps(RelativeInterval interval)

Description copied from interface: RelativeInterval

Does this time interval overlap the specified time interval.

Specified by:

overlaps in interface RelativeInterval

Parameters:

interval - the time interval to compare to, null means a zero length interval now

Returns:

true if the time intervals overlap

getChronology

public Chronology getChronology()

Description copied from interface: Time

Gets the chronology of the instant. The Chronology provides conversion from the millisecond value to meaningful fields in a particular calendar system.

Specified by:

getChronology in interface Time

Returns:

the Chronology, never null

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class java.lang.Object

Returns:

a copy of the object

Throws:

java.lang.CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.

getStart

public RelativeInstant getStart()

Description copied from interface: RelativeInterval

Gets the start of this time interval, which is inclusive, as an Instant.

Specified by:

getStart in interface Interval

Specified by:

getStart in interface RelativeInterval

Returns:

the start of the time interval

getEnd

public RelativeInstant getEnd()

Description copied from interface: RelativeInterval

Gets the end of this time interval, which is exclusive, as an Instant.

Specified by:

getEnd in interface Interval

Specified by:

getEnd in interface RelativeInterval

Returns:

the end of the time interval

isRelative

public boolean isRelative()

Description copied from interface: Time

Checks if the time is a relative temporal type, that is an object that has a Chronology that establish how a time object can be converted into other object with date time fields.

Specified by:

isRelative in interface Time

Returns:

true

isAbsolute

public final boolean isAbsolute()

Description copied from interface: Time

Checks if the time is an absolute temporal type, that is an object that doesn't has a time zone.

Specified by:

isAbsolute in interface Time

Returns:

true if the time object is absolute

isInterval

public boolean isInterval()

Description copied from interface: Time

Checks if the time is an interval, that is an object that represents a period of time between two instants.

Specified by:

isInterval in interface Time

Returns:

true if the time object is an interval

isInstant

public final boolean isInstant()

Description copied from interface: Time

Checks if the time is an instant, that is an object that represents a position in a time scale. In practice, an instant is an interval whose duration is less than the resolution of the time scale.

Specified by:

isInstant in interface Time

Returns:

true if the time object is an instant.

contains

public boolean contains(Instant instant)

Description copied from interface: Interval

Does this time interval contain the specified time instant.

Specified by:

contains in interface Interval

Parameters:

instant - the time instant to compare to, null means now

Returns:

true if this time interval contains the time instant

intersects

public boolean intersects(Time time)

Description copied from interface: Time

Does this time intersects with the time passed.

Specified by:

intersects in interface Time

Parameters:

time - an instant to check against, null means now

Returns:

true if the time intersects with the time passed in

intersects

public boolean intersects(RelativeInterval relativeInterval)

toStandardDuration

public Duration toStandardDuration()

Description copied from interface: Interval

Gets the duration of the interval. If the interval is relative, it returns the exact duration. It the interval is relative, 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.

Specified by:

toStandardDuration in interface Interval

Returns:

a duration equivalent to this interval