eve.data

Class PlainTime

java.lang.Object

eve.data.DataObject

eve.data.PlainTime

All Implemented Interfaces:

DataUnit, ITime, Value, Copyable, Intable, LocaleFormatted, Stringable, Comparable

public class PlainTime
extends DataObject
implements LocaleFormatted, ITime, Intable, Value

A PlainTime holds a time of day value without any TimeZone info. The Time, TimeOfDay and TimeInDay classes all take timezones into account which raises the possibility of values changing when data is moved from one timezone into another.

Field Summary

Fields

Modifier and Type	Field and Description
int	hour The full 24 hour value, from 0 to 23
int	millis The full millisecond in the second value, from 0 to 999
int	minute The full minute in the hour value, from 0 to 59
int	second The full second in the minute value, from 0 to 59

Constructor Summary

Constructors

Constructor and Description
PlainTime()
PlainTime(int hour, int minute, int second)
PlainTime(int hour, int minute, int second, int millisecond)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object other) Compare this object with another.
void	format(LocaleFormat locale, CharArray dest)
String	format(String format) Format the PlainTime using the LocaleFormat.format() method.
CharArray	format(String format, Locale locale, CharArray dest)
void	fromString(char[] src, int offset, int length)
void	fromString(String s)
int	getInt() Convert this PlainDate into a platform independent int value.
PlainTime	getTime(PlainTime dest)
int	hashCode() Returns a hashCode for the object.
void	makeTimeInvalid() Set all values to -1.
void	parse(LocaleFormat localeFormat, char[] chars, int offset, int length)
void	parse(String toParse, String format) Parse the PlainTime using the LocaleFormat.parse() method.
void	setInt(int value) Retrieve this PlainTime from a platform independent int value.
void	setTime(int hour, int minute, int second, int millis)
PlainTime	setToCurrent() Set the PlainDate to the current date.
boolean	timeIsValid() Makes sure all values are greater than -1.
String	toString() Return a String representation of this object.
CharArray	toString(CharArray dest)

Methods inherited from class eve.data.DataObject

_getFieldType, _getSetField, cache, copied, copyFrom, equals, getCopy, getDeclaredField, getDeclaredFieldValue, getMyFieldList, getNew

Methods inherited from class java.lang.Object

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

Field Detail

hour

public int hour

The full 24 hour value, from 0 to 23

minute

public int minute

The full minute in the hour value, from 0 to 59

second

public int second

The full second in the minute value, from 0 to 59

millis

public int millis

The full millisecond in the second value, from 0 to 999

Constructor Detail

PlainTime

public PlainTime()

PlainTime

public PlainTime(int hour,
                 int minute,
                 int second)

PlainTime

public PlainTime(int hour,
                 int minute,
                 int second,
                 int millisecond)

Method Detail

format

public String format(String format)

Format the PlainTime using the LocaleFormat.format() method.

Returns:

a String that is the formatted PlainDate.

parse

public void parse(String toParse,
                  String format)
           throws ParseException

Parse the PlainTime using the LocaleFormat.parse() method.

Parameters:

toParse - the String to parse.

format - the expected format.

Throws:

ParseException - if the format is wrong.

setToCurrent

public PlainTime setToCurrent()

Set the PlainDate to the current date.

Returns:

this PlainDate.

timeIsValid

public boolean timeIsValid()

Makes sure all values are greater than -1.

Specified by:

timeIsValid in interface ITime

makeTimeInvalid

public void makeTimeInvalid()

Set all values to -1.

Specified by:

makeTimeInvalid in interface ITime

getInt

public int getInt()

Convert this PlainDate into a platform independent int value.

Specified by:

getInt in interface Intable

setInt

public void setInt(int value)

Retrieve this PlainTime from a platform independent int value.

Specified by:

setInt in interface Intable

compareTo

public int compareTo(Object other)

Description copied from interface: Comparable

Compare this object with another. It should return: less than 0 if this object is considered LESS than the "other" object; greater than 0 if this object is considered GREATER than the "other" object; 0 if this object is considered EQUAL to the "other" object. (i.e. it is an implicit subtraction).

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class DataObject

hashCode

public int hashCode()

Description copied from class: Object

Returns a hashCode for the object. The general contract of hashCode is:

An object must return the same hash code for its entire existence. If two objects are considered equal by the equals() method, they should return the same hash code. Not all Objects will do this and you should only use hashCode() from Objects which declare an overrided version of hashCode(). The only Objects which provide consistent and correct hash codes under Ewe are Object, String and Class.

Overrides:

hashCode in class Object

getTime

public PlainTime getTime(PlainTime dest)

Specified by:

getTime in interface ITime

setTime

public void setTime(int hour,
                    int minute,
                    int second,
                    int millis)

Specified by:

setTime in interface ITime

fromString

public void fromString(char[] src,
                       int offset,
                       int length)

Specified by:

fromString in interface Stringable

toString

public CharArray toString(CharArray dest)

Specified by:

toString in interface Stringable

toString

public String toString()

Description copied from class: Object

Return a String representation of this object.

Specified by:

toString in interface Stringable

Overrides:

toString in class Object

Returns:

a String representing this object.

format

public CharArray format(String format,
                        Locale locale,
                        CharArray dest)

fromString

public void fromString(String s)

Specified by:

fromString in interface Stringable

format

public void format(LocaleFormat locale,
                   CharArray dest)

Specified by:

format in interface LocaleFormatted

parse

public void parse(LocaleFormat localeFormat,
                  char[] chars,
                  int offset,
                  int length)
           throws ParseException

Specified by:

parse in interface LocaleFormatted

Throws:

ParseException