javax.cim
Class CIMDateTimeInterval

java.lang.Object
  javax.cim.CIMDateTime
      javax.cim.CIMDateTimeInterval

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class CIMDateTimeInterval

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: ddddddddHHMMSS.mmmmmm:000 For example, an elapsed time of 1 day, 13 hours, 23 minutes, 12 seconds would be: 00000001132312.000000:000 A UTC offset of zero is always used for interval properties. fields that are not significant MUST be replaced with asterisk ("*") characters. Not significant fields are those that are beyond the resolution of the data source. This is used to indicate the precision of the value and can only be done for an adjacent set of fields, starting with the least significant field (mmmmmm), and continuing to more significant fields. The granularity of using asterisks is always the entire field, except for the mmmmmm field where the granularity is single digits. The UTC offset field MUST NOT contain asterisks. For example, if an interval of 1 day, 13 hours, 23 minutes, 12 seconds, and 125 milliseconds was measured with a precision of 1 millisecond, the format would be: 00000001132312.125***:000.

See Also:

Serialized Form

Constructor Summary

CIMDateTimeInterval(int pDays, int pHours, int pMinutes, int pSeconds, int pMicroseconds)
Constructs a CIMDateTimeInterval using the individual values of the interval (day, hours, minutes, seconds and microseconds).

CIMDateTimeInterval(long pMilliseconds)
Constructs a CIMDateTimeInterval using a milliseconds value Note:

CIMDateTimeInterval(java.lang.String pIntervalString)
Creates a CIMDateTimeInterval object using a string

Method Summary

int	compareTo(java.lang.Object dt) Compares the CIMDateTimeInterval object with this one.
java.lang.String	getDateTimeString() Gets the internal string representation of this object
int	getDays() Returns days value of this interval
int	getHours() Returns hours value of this interval
int	getMicroseconds() Returns microseconds value of this interval
int	getMinutes() Returns minutes value of this interval
int	getSeconds() Returns seconds value of this interval
long	getTotalMilliseconds() Returns the total length of the interval in milliseconds
int	hashCode() returns the hascode for this object
java.lang.String	toString() Returns a String representation of the CIMDateTimeInterval.

Methods inherited from class javax.cim.CIMDateTime

equals

Methods inherited from class java.lang.Object

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

Constructor Detail

CIMDateTimeInterval

public CIMDateTimeInterval(int pDays,
                           int pHours,
                           int pMinutes,
                           int pSeconds,
                           int pMicroseconds)
                    throws java.lang.IllegalArgumentException

Constructs a CIMDateTimeInterval using the individual values of the interval (day, hours, minutes, seconds and microseconds). Any property that has a -1 will consider that field "not significant" (i.e. that field has asterisks in the DateTime string)

Parameters:

pDays - number of days in the interval (-1 - 99999999)

pHours - number of hours in the interval (-1 - 24)

pMinutes - number of minutes in the interval (-1 - 60)

pSeconds - number of seconds in the interval (-1 - 60)

pMicroseconds - number of microseconds in the interval (-1 - 999999)

CIMDateTimeInterval

public CIMDateTimeInterval(long pMilliseconds)
                    throws java.lang.IllegalArgumentException

Constructs a CIMDateTimeInterval using a milliseconds value Note:

Parameters:

pMilliseconds - number of milliseconds in the interval (0 - 999999)

CIMDateTimeInterval

public CIMDateTimeInterval(java.lang.String pIntervalString)
                    throws java.lang.IllegalArgumentException

Creates a CIMDateTimeInterval object using a string

Parameters:

pIntervalString - A string in the format of ddddddddHHMMSS.mmmmmm:000

Throws:

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

Method Detail

compareTo

public int compareTo(java.lang.Object dt)

Compares the CIMDateTimeInterval object with this one. If either interval has "Not Significant" fields then we only compare the significant fields

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

dt - The CIMDateTimeAbsolute to be compared with this one

Returns:

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

Throws:

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

getDateTimeString

public java.lang.String getDateTimeString()

Gets the internal string representation of this object

Specified by:

getDateTimeString in class CIMDateTime

Returns:

String the internal representation of the CIMDateTimeInterval object

getDays

public int getDays()

Returns days value of this interval

Returns:

if days field "not significant" this returns -1, otherwise returns number of days in the interval

getHours

public int getHours()

Returns hours value of this interval

Returns:

if hours field "not significant" this returns -1, otherwise returns number of hours in the interval

getMicroseconds

public int getMicroseconds()

Returns microseconds value of this interval

Returns:

if microseconds field "not significant" this returns -1, otherwise returns number of microseconds in the interval

getMinutes

public int getMinutes()

Returns minutes value of this interval

Returns:

if minutes field "not significant" this returns -1, otherwise returns number of minutes in the interval

getSeconds

public int getSeconds()

Returns seconds value of this interval

Returns:

if seconds field "not significant" this returns -1, otherwise returns number of seconds in the interval

getTotalMilliseconds

public long getTotalMilliseconds()

Returns the total length of the interval in milliseconds

Returns:

the length of the interval in milliseconds

hashCode

public int hashCode()

returns the hascode 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 CIMDateTimeInterval. 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