Class BaseDateTimeDt

    • Constructor Detail

      • BaseDateTimeDt

        public BaseDateTimeDt()
        Constructor
      • BaseDateTimeDt

        public BaseDateTimeDt​(String theString)
        Constructor
        Throws:
        DataFormatException - If the specified precision is not allowed for this type
    • Method Detail

      • encode

        protected String encode​(Date theValue)
        Description copied from class: BasePrimitive
        Subclasses must override to convert a "coerced" value into an encoded one.
        Specified by:
        encode in class BasePrimitive<Date>
        Parameters:
        theValue - Will not be null
        Returns:
        May return null if the value does not correspond to anything
      • getDay

        public Integer getDay()
        Returns the month with 1-index, e.g. 1=the first day of the month
      • getDefaultPrecisionForDatatype

        protected abstract TemporalPrecisionEnum getDefaultPrecisionForDatatype()
        Returns the default precision for the given datatype
      • getHour

        public Integer getHour()
        Returns the hour of the day in a 24h clock, e.g. 13=1pm
      • getMillis

        public Integer getMillis()
        Returns the milliseconds within the current second.

        Note that this method returns the same value as getNanos() but with less precision.

      • getMinute

        public Integer getMinute()
        Returns the minute of the hour in the range 0-59
      • getMonth

        public Integer getMonth()
        Returns the month with 0-index, e.g. 0=January
      • getNanos

        public Long getNanos()
        Returns the nanoseconds within the current second

        Note that this method returns the same value as getMillis() but with more precision.

      • getSecond

        public Integer getSecond()
        Returns the second of the minute in the range 0-59
      • getTimeZone

        public TimeZone getTimeZone()
        Returns the TimeZone associated with this dateTime's value. May return null if no timezone was supplied.
      • getYear

        public Integer getYear()
        Returns the year, e.g. 2015
      • isPrecisionAllowed

        protected abstract boolean isPrecisionAllowed​(TemporalPrecisionEnum thePrecision)
        To be implemented by subclasses to indicate whether the given precision is allowed by this type
      • isTimeZoneZulu

        public boolean isTimeZoneZulu()
        Returns true if the timezone is set to GMT-0:00 (Z)
      • setDay

        public BaseDateTimeDt setDay​(int theDay)
        Sets the month with 1-index, e.g. 1=the first day of the month
      • setHour

        public BaseDateTimeDt setHour​(int theHour)
        Sets the hour of the day in a 24h clock, e.g. 13=1pm
      • setMillis

        public BaseDateTimeDt setMillis​(int theMillis)
        Sets the milliseconds within the current second.

        Note that this method sets the same value as setNanos(long) but with less precision.

      • setMinute

        public BaseDateTimeDt setMinute​(int theMinute)
        Sets the minute of the hour in the range 0-59
      • setMonth

        public BaseDateTimeDt setMonth​(int theMonth)
        Sets the month with 0-index, e.g. 0=January
      • setNanos

        public BaseDateTimeDt setNanos​(long theNanos)
        Sets the nanoseconds within the current second

        Note that this method sets the same value as setMillis(int) but with more precision.

      • setSecond

        public BaseDateTimeDt setSecond​(int theSecond)
        Sets the second of the minute in the range 0-59
      • setTimeZoneZulu

        public BaseDateTimeDt setTimeZoneZulu​(boolean theTimeZoneZulu)
      • setValue

        public BaseDateTimeDt setValue​(Date theValue)
        Sets the value for this type using the given Java Date object as the time, and using the default precision for this datatype (unless the precision is already set), as well as the local timezone as determined by the local operating system. Both of these properties may be modified in subsequent calls if neccesary.
        Specified by:
        setValue in interface IPrimitiveDatatype<Date>
        Specified by:
        setValue in interface IPrimitiveType<Date>
        Overrides:
        setValue in class BasePrimitive<Date>
      • setValue

        public void setValue​(Date theValue,
                             TemporalPrecisionEnum thePrecision)
                      throws DataFormatException
        Sets the value for this type using the given Java Date object as the time, and using the specified precision, as well as the local timezone as determined by the local operating system. Both of these properties may be modified in subsequent calls if neccesary.
        Parameters:
        theValue - The date value
        thePrecision - The precision
        Throws:
        DataFormatException
      • setYear

        public BaseDateTimeDt setYear​(int theYear)
        Sets the year, e.g. 2015
      • toHumanDisplay

        public String toHumanDisplay()
        Returns a human readable version of this date/time using the system local format.

        Note on time zones: This method renders the value using the time zone that is contained within the value. For example, if this date object contains the value "2012-01-05T12:00:00-08:00", the human display will be rendered as "12:00:00" even if the application is being executed on a system in a different time zone. If this behaviour is not what you want, use toHumanDisplayLocalTimezone() instead.