org.sakaiproject.service.legacy.time
Interface Time

All Superinterfaces:
Cloneable, Comparable, Serializable
All Known Implementing Classes:
MyTime

public interface Time
extends Cloneable, Comparable, Serializable

Time ...

Version:
$Revision: 6400 $
Author:
University of Michigan, Sakai Software Development Team

Method Summary
 boolean after(Time other)
          Is this time after the other time?
 boolean before(Time other)
          Is this time before the other time?
 TimeBreakdown breakdownGmt()
          Access the time value as a TimeBreakdown object, in GMT
 TimeBreakdown breakdownLocal()
          Access the time value as a TimeBreakdown object, in Local
 Object clone()
          Make a clone.
 long getTime()
          Access the milliseconds since.
 void setTime(long value)
          Set the time in milliseconds since.
 String toStringFilePath()
          Format as a file path based on the date and time.
 String toStringGmtDate()
          Format as a string, Human Readable, date only format, GMT.
 String toStringGmtFull()
          Format as a string, Human Readable, full format, GMT.
 String toStringGmtShort()
          Format as a string, Human Readable, short (time only) format, GMT.
 String toStringGmtTime()
          Format as a string, Human Readable, time only format, GMT.
 String toStringLocal()
          Format as a string, Local time zone.
 String toStringLocalDate()
          Format as a string, Human Readable, date only format, Local.
 String toStringLocalFull()
          Format as a string, Human Readable, full format, Local.
 String toStringLocalFullZ()
          Format as a string, Human Readable, full format, Local, with zone.
 String toStringLocalShort()
          Format as a string, Human Readable, short (time only) format, Local.
 String toStringLocalShortDate()
          Format as a string, short format: MM/DD/YY, Local.
 String toStringLocalTime()
          Format as a string, Human Readable, time only format, Local.
 String toStringLocalTime24()
          Format as a string, Human Readable, time only format, 24hour Local.
 String toStringLocalTimeZ()
          Format as a string, Human Readable, time only format, Local, with zone.
 String toStringSql()
          Format as a string, GMT, for a SQL statement.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

toStringSql

public String toStringSql()
Format as a string, GMT, for a SQL statement.

Returns:
Time in string format.

toStringLocal

public String toStringLocal()
Format as a string, Local time zone.

Returns:
Time in string format.

toStringGmtFull

public String toStringGmtFull()
Format as a string, Human Readable, full format, GMT.

Returns:
Time in string format.

toStringLocalFull

public String toStringLocalFull()
Format as a string, Human Readable, full format, Local.

Returns:
Time in string format.

toStringLocalFullZ

public String toStringLocalFullZ()
Format as a string, Human Readable, full format, Local, with zone.

Returns:
Time in string format.

toStringGmtShort

public String toStringGmtShort()
Format as a string, Human Readable, short (time only) format, GMT.

Returns:
Time in string format.

toStringLocalShort

public String toStringLocalShort()
Format as a string, Human Readable, short (time only) format, Local.

Returns:
Time in string format.

toStringGmtTime

public String toStringGmtTime()
Format as a string, Human Readable, time only format, GMT.

Returns:
Time in string format.

toStringLocalTime

public String toStringLocalTime()
Format as a string, Human Readable, time only format, Local.

Returns:
Time in string format.

toStringLocalTime24

public String toStringLocalTime24()
Format as a string, Human Readable, time only format, 24hour Local.

Returns:
Time in string format.

toStringLocalTimeZ

public String toStringLocalTimeZ()
Format as a string, Human Readable, time only format, Local, with zone.

Returns:
Time in string format.

toStringGmtDate

public String toStringGmtDate()
Format as a string, Human Readable, date only format, GMT.

Returns:
Time in string format.

toStringLocalDate

public String toStringLocalDate()
Format as a string, Human Readable, date only format, Local.

Returns:
Time in string format.

toStringLocalShortDate

public String toStringLocalShortDate()
Format as a string, short format: MM/DD/YY, Local.

Returns:
Time in string format.

toStringFilePath

public String toStringFilePath()
Format as a file path based on the date and time.

Returns:
Time is string format.

setTime

public void setTime(long value)
Set the time in milliseconds since.

Parameters:
value - The milliseconds since value for the time.

getTime

public long getTime()
Access the milliseconds since.

Returns:
The milliseconds since value.

before

public boolean before(Time other)
Is this time before the other time?

Parameters:
other - The other time for the comparison.
Returns:
true if this time is before the other, false if not.

after

public boolean after(Time other)
Is this time after the other time?

Parameters:
other - The other time for the comparison.
Returns:
true if this time is after the other, false if not.

clone

public Object clone()
Make a clone.

Returns:
The clone.

breakdownGmt

public TimeBreakdown breakdownGmt()
Access the time value as a TimeBreakdown object, in GMT

Returns:
A TimeBreakdown object representing this time's value in GMT

breakdownLocal

public TimeBreakdown breakdownLocal()
Access the time value as a TimeBreakdown object, in Local

Returns:
A TimeBreakdown object representing this time's value in GMT