Class Day

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        For serialization.
        See Also:
        Constant Field Values
      • DATE_FORMAT

        protected static final java.text.DateFormat DATE_FORMAT
        A standard date formatter.
      • DATE_FORMAT_SHORT

        protected static final java.text.DateFormat DATE_FORMAT_SHORT
        A date formatter for the default locale.
      • DATE_FORMAT_MEDIUM

        protected static final java.text.DateFormat DATE_FORMAT_MEDIUM
        A date formatter for the default locale.
      • DATE_FORMAT_LONG

        protected static final java.text.DateFormat DATE_FORMAT_LONG
        A date formatter for the default locale.
      • serialDate

        private SerialDate serialDate
        The day (uses SerialDate for convenience).
      • firstMillisecond

        private long firstMillisecond
        The first millisecond.
      • lastMillisecond

        private long lastMillisecond
        The last millisecond.
    • Constructor Detail

      • Day

        public Day​(int day,
                   int month,
                   int year)
        Constructs a new one day time period. The time zone and locale are determined by the calendar returned by RegularTimePeriod.getCalendarInstance().
        Parameters:
        day - the day-of-the-month.
        month - the month (1 to 12).
        year - the year (1900 <= year <= 9999).
      • Day

        public Day​(SerialDate serialDate)
        Constructs a new one day time period. The time zone and locale are determined by the calendar returned by RegularTimePeriod.getCalendarInstance().
        Parameters:
        serialDate - the day (null not permitted).
      • Day

        public Day​(java.util.Date time,
                   java.util.TimeZone zone,
                   java.util.Locale locale)
        Constructs a new instance, based on a particular date/time and time zone.
        Parameters:
        time - the date/time (null not permitted).
        zone - the time zone (null not permitted).
        locale - the locale (null not permitted).
      • Day

        public Day​(java.util.Date time,
                   java.util.Calendar calendar)
        Constructs a new instance, based on a particular date/time. The time zone and locale are determined by the calendar parameter.
        Parameters:
        time - the date/time (null not permitted).
        calendar - the calendar to use for calculations (null not permitted).
    • Method Detail

      • initUsing

        private void initUsing​(java.util.Calendar calendar)
      • getSerialDate

        public SerialDate getSerialDate()
        Returns the day as a SerialDate. Note: the reference that is returned should be an instance of an immutable SerialDate (otherwise the caller could use the reference to alter the state of this Day instance, and Day is supposed to be immutable).
        Returns:
        The day as a SerialDate.
      • getYear

        public int getYear()
        Returns the year.
        Returns:
        The year.
      • getMonth

        public int getMonth()
        Returns the month.
        Returns:
        The month.
      • getDayOfMonth

        public int getDayOfMonth()
        Returns the day of the month.
        Returns:
        The day of the month.
      • getFirstMillisecond

        public long getFirstMillisecond()
        Returns the first millisecond of the day. This will be determined relative to the time zone specified in the constructor, or in the calendar instance passed in the most recent call to the peg(Calendar) method.
        Specified by:
        getFirstMillisecond in class RegularTimePeriod
        Returns:
        The first millisecond of the day.
        See Also:
        getLastMillisecond()
      • getLastMillisecond

        public long getLastMillisecond()
        Returns the last millisecond of the day. This will be determined relative to the time zone specified in the constructor, or in the calendar instance passed in the most recent call to the peg(Calendar) method.
        Specified by:
        getLastMillisecond in class RegularTimePeriod
        Returns:
        The last millisecond of the day.
        See Also:
        getFirstMillisecond()
      • peg

        public void peg​(java.util.Calendar calendar)
        Recalculates the start date/time and end date/time for this time period relative to the supplied calendar (which incorporates a time zone).
        Specified by:
        peg in class RegularTimePeriod
        Parameters:
        calendar - the calendar (null not permitted).
      • next

        public RegularTimePeriod next()
        Returns the day following this one, or null if some limit has been reached. No matter what time zone and locale this instance was created with, the returned instance will use the default calendar for time calculations, obtained with RegularTimePeriod.getCalendarInstance().
        Specified by:
        next in class RegularTimePeriod
        Returns:
        The day following this one, or null if some limit has been reached.
      • getSerialIndex

        public long getSerialIndex()
        Returns a serial index number for the day.
        Specified by:
        getSerialIndex in class RegularTimePeriod
        Returns:
        The serial index number.
      • getFirstMillisecond

        public long getFirstMillisecond​(java.util.Calendar calendar)
        Returns the first millisecond of the day, evaluated using the supplied calendar (which determines the time zone).
        Specified by:
        getFirstMillisecond in class RegularTimePeriod
        Parameters:
        calendar - calendar to use (null not permitted).
        Returns:
        The start of the day as milliseconds since 01-01-1970.
        Throws:
        java.lang.NullPointerException - if calendar is null.
        See Also:
        RegularTimePeriod.getLastMillisecond(Calendar)
      • getLastMillisecond

        public long getLastMillisecond​(java.util.Calendar calendar)
        Returns the last millisecond of the day, evaluated using the supplied calendar (which determines the time zone).
        Specified by:
        getLastMillisecond in class RegularTimePeriod
        Parameters:
        calendar - calendar to use (null not permitted).
        Returns:
        The end of the day as milliseconds since 01-01-1970.
        Throws:
        java.lang.NullPointerException - if calendar is null.
        See Also:
        RegularTimePeriod.getFirstMillisecond(Calendar)
      • equals

        public boolean equals​(java.lang.Object obj)
        Tests the equality of this Day object to an arbitrary object. Returns true if the target is a Day instance or a SerialDate instance representing the same day as this object. In all other cases, returns false.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        A flag indicating whether or not an object is equal to this day.
      • hashCode

        public int hashCode()
        Returns a hash code for this object instance. The approach described by Joshua Bloch in "Effective Java" has been used here:

        http://developer.java.sun.com/developer/Books/effectivejava /Chapter3.pdf

        Overrides:
        hashCode in class java.lang.Object
        Returns:
        A hash code.
      • compareTo

        public int compareTo​(java.lang.Object o1)
        Returns an integer indicating the order of this Day object relative to the specified object: negative == before, zero == same, positive == after.
        Specified by:
        compareTo in interface java.lang.Comparable
        Parameters:
        o1 - the object to compare.
        Returns:
        negative == before, zero == same, positive == after.
      • toString

        public java.lang.String toString()
        Returns a string representing the day.
        Overrides:
        toString in class RegularTimePeriod
        Returns:
        A string representing the day.
      • parseDay

        public static Day parseDay​(java.lang.String s)
        Parses the string argument as a day.

        This method is required to recognise YYYY-MM-DD as a valid format. Anything else, for now, is a bonus.

        Parameters:
        s - the date string to parse.
        Returns:
        null if the string does not contain any parseable string, the day otherwise.