Class Minute

    • Field Detail

      • serialVersionUID

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

        public static final int FIRST_MINUTE_IN_HOUR
        Useful constant for the first minute in a day.
        See Also:
        Constant Field Values
      • LAST_MINUTE_IN_HOUR

        public static final int LAST_MINUTE_IN_HOUR
        Useful constant for the last minute in a day.
        See Also:
        Constant Field Values
      • day

        private final Day day
        The day.
      • hour

        private final byte hour
        The hour in which the minute falls.
      • minute

        private final byte minute
        The minute.
      • firstMillisecond

        private long firstMillisecond
        The first millisecond.
      • lastMillisecond

        private long lastMillisecond
        The last millisecond.
    • Constructor Detail

      • Minute

        public Minute​(int minute,
                      Hour hour)
        Constructs a new Minute. The time zone and locale are determined by the calendar returned by RegularTimePeriod.getCalendarInstance().
        Parameters:
        minute - the minute (0 to 59).
        hour - the hour (null not permitted).
      • Minute

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

        public Minute​(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).
      • Minute

        public Minute​(int minute,
                      int hour,
                      int day,
                      int month,
                      int year)
        Creates a new minute. The time zone and locale are determined by the calendar returned by RegularTimePeriod.getCalendarInstance().
        Parameters:
        minute - the minute (0-59).
        hour - the hour (0-23).
        day - the day (1-31).
        month - the month (1-12).
        year - the year (1900-9999).
    • Method Detail

      • getDay

        public Day getDay()
        Returns the day.
        Returns:
        The day.
      • getHour

        public Hour getHour()
        Returns the hour.
        Returns:
        The hour (never null).
      • getHourValue

        public int getHourValue()
        Returns the hour.
        Returns:
        The hour.
      • getMinute

        public int getMinute()
        Returns the minute.
        Returns:
        The minute.
      • getFirstMillisecond

        public long getFirstMillisecond()
        Returns the first millisecond of the minute. 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 minute.
        See Also:
        getLastMillisecond()
      • getLastMillisecond

        public long getLastMillisecond()
        Returns the last millisecond of the minute. 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 minute.
        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).
      • getSerialIndex

        public long getSerialIndex()
        Returns a serial index number for the minute.
        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 minute.
        Specified by:
        getFirstMillisecond in class RegularTimePeriod
        Parameters:
        calendar - the calendar which defines the timezone (null not permitted).
        Returns:
        The first millisecond.
        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 minute.
        Specified by:
        getLastMillisecond in class RegularTimePeriod
        Parameters:
        calendar - the calendar / timezone (null not permitted).
        Returns:
        The last millisecond.
        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 object against an arbitrary Object.

        This method will return true ONLY if the object is a Minute object representing the same minute as this instance.

        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object to compare (null permitted).
        Returns:
        true if the minute and hour value of this and the object are the same.
      • 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 Minute object relative to the specified object: negative == before, zero == same, positive == after.
        Specified by:
        compareTo in interface java.lang.Comparable
        Parameters:
        o1 - object to compare.
        Returns:
        negative == before, zero == same, positive == after.
      • parseMinute

        public static Minute parseMinute​(java.lang.String s)
        Creates a Minute instance by parsing a string. The string is assumed to be in the format "YYYY-MM-DD HH:MM", perhaps with leading or trailing whitespace.
        Parameters:
        s - the minute string to parse.
        Returns:
        null, if the string is not parseable, the minute otherwise.