DefaultRelativeInstant

java.lang.Object
- org.gvsig.timesupport.impl.DefaultRelativeInstant

All Implemented Interfaces:

Cloneable, Instant, RelativeInstant, Time

Direct Known Subclasses:

DefaultEditableRelativeInstant
```
public class DefaultRelativeInstant
extends Object
implements RelativeInstant
```

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()` Creates a copy of the object.
`int`	`compareTo(Instant instant)` Compares this object with the specified object for ascending millisecond instant order.
`boolean`	`equals(Object obj)`
`Chronology`	`getChronology()` Gets the chronology of the instant.
`int`	`getDayOfMonth()` Get the day of month field value.
`int`	`getDayOfWeek()`
`EditableRelativeInstant`	`getEditableCopy()` Get an editable copy used to edit other instance of a relative instant.
`int`	`getHourOfDay()` Get the hour of day field value.
`int`	`getMillisOfSecond()` Get the millis of second field value.
`int`	`getMinuteOfDay()` Get the minute of day field value.
`int`	`getMinuteOfHour()` Get the minute of hour field value.
`int`	`getMonthOfYear()` Get the month of year field value.
`int`	`getSecondOfDay()` Get the second of day field value.
`int`	`getSecondOfMinute()` Get the second of minute field value.
`int`	`getWeekOfWeekyear()`
`int`	`getYear()` Get the year field value.
`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(Instant instant)` Is this instant after the instant passed in comparing solely by millisecond.
`boolean`	`isBefore(Instant instant)` Is this instant before the instant passed in comparing solely by millisecond.
`boolean`	`isEqual(Instant instant)` Is this instant equal to the instant passed in comparing solely by millisecond.
`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.
`Date`	`toDate()` Get the date time as a `java.util.Date`.
`long`	`toMillis()` Gets the milliseconds of the datetime instant from the Java epoch of 1970-01-01T00:00:00Z.
`String`	`toString()`
`String`	`toString(String pattern)` Output the instant using the specified format pattern.

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getHourOfDay
```
public int getHourOfDay()
```
    Description copied from interface: RelativeInstant
    
    Get the hour of day field value.
    
    Specified by:
    
    getHourOfDay in interface RelativeInstant
    
    Returns:
    the hour of month
  - getMinuteOfHour
```
public int getMinuteOfHour()
```
    Description copied from interface: RelativeInstant
    
    Get the minute of hour field value.
    
    Specified by:
    
    getMinuteOfHour in interface RelativeInstant
    
    Returns:
    the minute of hour
  - getSecondOfMinute
```
public int getSecondOfMinute()
```
    Description copied from interface: RelativeInstant
    
    Get the second of minute field value.
    
    Specified by:
    
    getSecondOfMinute in interface RelativeInstant
    
    Returns:
    the second of minute
  - getMinuteOfDay
```
public int getMinuteOfDay()
```
    Description copied from interface: RelativeInstant
    
    Get the minute of day field value.
    
    Specified by:
    
    getMinuteOfDay in interface RelativeInstant
    
    Returns:
    the minute of day
  - getSecondOfDay
```
public int getSecondOfDay()
```
    Description copied from interface: RelativeInstant
    
    Get the second of day field value.
    
    Specified by:
    
    getSecondOfDay in interface RelativeInstant
    
    Returns:
    the second of day
  - getEditableCopy
```
public EditableRelativeInstant getEditableCopy()
```
    Description copied from interface: RelativeInstant
    
    Get an editable copy used to edit other instance of a relative instant. The new copy is initialized with the values of this intant.
    
    Specified by:
    
    getEditableCopy in interface RelativeInstant
    
    Returns:
    a copy to edit the instant
  - toMillis
```
public long toMillis()
```
    Description copied from interface: RelativeInstant
    
    Gets the milliseconds of the datetime instant from the Java epoch of 1970-01-01T00:00:00Z.
    
    Specified by:
    
    toMillis in interface RelativeInstant
    
    Returns:
    the number of milliseconds since 1970-01-01T00:00:00Z
  - toString
```
public String toString(String pattern)
```
    Description copied from interface: RelativeInstant
    
    Output the instant using the specified format pattern.
    
    Specified by:
    
    toString in interface RelativeInstant
    
    Parameters:
    pattern - the pattern specification, null means use toString
  - toDate
```
public Date toDate()
```
    Description copied from interface: RelativeInstant
    
    Get the date time as a java.util.Date.
    The Date object created has exactly the same millisecond instant as this object.
    
    Specified by:
    
    toDate in interface RelativeInstant
    
    Returns:
    a Date initialised with this relative instant
  - isEqual
```
public boolean isEqual(Instant instant)
```
    Description copied from interface: Instant
    
    Is this instant equal to the instant passed in comparing solely by millisecond.
    
    Specified by:
    
    isEqual in interface Instant
    
    Parameters:
    instant - an instant to check against, null means now
    
    Returns:
    true if the instant is equal to the instant passed in
  - isAfter
```
public boolean isAfter(Instant instant)
```
    Description copied from interface: Instant
    
    Is this instant after the instant passed in comparing solely by millisecond.
    
    Specified by:
    
    isAfter in interface Instant
    
    Parameters:
    instant - an instant to check against, null means now
    
    Returns:
    true if the instant is after the instant passed in
  - isBefore
```
public boolean isBefore(Instant instant)
```
    Description copied from interface: Instant
    
    Is this instant before the instant passed in comparing solely by millisecond.
    
    Specified by:
    
    isBefore in interface Instant
    
    Parameters:
    instant - an instant to check against, null means now
    
    Returns:
    true if the instant is before the instant passed in
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getMillisOfSecond
```
public int getMillisOfSecond()
```
    Description copied from interface: RelativeInstant
    
    Get the millis of second field value.
    
    Specified by:
    
    getMillisOfSecond in interface RelativeInstant
    
    Returns:
    the millis of second
  - 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
  - getYear
```
public int getYear()
```
    Description copied from interface: RelativeInstant
    
    Get the year field value.
    
    Specified by:
    
    getYear in interface RelativeInstant
    
    Returns:
    the year
  - getMonthOfYear
```
public int getMonthOfYear()
```
    Description copied from interface: RelativeInstant
    
    Get the month of year field value.
    
    Specified by:
    
    getMonthOfYear in interface RelativeInstant
    
    Returns:
    the month of year
  - getWeekOfWeekyear
```
public int getWeekOfWeekyear()
```
  - getDayOfWeek
```
public int getDayOfWeek()
```
  - getDayOfMonth
```
public int getDayOfMonth()
```
    Description copied from interface: RelativeInstant
    
    Get the day of month field value.
    
    Specified by:
    
    getDayOfMonth in interface RelativeInstant
    
    Returns:
    the day of month
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Description copied from interface: Cloneable
    
    Creates a copy of the object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    a copy of the object
    
    Throws:
    
    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()}.
  - 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
  - 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 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 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. compareTo public int compareTo(Instant instant) Description copied from interface: RelativeInstant Compares this object with the specified object for ascending millisecond instant order. This ordering is inconsistent with equals, as it ignores the Chronology. Specified by: compareTo in interface RelativeInstant Parameters: instant - a readable instant to check against Returns: negative value if this is less, 0 if equal, or positive value if greater

Class DefaultRelativeInstant

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getHourOfDay

getMinuteOfHour

getSecondOfMinute

getMinuteOfDay

getSecondOfDay

getEditableCopy

toMillis

toString

toDate

isEqual

isAfter

isBefore

toString

equals

getMillisOfSecond

getChronology

getYear

getMonthOfYear

getWeekOfWeekyear

getDayOfWeek

getDayOfMonth

clone

intersects

isRelative

isAbsolute

isInterval

isInstant

compareTo