com.goldencode.p2j.directory

Class TimeValue

java.lang.Object

com.goldencode.p2j.directory.TimeValue

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class TimeValue
extends java.lang.Object
implements java.lang.Comparable, java.io.Serializable

The main purpose of this class is to hold time value for storing/saving it in the Directory. Also it allows to distinguish types during processing (this is not so simple for java.util.Date and derivatives). For the convenience it can be easily converted to/from java.util.Date class.

Version:

1.0

Author:

SIY

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Calendar	calendar Date/Time storage/manipulation back-end
private static java.lang.ThreadLocal<java.text.SimpleDateFormat>	format Format used for TimeValue <-> String conversion.

Constructor Summary

Constructors

Constructor and Description
TimeValue(java.util.Date other) Constructs an instance of the TimeValue from the Date instance.
TimeValue(int hours, int minutes) Constructs an instance of the TimeValue from hours and minutes.
TimeValue(int hours, int minutes, int seconds) Constructs an instance with all fields (hours, minutes, and seconds) defined.
TimeValue(TimeValue other) Constructs an instance of the TimeValue from the other instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.util.Date other) Compares this instance with instance of Date for ordering.
int	compareTo(java.lang.Object other) Compare this instance with other object.
int	compareTo(TimeValue other) Compares two instances for ordering.
private void	enforceDate(java.util.Date input) This method performs all necessary steps to enforce TimeValue instance to contain only time, without date part.
boolean	equals(java.lang.Object o) Compares two objects for equality.
java.util.Date	getDate() Return current time as instance of the Date.
int	hashCode() Return a hash code for the instance.
void	setDate(java.util.Date date) Set current value using instance of Date as a source.
java.lang.String	toString() Convert TimeValue instance into String.
static TimeValue	valueOf(java.lang.String str) Parse String like HH:MM:SS and create an instance of TimeValue.

Methods inherited from class java.lang.Object

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

Field Detail

format

private static final java.lang.ThreadLocal<java.text.SimpleDateFormat> format

Format used for TimeValue <-> String conversion.

calendar

private java.util.Calendar calendar

Date/Time storage/manipulation back-end

Constructor Detail

TimeValue

public TimeValue(java.util.Date other)

Constructs an instance of the TimeValue from the Date instance.

Parameters:

other - An instance which is used as a source of data.

TimeValue

public TimeValue(int hours,
                 int minutes)

Constructs an instance of the TimeValue from hours and minutes. Other fields are set to 0

Parameters:

hours - Hours filed for the new instance.

minutes - Minutes value for the new instance.

TimeValue

public TimeValue(int hours,
                 int minutes,
                 int seconds)

Constructs an instance with all fields (hours, minutes, and seconds) defined.

Parameters:

hours - Hours value for the new instance.

minutes - Minutes value for the new instance.

seconds - Seconds value for the new instance.

TimeValue

public TimeValue(TimeValue other)

Constructs an instance of the TimeValue from the other instance.

Parameters:

other - An instance which is used as a source of data.

Method Detail

valueOf

public static TimeValue valueOf(java.lang.String str)

Parse String like HH:MM:SS and create an instance of TimeValue.

Parameters:

str - Source string.

Returns:

new TimeValue instance or null if source string does not contain properly formatted time.

compareTo

public int compareTo(java.util.Date other)

Compares this instance with instance of Date for ordering. Note that argument must have date part reset to 0 because it is involved into comparison.

Parameters:

other - The instance of Date to be compared.

Returns:

0 if times are equal; a value less than 0 if this instance time is before time of the passed parameter; a value greater than 0 if this instance time is after time of the parameter.

compareTo

public int compareTo(java.lang.Object other)

Compare this instance with other object.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

other - The instance of Date to be compared.

Returns:

0 if times are equal; a value less than 0 if this instance time is before time of the passed parameter; a value greater than 0 if this instance time is after time of the parameter.

Throws:

java.lang.ClassCastException - if argument is not instance of Date or TimeValue.

compareTo

public int compareTo(TimeValue other)

Compares two instances for ordering.

Parameters:

other - The instance to be compared.

Returns:

0 if instances are equal; a value less than 0 if this instance time is before time of the instance passed as a parameter; a value greater than 0 if this instance time is after time of the instance passed as a parameter.

equals

public boolean equals(java.lang.Object o)

Compares two objects for equality. Call Calendar.equals() or Date.equals() if possible. Otherwise return false.

Overrides:

equals in class java.lang.Object

Parameters:

o - Object to compare with.

Returns:

true if instances are equal and false otherwise.

getDate

public java.util.Date getDate()

Return current time as instance of the Date.

Returns:

An instance of java.util.Date.

hashCode

public int hashCode()

Return a hash code for the instance. Use Date.hashCode() for real computation.

Overrides:

hashCode in class java.lang.Object

Returns:

Hash code for the instance.

setDate

public void setDate(java.util.Date date)

Set current value using instance of Date as a source.

Parameters:

date - Source instance of Date to get values from.

toString

public java.lang.String toString()

Convert TimeValue instance into String.

Overrides:

toString in class java.lang.Object

Returns:

String in format HH:MM:SS.

enforceDate

private void enforceDate(java.util.Date input)

This method performs all necessary steps to enforce TimeValue instance to contain only time, without date part.

Parameters:

input - Date instance to set information from.