Package org.quartz

Class TimeOfDay

  • All Implemented Interfaces:
    java.io.Serializable
    public class TimeOfDay
extends java.lang.Object
implements java.io.Serializable
    Represents a time in hour, minute and second of any given day.

    The hour is in 24-hour convention, meaning values are from 0 to 23.

    Since:
    2.0.3
    Author:
    James House, Zemian Deng <[email protected]>
    See Also:
    DailyTimeIntervalScheduleBuilder, Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      TimeOfDay​(int hour, int minute)
      Create a TimeOfDay instance for the given hour and minute (at the zero second of the minute).
      TimeOfDay​(int hour, int minute, int second)
      Create a TimeOfDay instance for the given hour, minute and second.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean before​(TimeOfDay timeOfDay)
      Determine with this time of day is before the given time of day.
      boolean equals​(java.lang.Object obj)  
      int getHour()
      The hour of the day (between 0 and 23).
      int getMinute()
      The minute of the hour.
      int getSecond()
      The second of the minute.
      java.util.Date getTimeOfDayForDate​(java.util.Date dateTime)
      Return a date with time of day reset to this object values.
      int hashCode()  
      static TimeOfDay hourAndMinuteAndSecondFromDate​(java.util.Date dateTime)
      Create a TimeOfDay from the given date, in the system default TimeZone.
      static TimeOfDay hourAndMinuteAndSecondFromDate​(java.util.Date dateTime, java.util.TimeZone tz)
      Create a TimeOfDay from the given date, in the given TimeZone.
      static TimeOfDay hourAndMinuteFromDate​(java.util.Date dateTime)
      Create a TimeOfDay from the given date (at the zero-second), in the system default TimeZone.
      static TimeOfDay hourAndMinuteFromDate​(java.util.Date dateTime, java.util.TimeZone tz)
      Create a TimeOfDay from the given date (at the zero-second), in the system default TimeZone.
      static TimeOfDay hourAndMinuteOfDay​(int hour, int minute)
      Create a TimeOfDay instance for the given hour and minute (at the zero second of the minute).
      static TimeOfDay hourMinuteAndSecondOfDay​(int hour, int minute, int second)
      Create a TimeOfDay instance for the given hour, minute and second.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • TimeOfDay

        public TimeOfDay​(int hour,
                 int minute,
                 int second)
        Create a TimeOfDay instance for the given hour, minute and second.
        Parameters:
        hour - The hour of day, between 0 and 23.
        minute - The minute of the hour, between 0 and 59.
        second - The second of the minute, between 0 and 59.
        Throws:
        java.lang.IllegalArgumentException - if one or more of the input values is out of their valid range.

      • TimeOfDay

        public TimeOfDay​(int hour,
                 int minute)
        Create a TimeOfDay instance for the given hour and minute (at the zero second of the minute).
        Parameters:
        hour - The hour of day, between 0 and 23.
        minute - The minute of the hour, between 0 and 59.
        Throws:
        java.lang.IllegalArgumentException - if one or more of the input values is out of their valid range.

    • Method Detail

      • hourMinuteAndSecondOfDay

        public static TimeOfDay hourMinuteAndSecondOfDay​(int hour,
                                                 int minute,
                                                 int second)
        Create a TimeOfDay instance for the given hour, minute and second.
        Parameters:
        hour - The hour of day, between 0 and 23.
        minute - The minute of the hour, between 0 and 59.
        second - The second of the minute, between 0 and 59.
        Throws:
        java.lang.IllegalArgumentException - if one or more of the input values is out of their valid range.

      • hourAndMinuteOfDay

        public static TimeOfDay hourAndMinuteOfDay​(int hour,
                                           int minute)
        Create a TimeOfDay instance for the given hour and minute (at the zero second of the minute).
        Parameters:
        hour - The hour of day, between 0 and 23.
        minute - The minute of the hour, between 0 and 59.
        Throws:
        java.lang.IllegalArgumentException - if one or more of the input values is out of their valid range.

      • getHour

        public int getHour()
        The hour of the day (between 0 and 23).
        Returns:
        The hour of the day (between 0 and 23).

      • getMinute

        public int getMinute()
        The minute of the hour.
        Returns:
        The minute of the hour (between 0 and 59).

      • getSecond

        public int getSecond()
        The second of the minute.
        Returns:
        The second of the minute (between 0 and 59).

      • before

        public boolean before​(TimeOfDay timeOfDay)
        Determine with this time of day is before the given time of day.
        Returns:
        true this time of day is before the given time of day.

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getTimeOfDayForDate

        public java.util.Date getTimeOfDayForDate​(java.util.Date dateTime)
        Return a date with time of day reset to this object values. The millisecond value will be zero.

      • hourAndMinuteAndSecondFromDate

        public static TimeOfDay hourAndMinuteAndSecondFromDate​(java.util.Date dateTime)
        Create a TimeOfDay from the given date, in the system default TimeZone.
        Parameters:
        dateTime - The java.util.Date from which to extract Hour, Minute and Second.

      • hourAndMinuteAndSecondFromDate

        public static TimeOfDay hourAndMinuteAndSecondFromDate​(java.util.Date dateTime,
                                                       java.util.TimeZone tz)
        Create a TimeOfDay from the given date, in the given TimeZone.
        Parameters:
        dateTime - The java.util.Date from which to extract Hour, Minute and Second.
        tz - The TimeZone from which relate Hour, Minute and Second for the given date. If null, system default TimeZone will be used.

      • hourAndMinuteFromDate

        public static TimeOfDay hourAndMinuteFromDate​(java.util.Date dateTime)
        Create a TimeOfDay from the given date (at the zero-second), in the system default TimeZone.
        Parameters:
        dateTime - The java.util.Date from which to extract Hour and Minute.

      • hourAndMinuteFromDate

        public static TimeOfDay hourAndMinuteFromDate​(java.util.Date dateTime,
                                              java.util.TimeZone tz)
        Create a TimeOfDay from the given date (at the zero-second), in the system default TimeZone.
        Parameters:
        dateTime - The java.util.Date from which to extract Hour and Minute.
        tz - The TimeZone from which relate Hour and Minute for the given date. If null, system default TimeZone will be used.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object