com.viaoa.util

Class OATime

java.lang.Object

com.viaoa.util.OADateTime

com.viaoa.util.OATime

All Implemented Interfaces:

Serializable, Comparable

public class OATime
extends OADateTime

Time class that combines Calendar, Time and SimpleDateFormat into a single class.

OATime is not affected by timezone. A time created on one system will be the same on another machine, even if the timezone is different. See OADateTime for list or formatting symbols.

See Also:

OADateTime, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	Format1
static String	Format2
static String	Format3
static String	Format4
static String	Format5
static String	Format6
protected static String	timeOutputFormat default output format

Fields inherited from class com.viaoa.util.OADateTime

_time, format, FORMAT_long, staticOutputFormat, timeZone

Constructor Summary

Constructors

Constructor and Description
OATime() Create a new time that uses that uses the current Time.
OATime(Calendar c) Create a new time that uses that uses a supplied Calendar.
OATime(Date date) Create a new time that uses that uses a supplied Date.
OATime(int hrs, int mins, int secs) Create a new time that uses that uses a supplied hours, minutes, seconds.
OATime(int hrs, int mins, int secs, int mili) Create a new time that uses that uses a supplied hours, minutes, seconds, milliseconds.
OATime(long time)
OATime(OADateTime od) Create a new time that uses that uses a supplied OADateTime.
OATime(String strTime) Create a new time that uses a supplied String.
OATime(String strTime, String fmt) Create a new time that uses a supplied String and format.
OATime(Time time) Create a new time that uses that uses a supplied Time.

Method Summary

Modifier and Type	Method and Description
static void	addGlobalParseFormat(String fmt) Sets the default global parse format used when converting a String to OATime.
int	compare(Object obj) Time comparision with any object.
static String	getGlobalOutputFormat() Gets the default global format used when converting OADate to String.
static void	main(String[] args)
static void	removeAllGlobalParseFormats() Removes all global parse formats that are used when converting a String to OATime.
static void	removeGlobalParseFormat(String fmt) Removes a default global parse format that is used when converting a String to OATime.
static void	setGlobalOutputFormat(String fmt) Sets the default global format used when converting OADate to String.
static OATime	timeValue(String time) Converts a String to an OATime using a default format.
static OATime	timeValue(String time, String fmt) Converts a String to an OATime using a supplied format.
String	toString() Converts this time to a String value using default format.
String	toString(String f) Converts this time to a String value using supplied format.
static OADateTime	valueOf(String time) Converts a String to an OATime using a default format.
static OADateTime	valueOf(String time, String fmt) Converts a String to an OATime.

Methods inherited from class com.viaoa.util.OADateTime

_getCal, _releaseCal, addDay, addDays, addHours, addMilliSeconds, addMinutes, addMonths, addSeconds, addWeeks, addYears, after, before, betweenDays, betweenHours, betweenMilliSeconds, betweenMinutes, betweenMonths, betweenSeconds, betweenYears, clearDate, clearSecondAndMilliSecond, clearTime, compareTo, convert, convertTo, equals, fixDate, get12Hour, get24Hour, getAM_PM, getCalendar, getDate, getDay, getDayOfWeek, getDayOfYear, getDaysInMonth, getFormat, getFormat, getFormat, getFormatter, getHour, getMilliSecond, getMinute, getMonth, getSecond, getTime, getTimeZone, getWeekOfMonth, getWeekOfYear, getYear, hashCode, isAfter, isBefore, set12Hour, set24Hour, setAM_PM, setCalendar, setCalendar, setCalendar, setCalendar, setCalendar, setCalendar, setCalendar, setCalendar, setDate, setDate, setDay, setFormat, setHour, setLocale, setMilliSecond, setMinute, setMonth, setSecond, setTime, setTime, setTime, setTime, setTimeZone, setYear, test, toStringMain, valueOfMain

Methods inherited from class java.lang.Object

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

Field Detail

Format1

public static final String Format1

See Also:

Constant Field Values

Format2

public static final String Format2

See Also:

Constant Field Values

Format3

public static final String Format3

See Also:

Constant Field Values

Format4

public static final String Format4

See Also:

Constant Field Values

Format5

public static final String Format5

See Also:

Constant Field Values

Format6

public static final String Format6

See Also:

Constant Field Values

timeOutputFormat

protected static String timeOutputFormat

default output format

Constructor Detail

OATime

public OATime()

Create a new time that uses that uses the current Time.

Note: clearDate() is called to set date information to 0.

OATime

public OATime(Time time)

Create a new time that uses that uses a supplied Time.

Note: clearDate() is called to set date information to 0.

OATime

public OATime(Date date)

Create a new time that uses that uses a supplied Date.

Note: clearDate() is called to set date information to 0.

OATime

public OATime(long time)

OATime

public OATime(Calendar c)

Create a new time that uses that uses a supplied Calendar.

Note: clearDate() is called to set date information to 0.

OATime

public OATime(OADateTime od)

Create a new time that uses that uses a supplied OADateTime.

Note: clearDate() is called to set date information to 0.

OATime

public OATime(String strTime)

Create a new time that uses a supplied String.

Note: uses default format of "hh:mma" Note: clearDate() is called to set date information to 0.

See Also:

valueOf(java.lang.String, java.lang.String)

OATime

public OATime(String strTime,
              String fmt)

Create a new time that uses a supplied String and format.

Note: clearDate() is called to set date information to 0.

See Also:

valueOf(java.lang.String, java.lang.String)

OATime

public OATime(int hrs,
              int mins,
              int secs)

Create a new time that uses that uses a supplied hours, minutes, seconds.

Note: clearDate() is called to set date information to 0.

Parameters:

hrs - 0-23

See Also:

valueOf(java.lang.String, java.lang.String)

OATime

public OATime(int hrs,
              int mins,
              int secs,
              int mili)

Create a new time that uses that uses a supplied hours, minutes, seconds, milliseconds.

Note: clearDate() is called to set date information to 0.

Parameters:

hrs - 0-23

See Also:

valueOf(java.lang.String, java.lang.String)

Method Detail

compare

public int compare(Object obj)

Time comparision with any object. Object will first be converted to OATime.

Overrides:

compare in class OADateTime

Parameters:

obj - Date, OADate, Calendar

Returns:

"0" if equal, "-1" if this OADateTime is less than, "1" if this OADateTime is greater than, "2" if objects can not be compared.

toString

public String toString()

Converts this time to a String value using default format. The default format is the first format that has been set: "format", "timeOutputFormat" else or "hh:mma" See OADateTime for list of formatting symbols.

Overrides:

toString in class OADateTime

See Also:

OADateTime

toString

public String toString(String f)

Converts this time to a String value using supplied format. See OADateTime for list of formatting symbols.

Overrides:

toString in class OADateTime

Parameters:

f - is format to apply

See Also:

OADateTime

timeValue

public static OATime timeValue(String time,
                               String fmt)

Converts a String to an OATime using a supplied format. See OADateTime for list of formatting symbols.

See Also:

valueOf(String,String), OADateTime

timeValue

public static OATime timeValue(String time)

Converts a String to an OATime using a default format. The default format is the first format that has been set: "format", "timeOutputFormat" else or "hh:mma" See OADateTime for list of formatting symbols.

See Also:

valueOf(String,String), OADateTime

valueOf

public static OADateTime valueOf(String time,
                                 String fmt)

Converts a String to an OATime. See OADateTime for list of formatting symbols. If time can not be parsed based on supplied format, then other formatting and conversions will be used to try to convert to an OATime.

Note: you will need to cast the return value to a OATime.

Parameters:

fmt - is format to use for parsing. See OADateTime for list of formatting symbols.

See Also:

OADateTime, timeValue(String,String)

valueOf

public static OADateTime valueOf(String time)

Converts a String to an OATime using a default format. The default format is the first format that has been set: "format", "timeOutputFormat" else or "hh:mma" See OADateTime for list of formatting symbols.

Note: you will need to cast the return value to a OATime.

See Also:

valueOf(String,String), OADateTime, timeValue(String,String)

setGlobalOutputFormat

public static void setGlobalOutputFormat(String fmt)

Sets the default global format used when converting OADate to String.

See Also:

OADateTime.setFormat(java.lang.String)

getGlobalOutputFormat

public static String getGlobalOutputFormat()

Gets the default global format used when converting OADate to String.

See Also:

OADateTime.setFormat(java.lang.String)

addGlobalParseFormat

public static void addGlobalParseFormat(String fmt)

Sets the default global parse format used when converting a String to OATime.

See Also:

OADateTime.setFormat(java.lang.String)

removeGlobalParseFormat

public static void removeGlobalParseFormat(String fmt)

Removes a default global parse format that is used when converting a String to OATime.

See Also:

OADateTime.setFormat(java.lang.String)

removeAllGlobalParseFormats

public static void removeAllGlobalParseFormats()

Removes all global parse formats that are used when converting a String to OATime.

See Also:

OADateTime.setFormat(java.lang.String)

main

public static void main(String[] args)