org.cyclos.entities.utils

Class TimeInterval

java.lang.Object

org.cyclos.entities.utils.TimeInterval

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<TimeInterval>, ITimeInterval

@Embeddable
public class TimeInterval
extends java.lang.Object
implements ITimeInterval, java.lang.Cloneable, java.lang.Comparable<TimeInterval>

Defines a time interval. It represents an amount of time in the specified unit, i.e.: 5 DAYS.

Author:

luis

Field Summary

Fields

Modifier and Type	Field and Description
static TimeInterval	ONE_DAY A time interval of 1 day
static TimeInterval	ONE_MONTH A time interval of 1 month
static TimeInterval	ONE_WEEK a time interval of 1 week
static TimeInterval	ONE_YEAR A time interval of 1 year

Constructor Summary

Constructors

Constructor and Description
TimeInterval()
TimeInterval(java.lang.Integer amount, TimeField field)

Method Summary

Modifier and Type	Method and Description
TimeInterval	clone()
int	compareTo(TimeInterval timeInterval)
boolean	equals(java.lang.Object obj)
TimeInterval	freeze()
java.lang.Integer	getAmount()
TimeField	getField()
long	getMilliseconds()
int	hashCode()
boolean	isValid()
void	setAmount(java.lang.Integer amount)
void	setField(TimeField field)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ONE_YEAR

public static final TimeInterval ONE_YEAR

A time interval of 1 year

ONE_MONTH

public static final TimeInterval ONE_MONTH

A time interval of 1 month

ONE_DAY

public static final TimeInterval ONE_DAY

A time interval of 1 day

ONE_WEEK

public static final TimeInterval ONE_WEEK

a time interval of 1 week

Constructor Detail

TimeInterval

public TimeInterval()

TimeInterval

public TimeInterval(java.lang.Integer amount,
                    TimeField field)

Method Detail

clone

public TimeInterval clone()

Overrides:

clone in class java.lang.Object

compareTo

public int compareTo(TimeInterval timeInterval)

Specified by:

compareTo in interface java.lang.Comparable<TimeInterval>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

freeze

public TimeInterval freeze()

getAmount

public java.lang.Integer getAmount()

Specified by:

getAmount in interface ITimeInterval

getField

public TimeField getField()

Specified by:

getField in interface ITimeInterval

getMilliseconds

public long getMilliseconds()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isValid

public boolean isValid()

setAmount

public void setAmount(java.lang.Integer amount)

setField

public void setField(TimeField field)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object