|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.reticular.agentBuilder.agent.profile.Time
Description : The time class specifies a date and time. This class will later have support for specifying periodocity so that this class can be used to schedule events.
Field Summary | |
static int |
SHUTDOWN
The constants for specifying the type and getting the name. |
static java.lang.String |
SHUTDOWN_KEYWORD
|
static int |
STARTUP
|
static java.lang.String |
STARTUP_KEYWORD
|
static int |
USER_DEFINED
|
static java.lang.String |
USER_DEFINED_KEYWORD
|
Constructor Summary | |
Time()
Description : Constructs a time object and initialies the date and time. |
|
Time(int newType)
Description : Constructs a time object and initialies the date and time. |
|
Time(int year,
int month,
int day,
int hour,
int minutes,
int seconds)
Description : Constructs a Time object with the specified date and time. |
Method Summary | |
java.lang.Object |
clone()
Description : Calls the super.clone() from lang.obj and catches the exceptions. |
boolean |
equals(java.lang.Object object)
Description : Determines if the given object is equal to the calling object. |
java.lang.String |
formatTime(int number)
Description : Formats the given number into time format. |
int |
getDay()
Description : Returns the day. |
int |
getHour()
Description : Returns the hour. |
int |
getMinutes()
Description : Returns the minutes. |
int |
getMonth()
Description : Returns the month. |
int |
getNumber()
Description : Not implemented. |
int |
getSeconds()
Description : Returns the seconds. |
java.lang.String |
getString()
Description : Returns a human readable represntation of the time. |
int |
getType()
Description : Returns the constant that specifies the type of time being contained (options are user defined, startup and shutdown). |
int |
getYear()
Description : Returns the year. |
void |
setDay(int day)
Description : Sets the day. |
void |
setHour(int hour)
Description : Sets the hour. |
void |
setMinutes(int minutes)
Description : Sets the minutes. |
void |
setMonth(int month)
Description : Sets the month. |
void |
setSeconds(int seconds)
Description : Sets the seconds. |
void |
setType(int newType)
Description : Determines the type of time data being stored. |
void |
setYear(int year)
Description : Sets the year. |
java.lang.String |
toBNFString()
Description : This prints the contents to a RADL BNF grammar based string. |
java.lang.String |
toString()
Description : Defines the string representation of the Time object. |
Methods inherited from class java.lang.Object |
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int SHUTDOWN
public static final java.lang.String SHUTDOWN_KEYWORD
public static final int STARTUP
public static final java.lang.String STARTUP_KEYWORD
public static final int USER_DEFINED
public static final java.lang.String USER_DEFINED_KEYWORD
Constructor Detail |
public Time()
public Time(int newType)
Int
- The type of time object.public Time(int year, int month, int day, int hour, int minutes, int seconds)
String
- The month.String
- The day.int
- The year.int
- The hour.int
- The minutes.int
- The seconds.Method Detail |
public java.lang.String toBNFString()
public java.lang.String getString()
- public int getNumber()
- public void setType(int newType)
int
- The code for the type.public int getType()
public void setMonth(int month)
String
- The new month.public int getMonth()
public void setDay(int day)
String
- The new day.public int getDay()
public void setYear(int year)
int
- The new year.public int getYear()
public void setHour(int hour)
int
- The new hour.public int getHour()
public void setMinutes(int minutes)
int
- minutespublic int getMinutes()
public void setSeconds(int seconds)
int
- secondspublic int getSeconds()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String formatTime(int number)
int
- The number to format.public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
Object
- The object being compared to the calling object.public java.lang.Object clone()
clone
in class java.lang.Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |