Class Hour

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable, TimePeriod, org.jfree.date.MonthConstants

    public class Hour
    extends RegularTimePeriod
    implements java.io.Serializable
    Represents an hour in a specific day. This class is immutable, which is a requirement for all RegularTimePeriod subclasses.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FIRST_HOUR_IN_DAY
      Useful constant for the first hour in the day.
      static int LAST_HOUR_IN_DAY
      Useful constant for the last hour in the day.
      • Fields inherited from interface org.jfree.date.MonthConstants

        APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER
    • Constructor Summary

      Constructors 
      Constructor Description
      Hour()
      Constructs a new Hour, based on the system date/time.
      Hour​(int hour, int day, int month, int year)
      Creates a new hour.
      Hour​(int hour, Day day)
      Constructs a new Hour.
      Hour​(java.util.Date time)
      Constructs a new instance, based on the supplied date/time and the default time zone.
      Hour​(java.util.Date time, java.util.TimeZone zone)
      Deprecated.
      As of 1.0.13, use the constructor that specifies the locale also.
      Hour​(java.util.Date time, java.util.TimeZone zone, java.util.Locale locale)
      Constructs a new instance, based on the supplied date/time evaluated in the specified time zone.
    • Constructor Detail

      • Hour

        public Hour()
        Constructs a new Hour, based on the system date/time.
      • Hour

        public Hour​(int hour,
                    Day day)
        Constructs a new Hour.
        Parameters:
        hour - the hour (in the range 0 to 23).
        day - the day (null not permitted).
      • Hour

        public Hour​(int hour,
                    int day,
                    int month,
                    int year)
        Creates a new hour.
        Parameters:
        hour - the hour (0-23).
        day - the day (1-31).
        month - the month (1-12).
        year - the year (1900-9999).
      • Hour

        public Hour​(java.util.Date time)
        Constructs a new instance, based on the supplied date/time and the default time zone.
        Parameters:
        time - the date-time (null not permitted).
        See Also:
        Hour(Date, TimeZone)
      • Hour

        public Hour​(java.util.Date time,
                    java.util.TimeZone zone)
        Deprecated.
        As of 1.0.13, use the constructor that specifies the locale also.
        Constructs a new instance, based on the supplied date/time evaluated in the specified time zone.
        Parameters:
        time - the date-time (null not permitted).
        zone - the time zone (null not permitted).
      • Hour

        public Hour​(java.util.Date time,
                    java.util.TimeZone zone,
                    java.util.Locale locale)
        Constructs a new instance, based on the supplied date/time evaluated in the specified time zone.
        Parameters:
        time - the date-time (null not permitted).
        zone - the time zone (null not permitted).
        locale - the locale (null not permitted).
        Since:
        1.0.13
    • Method Detail

      • getHour

        public int getHour()
        Returns the hour.
        Returns:
        The hour (0 <= hour <= 23).
      • getDay

        public Day getDay()
        Returns the day in which this hour falls.
        Returns:
        The day.
      • getYear

        public int getYear()
        Returns the year in which this hour falls.
        Returns:
        The year.
      • getMonth

        public int getMonth()
        Returns the month in which this hour falls.
        Returns:
        The month.
      • getDayOfMonth

        public int getDayOfMonth()
        Returns the day-of-the-month in which this hour falls.
        Returns:
        The day-of-the-month.
      • 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).
        Since:
        1.0.3
      • 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 an Hour object representing the same hour as this instance.

        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object to compare (null permitted).
        Returns:
        true if the hour and day value of the object is the same as this.
      • toString

        public java.lang.String toString()
        Returns a string representation of this instance, for debugging purposes.
        Overrides:
        toString in class RegularTimePeriod
        Returns:
        A string.
      • 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 Hour 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.
      • parseHour

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