javax.cim
Class CIMDateTimeAbsolute

java.lang.Object
  javax.cim.CIMDateTime
      javax.cim.CIMDateTimeAbsolute

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class CIMDateTimeAbsolute

extends CIMDateTime

implements java.io.Serializable

This class represents the datetime data type when used as a time value as specified in the CIM Infrastructure specification. It is in the format: yyyyMMddHHmmss.SSSSSSsutc where yyyy - is a 4 digit year MM - is the month dd - is the day of the month HH - is the hour (24 hour clock) mm - is the minute ss - is the second mmmmmm - is the number of microseconds s - is "+" or "-", indicating the sign of the UTC (Universal Coordinated Time; for all intents and purposes the sane as Greenwhich Mean Time) utc - is the offset from UTC in minutes (using the sign indicated by s). For example Monday, May 25, 1998, at 1:30 PM EST would be represented as: 19980525133015.000000-300 Values must be zero-padded so that the entire string is always the same 25-character length. Fields which are not significant must be replaced with asterisk characters.

See Also:

Serialized Form

Constructor Summary

CIMDateTimeAbsolute()
Create a CIMDateTimeAbsolute object using the current Time/Date of the system

CIMDateTimeAbsolute(java.util.Calendar pCalendar)
Create a CIMDateTimeAbsolute object using a Calendar object.

CIMDateTimeAbsolute(java.lang.String pDateTime)
* Creates a CIMDateTimeAbsolute object using a string

Method Summary

int	compareTo(java.lang.Object pDateTime) Compares the CIMDateTimeAbsolute object with this one.
java.lang.String	getDateTimeString() Gets the internal string representation of the date/time object
int	getDay() Returns day value of this date
int	getHour() Returns hour value of this date
int	getMicrosecond() Returns microsecond value of this date
int	getMinute() Returns minute value of this date
int	getMonth() Returns month value of this date
int	getSecond() Returns second value of this date
int	getYear() Returns year value of this Date
int	hashCode() returns the hashcode for this object
java.lang.String	toString() Returns a String representation of the CIMDateTimeAbsolute.

Methods inherited from class javax.cim.CIMDateTime

equals

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CIMDateTimeAbsolute

public CIMDateTimeAbsolute()

Create a CIMDateTimeAbsolute object using the current Time/Date of the system

CIMDateTimeAbsolute

public CIMDateTimeAbsolute(java.util.Calendar pCalendar)
                    throws java.lang.IllegalArgumentException

Create a CIMDateTimeAbsolute object using a Calendar object.

Parameters:

pCalendar - A Calendar object used to initialize this object

Throws:

java.lang.IllegalArgumentException - if Calendar object is null

CIMDateTimeAbsolute

public CIMDateTimeAbsolute(java.lang.String pDateTime)
                    throws java.lang.IllegalArgumentException

* Creates a CIMDateTimeAbsolute object using a string

Parameters:

pDateTime - A string in the format of yyyyMMddHHmmss.SSSSSSsutc

Throws:

java.lang.IllegalArgumentException - if string is not in the correct format

Method Detail

compareTo

public int compareTo(java.lang.Object pDateTime)
              throws java.lang.IllegalArgumentException

Compares the CIMDateTimeAbsolute object with this one. If either date has "Not Significant" fields then we can only compare the significant fields

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

pDateTime - The CIMDateTimeAbsolute to be compared with this one

Returns:

int -1, zero, or 1 as this date is less than, equal to, or greater than the specified date.

Throws:

java.lang.IllegalArgumentException - if the object passed in is not an instance of CIMDataTimeAbsolute

getDateTimeString

public java.lang.String getDateTimeString()

Gets the internal string representation of the date/time object

Specified by:

getDateTimeString in class CIMDateTime

Returns:

String the internal representation of the date/time object

getDay

public int getDay()

Returns day value of this date

Returns:

if day field "not significant" this returns -1, otherwise returns day of this date

getHour

public int getHour()

Returns hour value of this date

Returns:

if hour field "not significant" this returns -1, otherwise returns hour of this date

getMicrosecond

public int getMicrosecond()

Returns microsecond value of this date

Returns:

if microsecond field "not significant" this returns -1, otherwise returns microseconds of this date

getMinute

public int getMinute()

Returns minute value of this date

Returns:

if minute field "not significant" this returns -1, otherwise returns minute of this date

getMonth

public int getMonth()

Returns month value of this date

Returns:

if month field "not significant" this returns -1, otherwise returns the month of this date

getSecond

public int getSecond()

Returns second value of this date

Returns:

if second field "not significant" this returns -1, otherwise returns second of this date

getYear

public int getYear()

Returns year value of this Date

Returns:

if year field "not significant" this returns -1, otherwise returns the year of this date

hashCode

public int hashCode()

returns the hashcode for this object

Specified by:

hashCode in class CIMDateTime

Returns:

a hashcode value for this object

toString

public java.lang.String toString()

Returns a String representation of the CIMDateTimeAbsolute. This method is intended to be used only for debugging purposes, and the format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Returns:

string representation of this datetime