Package org.jfree.data.time
Class Second
- java.lang.Object
-
- org.jfree.data.time.RegularTimePeriod
-
- org.jfree.data.time.Second
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable
,MonthConstants
,TimePeriod
public class Second extends RegularTimePeriod implements java.io.Serializable
Represents a second in a particular day. This class is immutable, which is a requirement for allRegularTimePeriod
subclasses.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private Day
day
The day.static int
FIRST_SECOND_IN_MINUTE
Useful constant for the first second in a minute.private long
firstMillisecond
The first millisecond.private byte
hour
The hour of the day.static int
LAST_SECOND_IN_MINUTE
Useful constant for the last second in a minute.private byte
minute
The minute.private byte
second
The second.private static long
serialVersionUID
For serialization.
-
Constructor Summary
Constructors Constructor Description Second()
Constructs a new Second, based on the system date/time.Second(int second, int minute, int hour, int day, int month, int year)
Creates a new second.Second(int second, Minute minute)
Constructs a new Second.Second(java.util.Date time)
Constructs a new instance from the specified date/time.Second(java.util.Date time, java.util.Calendar calendar)
Constructs a new instance, based on a particular date/time.Second(java.util.Date time, java.util.TimeZone zone, java.util.Locale locale)
Creates a new second based on the supplied time and time zone.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(java.lang.Object o1)
Returns an integer indicating the order of this Second object relative to the specified object: negative == before, zero == same, positive == after.boolean
equals(java.lang.Object obj)
Tests the equality of this object against an arbitrary Object.long
getFirstMillisecond()
Returns the first millisecond of the second.long
getFirstMillisecond(java.util.Calendar calendar)
Returns the first millisecond of the minute.long
getLastMillisecond()
Returns the last millisecond of the second.long
getLastMillisecond(java.util.Calendar calendar)
Returns the last millisecond of the second.Minute
getMinute()
Returns the minute.int
getSecond()
Returns the second within the minute.long
getSerialIndex()
Returns a serial index number for the minute.int
hashCode()
Returns a hash code for this object instance.RegularTimePeriod
next()
Returns the second following this one.static Second
parseSecond(java.lang.String s)
Creates a new instance by parsing a string.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).RegularTimePeriod
previous()
Returns the second preceding this one.-
Methods inherited from class org.jfree.data.time.RegularTimePeriod
createInstance, downsize, getCalendarInstance, getEnd, getMiddleMillisecond, getMiddleMillisecond, getMillisecond, getStart, setCalendarInstancePrototype, setThreadLocalCalendarInstance, toString
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
For serialization.- See Also:
- Constant Field Values
-
FIRST_SECOND_IN_MINUTE
public static final int FIRST_SECOND_IN_MINUTE
Useful constant for the first second in a minute.- See Also:
- Constant Field Values
-
LAST_SECOND_IN_MINUTE
public static final int LAST_SECOND_IN_MINUTE
Useful constant for the last second in a minute.- See Also:
- Constant Field Values
-
day
private Day day
The day.
-
hour
private byte hour
The hour of the day.
-
minute
private byte minute
The minute.
-
second
private byte second
The second.
-
firstMillisecond
private long firstMillisecond
The first millisecond. We don't store the last millisecond, because it is always firstMillisecond + 999L.
-
-
Constructor Detail
-
Second
public Second()
Constructs a new Second, based on the system date/time. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
.
-
Second
public Second(int second, Minute minute)
Constructs a new Second. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
.- Parameters:
second
- the second (0 to 59).minute
- the minute (null
not permitted).
-
Second
public Second(int second, int minute, int hour, int day, int month, int year)
Creates a new second. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
.- Parameters:
second
- the second (0-59).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).
-
Second
public Second(java.util.Date time)
Constructs a new instance from the specified date/time. The time zone and locale are determined by the calendar returned byRegularTimePeriod.getCalendarInstance()
.- Parameters:
time
- the time (null
not permitted).- See Also:
Second(Date, TimeZone, Locale)
-
Second
public Second(java.util.Date time, java.util.TimeZone zone, java.util.Locale locale)
Creates a new second based on the supplied time and time zone.- Parameters:
time
- the time (null
not permitted).zone
- the time zone (null
not permitted).locale
- the locale (null
not permitted).
-
Second
public Second(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 thecalendar
parameter.- Parameters:
time
- the date/time (null
not permitted).calendar
- the calendar to use for calculations (null
not permitted).
-
-
Method Detail
-
getSecond
public int getSecond()
Returns the second within the minute.- Returns:
- The second (0 - 59).
-
getMinute
public Minute getMinute()
Returns the minute.- Returns:
- The minute (never
null
).
-
getFirstMillisecond
public long getFirstMillisecond()
Returns the first millisecond of the second. 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 thepeg(Calendar)
method.- Specified by:
getFirstMillisecond
in classRegularTimePeriod
- Returns:
- The first millisecond of the second.
- See Also:
getLastMillisecond()
-
getLastMillisecond
public long getLastMillisecond()
Returns the last millisecond of the second. 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 thepeg(Calendar)
method.- Specified by:
getLastMillisecond
in classRegularTimePeriod
- Returns:
- The last millisecond of the second.
- 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 classRegularTimePeriod
- Parameters:
calendar
- the calendar (null
not permitted).
-
previous
public RegularTimePeriod previous()
Returns the second preceding this one. No matter what time zone and locale this instance was created with, the returned instance will use the default calendar for time calculations, obtained withRegularTimePeriod.getCalendarInstance()
.- Specified by:
previous
in classRegularTimePeriod
- Returns:
- The second preceding this one.
-
next
public RegularTimePeriod next()
Returns the second following this one. No matter what time zone and locale this instance was created with, the returned instance will use the default calendar for time calculations, obtained withRegularTimePeriod.getCalendarInstance()
.- Specified by:
next
in classRegularTimePeriod
- Returns:
- The second following this one.
-
getSerialIndex
public long getSerialIndex()
Returns a serial index number for the minute.- Specified by:
getSerialIndex
in classRegularTimePeriod
- Returns:
- The serial index number.
-
getFirstMillisecond
public long getFirstMillisecond(java.util.Calendar calendar)
Returns the first millisecond of the minute.- Specified by:
getFirstMillisecond
in classRegularTimePeriod
- Parameters:
calendar
- the calendar/timezone (null
not permitted).- Returns:
- The first millisecond.
- Throws:
java.lang.NullPointerException
- ifcalendar
isnull
.- See Also:
RegularTimePeriod.getLastMillisecond(Calendar)
-
getLastMillisecond
public long getLastMillisecond(java.util.Calendar calendar)
Returns the last millisecond of the second.- Specified by:
getLastMillisecond
in classRegularTimePeriod
- Parameters:
calendar
- the calendar/timezone (null
not permitted).- Returns:
- The last millisecond.
- Throws:
java.lang.NullPointerException
- ifcalendar
isnull
.- 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 Second object representing the same second as this instance.
- Overrides:
equals
in classjava.lang.Object
- Parameters:
obj
- the object to compare (null
permitted).- Returns:
true
if second and minute 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 classjava.lang.Object
- Returns:
- A hash code.
-
compareTo
public int compareTo(java.lang.Object o1)
Returns an integer indicating the order of this Second object relative to the specified object: negative == before, zero == same, positive == after.- Specified by:
compareTo
in interfacejava.lang.Comparable
- Parameters:
o1
- the object to compare.- Returns:
- negative == before, zero == same, positive == after.
-
parseSecond
public static Second parseSecond(java.lang.String s)
Creates a new instance by parsing a string. The string is assumed to be in the format "YYYY-MM-DD HH:MM:SS", perhaps with leading or trailing whitespace.- Parameters:
s
- the string to parse.- Returns:
- The second, or
null
if the string is not parseable.
-
-