com.planet_ink.coffee_mud.Libraries.interfaces
Interface TimeManager

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

CoffeeTime

public interface TimeManager
extends CMLibrary

Field Summary

static long	MILI_DAY
static long	MILI_HOUR
static long	MILI_MINUTE
static long	MILI_MONTH
static long	MILI_SECOND
static long	MILI_WEEK
static long	MILI_YEAR

Method Summary

java.lang.String	convertHour(java.lang.String TheHour) Returns the regular Hours given the hours in the international format (military time) Usage: ConvertHour(GetIn(req, "ENDHR"))
java.lang.String	date2AMPMString(long time) Returns the Minutes portion of a given Time Usage: String ST_AMPM=T2_AMPMString();
java.lang.String	date2Date2String(long time) Converts a given date into a string of form: MM/DD/YY Usage: d2D2String()
java.lang.String	date2DateString(long time) Converts a given date into a string of form: MM/DD/YYYY Usage: d2DString()
java.lang.String	date2DayOfMonthString(long time) Returns the DD portion of a given date Usage: String ENDDD=d2DDString();
java.lang.String	date2HRString(long time) Returns the Hours portion of a given Time Usage: String ENDHR=T2HRString();
java.lang.String	date2MINString(long time) Returns the Minutes portion of a given Time Usage: String ENDMIN=T2MINString();
java.lang.String	date2MonthString(long time) Returns the month for a given date Usage: String ENDMM=d2MMString();
java.lang.String	date2SecondsString(long time) Converts a given date into a string of form: MM/DD/YYYY HH:MM AP Usage: d2SString()
java.lang.String	date2String(java.util.Calendar C)
java.lang.String	date2String(long time) Converts a given date into a string of form: MM/DD/YYYY HH:MM AP Usage: d2String()
java.lang.String	date2YYYYString(long time) Returns the YYYY portion of a given date Returns the DD portion of a given date Usage: String ENDYYYY=d2YYYYString();
java.lang.String	date2ZoneString(long time) Returns the time zone of the server Usage: MEETZN = T2ZoneString();
java.lang.String	getAMPM(java.lang.String TheHour) Returns the AMPM stamp given the international Hours portion the Time Usage: getAMPM(GetIn(req, "ENDHR"))
java.lang.String	getMonthName(int Number, boolean GiveShort) Return the name of the month, given a number Usage: String Mnth=ReturnMonthName(m,GiveShort).charStats();
java.lang.String	getTheIntZoneID(int theRawOffset) Get the zone id given the timezone string Usage: GetTheZoneID(MeetTZ.getRawOffset())+"\n";
java.lang.String	getTheTimeZone(java.lang.String theID) Returns the time zone of the given ID Usage: MEETZN = GetTheTimeZone(ID);
TimeClock	globalClock() Returns the mud wide global time clock object as defined by the coffeemud.ini file.
boolean	isTickExpression(java.lang.String val) Parses whether a tick expression, or an expression ending with the word minutes, hours, seconds, days, mudhours, muddays, mudweeks, mudmonths, or mudyears
java.lang.String	month2MM(java.lang.String Month) Returns the numeric representation of the month Usage: Month2MM("January");
int	parseTickExpression(java.lang.String val) Parses either a tick expression, or an expression ending with the word minutes, hours, seconds, days, mudhours, muddays, mudweeks, mudmonths, or mudyears
java.lang.String	smtpDateFormat(long time) format the date for an smtp message Usage: msgDateFormat(98374987234)
java.util.Calendar	string2Date(java.lang.String TheDate) Converts a string of some form into a Calendar object.
long	string2Millis(java.lang.String TheDate) Converts a string of some form into a Calendar object.
java.lang.String	twoDigits(long num) Converts a number to two digits.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getSupportThread, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

MILI_SECOND

static final long MILI_SECOND

See Also:

Constant Field Values

MILI_MINUTE

static final long MILI_MINUTE

See Also:

Constant Field Values

MILI_HOUR

static final long MILI_HOUR

See Also:

Constant Field Values

MILI_DAY

static final long MILI_DAY

See Also:

Constant Field Values

MILI_WEEK

static final long MILI_WEEK

See Also:

Constant Field Values

MILI_MONTH

static final long MILI_MONTH

See Also:

Constant Field Values

MILI_YEAR

static final long MILI_YEAR

See Also:

Constant Field Values

Method Detail

month2MM

java.lang.String month2MM(java.lang.String Month)

Returns the numeric representation of the month

Usage: Month2MM("January");

Parameters:

Month - The month name

Returns:

String The number of the month as a string

getMonthName

java.lang.String getMonthName(int Number,
                              boolean GiveShort)

Return the name of the month, given a number

Usage: String Mnth=ReturnMonthName(m,GiveShort).charStats();

Parameters:

Number - Month number to convert

GiveShort - Give abbreviation if true

Returns:

String Month name

string2Millis

long string2Millis(java.lang.String TheDate)

Converts a string of some form into a Calendar object.

Usage: Calendar.S2Date(GetRes(Results,"StartDateTime"));

Parameters:

TheDate - The string to retrieve from

Returns:

Calendar Calendar object

string2Date

java.util.Calendar string2Date(java.lang.String TheDate)

Converts a string of some form into a Calendar object.

Usage: Calendar.string2Date(GetRes(Results,"StartDateTime"));

Parameters:

TheDate - The string to retrieve from

Returns:

Calendar Calendar object

twoDigits

java.lang.String twoDigits(long num)

Converts a number to two digits.

Parameters:

num - the number

Returns:

the number as two digits

convertHour

java.lang.String convertHour(java.lang.String TheHour)

Returns the regular Hours given the hours in the international format (military time)

Usage: ConvertHour(GetIn(req, "ENDHR"))

Parameters:

TheHour - Hours in military format

Returns:

String Hours in regular format

getAMPM

java.lang.String getAMPM(java.lang.String TheHour)

Returns the AMPM stamp given the international Hours portion the Time

Usage: getAMPM(GetIn(req, "ENDHR"))

Parameters:

TheHour - Hours in military format

Returns:

String AM or PM stamp

getTheIntZoneID

java.lang.String getTheIntZoneID(int theRawOffset)

Get the zone id given the timezone string

Usage: GetTheZoneID(MeetTZ.getRawOffset())+"\n";

Parameters:

theRawOffset - The time zone's raw offset to convert

Returns:

String The time zone ID

getTheTimeZone

java.lang.String getTheTimeZone(java.lang.String theID)

Returns the time zone of the given ID

Usage: MEETZN = GetTheTimeZone(ID);

Parameters:

theID - The ID of the abbreviated time zone.

Returns:

String The time zone name

date2MonthString

java.lang.String date2MonthString(long time)

Returns the month for a given date

Usage: String ENDMM=d2MMString();

Parameters:

time - The time in miliseconds

Returns:

String The month name

date2DayOfMonthString

java.lang.String date2DayOfMonthString(long time)

Returns the DD portion of a given date

Usage: String ENDDD=d2DDString();

Parameters:

time - The time in miliseconds

Returns:

String The day

date2YYYYString

java.lang.String date2YYYYString(long time)

Returns the YYYY portion of a given date Returns the DD portion of a given date

Usage: String ENDYYYY=d2YYYYString();

Parameters:

time - The time in miliseconds

Returns:

String The year

date2HRString

java.lang.String date2HRString(long time)

Returns the Hours portion of a given Time

Usage: String ENDHR=T2HRString();

Parameters:

time - time used

Returns:

String The hour

date2MINString

java.lang.String date2MINString(long time)

Returns the Minutes portion of a given Time

Usage: String ENDMIN=T2MINString();

Parameters:

time - The time in miliseconds

Returns:

String The minutes

smtpDateFormat

java.lang.String smtpDateFormat(long time)

format the date for an smtp message

Usage: msgDateFormat(98374987234)

Parameters:

time - The time in miliseconds

Returns:

String The minutes

date2ZoneString

java.lang.String date2ZoneString(long time)

Returns the time zone of the server

Usage: MEETZN = T2ZoneString();

Parameters:

time - The time in miliseconds

Returns:

String The time zone

date2AMPMString

java.lang.String date2AMPMString(long time)

Returns the Minutes portion of a given Time

Usage: String ST_AMPM=T2_AMPMString();

Parameters:

time - The time in miliseconds

Returns:

String AM or PM stamp

date2String

java.lang.String date2String(java.util.Calendar C)

date2String

java.lang.String date2String(long time)

Converts a given date into a string of form: MM/DD/YYYY HH:MM AP

Usage: d2String()

Parameters:

time - The time in miliseconds

Returns:

String Formatted date/time

date2SecondsString

java.lang.String date2SecondsString(long time)

Converts a given date into a string of form: MM/DD/YYYY HH:MM AP

Usage: d2SString()

Parameters:

time - The time in miliseconds

Returns:

String Formatted date/time

date2DateString

java.lang.String date2DateString(long time)

Converts a given date into a string of form: MM/DD/YYYY

Usage: d2DString()

Parameters:

time - The time in miliseconds

Returns:

String Formatted date

date2Date2String

java.lang.String date2Date2String(long time)

Converts a given date into a string of form: MM/DD/YY

Usage: d2D2String()

Parameters:

time - The time in miliseconds

Returns:

String Formatted date

parseTickExpression

int parseTickExpression(java.lang.String val)

Parses either a tick expression, or an expression ending with the word minutes, hours, seconds, days, mudhours, muddays, mudweeks, mudmonths, or mudyears

Parameters:

val - the expression

Returns:

the number of ticks represented by the string

isTickExpression

boolean isTickExpression(java.lang.String val)

Parses whether a tick expression, or an expression ending with the word minutes, hours, seconds, days, mudhours, muddays, mudweeks, mudmonths, or mudyears

Parameters:

val - the expression

Returns:

whether a number of ticks is represented by the string

globalClock

TimeClock globalClock()

Returns the mud wide global time clock object as defined by the coffeemud.ini file.

Returns:

the global clock

See Also:

TimeClock