public class

Millisecond

extends RegularTimePeriod
implements Serializable
java.lang.Object
   ↳ org.jfree.data.time.RegularTimePeriod
     ↳ org.jfree.data.time.Millisecond

Class Overview

Represents a millisecond. This class is immutable, which is a requirement for all RegularTimePeriod subclasses.

Summary

Constants
int FIRST_MILLISECOND_IN_SECOND A constant for the first millisecond in a second.
int LAST_MILLISECOND_IN_SECOND A constant for the last millisecond in a second.
[Expand]
Inherited Fields
From class org.jfree.data.time.RegularTimePeriod
Public Constructors
Millisecond()
Constructs a millisecond based on the current system time.
Millisecond(int millisecond, Second second)
Constructs a millisecond.
Millisecond(int millisecond, int second, int minute, int hour, int day, int month, int year)
Creates a new millisecond.
Millisecond(Date time)
Constructs a new millisecond using the default time zone.
Millisecond(Date time, TimeZone zone)
This constructor is deprecated. As of 1.0.13, use the constructor that specifies the locale also.
Millisecond(Date time, TimeZone zone, Locale locale)
Creates a millisecond.
Public Methods
int compareTo(Object obj)
Returns an integer indicating the order of this Millisecond object relative to the specified object: negative == before, zero == same, positive == after.
boolean equals(Object obj)
Tests the equality of this object against an arbitrary Object.
long getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the time period.
long getFirstMillisecond()
Returns the first millisecond of the second.
long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the time period.
long getLastMillisecond()
Returns the last millisecond of the second.
long getMillisecond()
Returns the millisecond.
Second getSecond()
Returns the second.
long getSerialIndex()
Returns a serial index number for the millisecond.
int hashCode()
Returns a hash code for this object instance.
RegularTimePeriod next()
Returns the millisecond following this one.
void peg(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 millisecond preceding this one.
[Expand]
Inherited Methods
From class org.jfree.data.time.RegularTimePeriod
From class java.lang.Object
From interface java.lang.Comparable
From interface org.jfree.data.time.TimePeriod

Constants

public static final int FIRST_MILLISECOND_IN_SECOND

A constant for the first millisecond in a second.

Constant Value: 0 (0x00000000)

public static final int LAST_MILLISECOND_IN_SECOND

A constant for the last millisecond in a second.

Constant Value: 999 (0x000003e7)

Public Constructors

public Millisecond ()

Constructs a millisecond based on the current system time.

public Millisecond (int millisecond, Second second)

Constructs a millisecond.

Parameters
millisecond the millisecond (0-999).
second the second.

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).

public Millisecond (Date time)

Constructs a new millisecond using the default time zone.

Parameters
time the time.
See Also

public Millisecond (Date time, TimeZone zone)

This constructor is 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.

public Millisecond (Date time, TimeZone zone, Locale locale)

Creates a millisecond.

Parameters
time the date-time (null not permitted).
zone the time zone (null not permitted).
locale the locale (null not permitted).

Public Methods

public int compareTo (Object obj)

Returns an integer indicating the order of this Millisecond object relative to the specified object: negative == before, zero == same, positive == after.

Parameters
obj the object to compare
Returns
  • negative == before, zero == same, positive == after.

public boolean equals (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.

Parameters
obj the object to compare
Returns
  • true if milliseconds and seconds of this and object are the same.

public long getFirstMillisecond (Calendar calendar)

Returns the first millisecond of the time period.

Parameters
calendar the calendar (null not permitted).
Returns
  • The first millisecond of the time period.
Throws
NullPointerException if calendar is null.

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 the peg(Calendar) method.

Returns
  • The first millisecond of the second.
See Also

public long getLastMillisecond (Calendar calendar)

Returns the last millisecond of the time period.

Parameters
calendar the calendar (null not permitted).
Returns
  • The last millisecond of the time period.
Throws
NullPointerException if calendar is null.

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 the peg(Calendar) method.

Returns
  • The last millisecond of the second.
See Also

public long getMillisecond ()

Returns the millisecond.

Returns
  • The millisecond.

public Second getSecond ()

Returns the second.

Returns
  • The second.

public long getSerialIndex ()

Returns a serial index number for the millisecond.

Returns
  • The serial index number.

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

Returns
  • A hashcode.

public RegularTimePeriod next ()

Returns the millisecond following this one.

Returns
  • The millisecond following this one.

public void peg (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).

Parameters
calendar the calendar (null not permitted).

public RegularTimePeriod previous ()

Returns the millisecond preceding this one.

Returns
  • The millisecond preceding this one.