Package org.jfree.data.time
Class Millisecond
- java.lang.Object
-
- org.jfree.data.time.RegularTimePeriod
-
- org.jfree.data.time.Millisecond
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable,TimePeriod,org.jfree.date.MonthConstants
public class Millisecond extends RegularTimePeriod implements java.io.Serializable
Represents a millisecond. This class is immutable, which is a requirement for allRegularTimePeriodsubclasses.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static intFIRST_MILLISECOND_IN_SECONDA constant for the first millisecond in a second.static intLAST_MILLISECOND_IN_SECONDA constant for the last millisecond in a second.-
Fields inherited from class org.jfree.data.time.RegularTimePeriod
DEFAULT_TIME_ZONE, WORKING_CALENDAR
-
-
Constructor Summary
Constructors Constructor Description Millisecond()Constructs a millisecond based on the current system time.Millisecond(int millisecond, int second, int minute, int hour, int day, int month, int year)Creates a new millisecond.Millisecond(int millisecond, Second second)Constructs a millisecond.Millisecond(java.util.Date time)Constructs a new millisecond using the default time zone.Millisecond(java.util.Date time, java.util.TimeZone zone)Deprecated.As of 1.0.13, use the constructor that specifies the locale also.Millisecond(java.util.Date time, java.util.TimeZone zone, java.util.Locale locale)Creates a millisecond.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intcompareTo(java.lang.Object obj)Returns an integer indicating the order of this Millisecond object relative to the specified object: negative == before, zero == same, positive == after.booleanequals(java.lang.Object obj)Tests the equality of this object against an arbitrary Object.longgetFirstMillisecond()Returns the first millisecond of the second.longgetFirstMillisecond(java.util.Calendar calendar)Returns the first millisecond of the time period.longgetLastMillisecond()Returns the last millisecond of the second.longgetLastMillisecond(java.util.Calendar calendar)Returns the last millisecond of the time period.longgetMillisecond()Returns the millisecond.SecondgetSecond()Returns the second.longgetSerialIndex()Returns a serial index number for the millisecond.inthashCode()Returns a hash code for this object instance.RegularTimePeriodnext()Returns the millisecond following this one.voidpeg(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).RegularTimePeriodprevious()Returns the millisecond preceding this one.-
Methods inherited from class org.jfree.data.time.RegularTimePeriod
createInstance, downsize, getEnd, getFirstMillisecond, getLastMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMillisecond, getStart, toString
-
-
-
-
Field Detail
-
FIRST_MILLISECOND_IN_SECOND
public static final int FIRST_MILLISECOND_IN_SECOND
A constant for the first millisecond in a second.- See Also:
- Constant Field Values
-
LAST_MILLISECOND_IN_SECOND
public static final int LAST_MILLISECOND_IN_SECOND
A constant for the last millisecond in a second.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Millisecond
public Millisecond()
Constructs a millisecond based on the current system time.
-
Millisecond
public Millisecond(int millisecond, Second second)
Constructs a millisecond.- Parameters:
millisecond- the millisecond (0-999).second- the second.
-
Millisecond
public Millisecond(int millisecond, int second, int minute, int hour, int day, int month, int year)
Creates a new millisecond.- Parameters:
millisecond- the millisecond (0-999).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).
-
Millisecond
public Millisecond(java.util.Date time)
Constructs a new millisecond using the default time zone.- Parameters:
time- the time.- See Also:
Millisecond(Date, TimeZone)
-
Millisecond
public Millisecond(java.util.Date time, java.util.TimeZone zone)
Deprecated.As of 1.0.13, use the constructor that specifies the locale also.Creates a millisecond.- Parameters:
time- the instant in time.zone- the time zone.
-
Millisecond
public Millisecond(java.util.Date time, java.util.TimeZone zone, java.util.Locale locale)
Creates a millisecond.- Parameters:
time- the date-time (nullnot permitted).zone- the time zone (nullnot permitted).locale- the locale (nullnot permitted).- Since:
- 1.0.13
-
-
Method Detail
-
getMillisecond
public long getMillisecond()
Returns the millisecond.- Returns:
- The millisecond.
-
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:
getFirstMillisecondin 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:
getLastMillisecondin 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:
pegin classRegularTimePeriod- Parameters:
calendar- the calendar (nullnot permitted).- Since:
- 1.0.3
-
previous
public RegularTimePeriod previous()
Returns the millisecond preceding this one.- Specified by:
previousin classRegularTimePeriod- Returns:
- The millisecond preceding this one.
-
next
public RegularTimePeriod next()
Returns the millisecond following this one.- Specified by:
nextin classRegularTimePeriod- Returns:
- The millisecond following this one.
-
getSerialIndex
public long getSerialIndex()
Returns a serial index number for the millisecond.- Specified by:
getSerialIndexin classRegularTimePeriod- Returns:
- The serial index number.
-
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 Millisecond object representing the same millisecond as this instance.
- Overrides:
equalsin classjava.lang.Object- Parameters:
obj- the object to compare- Returns:
trueif milliseconds and seconds of this and 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:
hashCodein classjava.lang.Object- Returns:
- A hashcode.
-
compareTo
public int compareTo(java.lang.Object obj)
Returns an integer indicating the order of this Millisecond object relative to the specified object: negative == before, zero == same, positive == after.- Specified by:
compareToin interfacejava.lang.Comparable- Parameters:
obj- the object to compare- Returns:
- negative == before, zero == same, positive == after.
-
getFirstMillisecond
public long getFirstMillisecond(java.util.Calendar calendar)
Returns the first millisecond of the time period.- Specified by:
getFirstMillisecondin classRegularTimePeriod- Parameters:
calendar- the calendar (nullnot permitted).- Returns:
- The first millisecond of the time period.
- Throws:
java.lang.NullPointerException- ifcalendarisnull.- See Also:
RegularTimePeriod.getLastMillisecond(Calendar)
-
getLastMillisecond
public long getLastMillisecond(java.util.Calendar calendar)
Returns the last millisecond of the time period.- Specified by:
getLastMillisecondin classRegularTimePeriod- Parameters:
calendar- the calendar (nullnot permitted).- Returns:
- The last millisecond of the time period.
- Throws:
java.lang.NullPointerException- ifcalendarisnull.- See Also:
RegularTimePeriod.getFirstMillisecond(Calendar)
-
-