Package javax.cim

Class CIMDateTimeAbsolute

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CIMDateTime>

    public class CIMDateTimeAbsolute
    extends CIMDateTime
    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
    • SSSSSS - is the number of microseconds
    • s - is "+" or "-", indicating the sign of the UTC (Universal Coordinated Time; for all intents and purposes the same as Greenwich 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

      Constructors 
      Constructor Description
      CIMDateTimeAbsolute()
      Create a CIMDateTimeAbsolute object using the current Time/Date of the system.
      CIMDateTimeAbsolute​(java.lang.String pDateTime)
      Creates a CIMDateTimeAbsolute object using a string.
      CIMDateTimeAbsolute​(java.util.Calendar pCalendar)
      Create a CIMDateTimeAbsolute object using a Calendar object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(CIMDateTime 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 getUTCOffset()
      Returns UTC offset value of this date.
      int getYear()
      Returns year value of this Date.
      int hashCode()
      Returns the hash code for this object.
      java.lang.String toString()
      Returns a String representation of the CIMDateTimeAbsolute.
      • Methods inherited from class java.lang.Object

        clone, finalize, 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 or null.
    • Method Detail

      • compareTo

        public int compareTo​(CIMDateTime 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.
        Parameters:
        pDateTime - The CIMDateTimeAbsolute to be compared with this one.
        Returns:
        -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:
        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.
      • getUTCOffset

        public int getUTCOffset()
        Returns UTC offset value of this date.
        Returns:
        UTC offset 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 hash code for this object.
        Specified by:
        hashCode in class CIMDateTime
        Returns:
        A hash code value for this object.
        See Also:
        Object.hashCode()
      • 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.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String representation of this datetime.