com.codelanx.codelanxlib.util.time

Class TimePoint

java.lang.Object

com.codelanx.codelanxlib.util.time.TimePoint

All Implemented Interfaces:

Comparable<TimePoint>

public class TimePoint
extends Object
implements Comparable<TimePoint>

Represents a relative, specific amount of time

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Constructor Summary

Constructors

Constructor and Description
TimePoint(long time, TimeUnit unit, TimePoint next) Constructs a new TimePoint

Method Summary

Modifier and Type	Method and Description
int	compareTo(TimePoint o)
static TimePoint	findClosestAndWipe(TreeSet<? extends TimePoint> points, TimePoint now) This is a helper method to find the closest TimePoint in a collection that is still of a greater value than the passed TimePoint.
String	format() Returns a formatted string with a minimum unit of TimeUnit.NANOSECONDS
String	format(TimeUnit min) Formats the current TimePoint to be human-readable, specifying either one or two units of measure depending on what is available
long	getAmount(TimeUnit unit) Returns the relevant measure for the specified unit of time
TimePoint	getNext() Returns the next TimePoint for this measure of time.
TimePoint	getNextNonZero() Returns the next non-zero TimePoint that can be found, or null if there are no proceeding points of measure that are non-null and non-zero
TimePoint	getPoint(TimeUnit unit) Returns the specific TimePoint for the passed TimeUnit
long	getTime() Returns the magnitude (or measure) of the current unit for this point
static TimePoint	getTimePoint(long diff) Absolutely disgusting method of retrieving the largest non-zero times difference in a nanosecond period.
TimeUnit	getUnit() Returns the relevant TimeUnit for the measure in this point
String	properName() Returns the proper name for the current unit relevant to this point

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimePoint

public TimePoint(long time,
                 TimeUnit unit,
                 TimePoint next)

Constructs a new TimePoint

Parameters:

time - The magnitude or measure of time

unit - The TimeUnit representing the unit of time

next - The next TimePoint in this chain

Since:

0.0.1

Method Detail

getAmount

public long getAmount(TimeUnit unit)

Returns the relevant measure for the specified unit of time

Parameters:

unit - The TimeUnit of time to look for

Returns:

The amount of the specific unit of time in this TimePoint

Since:

0.0.1

getPoint

public TimePoint getPoint(TimeUnit unit)

Returns the specific TimePoint for the passed TimeUnit

Parameters:

unit - The TimeUnit of time to look for

Returns:

The specific TimePoint representing the amount of the specific unit

Since:

0.0.1

getTime

public long getTime()

Returns the magnitude (or measure) of the current unit for this point

Returns:

The amount of the current TimeUnit

Since:

0.0.1

getUnit

public TimeUnit getUnit()

Returns the relevant TimeUnit for the measure in this point

Returns:

The relevant TimeUnit to this current measure

Since:

0.0.1

getNext

public TimePoint getNext()

Returns the next TimePoint for this measure of time. For instance, if the current TimePoint is a measure of minutes, then the proceeding point will be a measure of seconds

Returns:

The next TimePoint in this chain

Since:

0.0.1

getNextNonZero

public TimePoint getNextNonZero()

Returns the next non-zero TimePoint that can be found, or null if there are no proceeding points of measure that are non-null and non-zero

Returns:

The next TimePoint that is not zero, or null

Since:

0.1.0

properName

public String properName()

Returns the proper name for the current unit relevant to this point

Returns:

The proper name for the TimeUnit in use

Since:

0.0.1

format

public String format(TimeUnit min)

Formats the current TimePoint to be human-readable, specifying either one or two units of measure depending on what is available

Parameters:

min - The minimum TimeUnit to output

Returns:

The formatted string

Since:

0.0.1

format

public String format()

Returns a formatted string with a minimum unit of TimeUnit.NANOSECONDS

Returns:

The formatted string

Since:

0.0.1

See Also:

format(TimeUnit)

compareTo

public int compareTo(TimePoint o)

Specified by:

compareTo in interface Comparable<TimePoint>

Parameters:

o -

Returns:

Since:

0.1.0

findClosestAndWipe

public static TimePoint findClosestAndWipe(TreeSet<? extends TimePoint> points,
                                           TimePoint now)

This is a helper method to find the closest TimePoint in a collection that is still of a greater value than the passed TimePoint. This method also truncates the passed collection and will modify its contents! However, if no values are found this method will return null.

Parameters:

points - The TimePoint objects to look through. Should be a sorted collection

now - The point of reference (ha!)

Returns:

The closest matching point

Since:

0.1.0

getTimePoint

public static TimePoint getTimePoint(long diff)

Absolutely disgusting method of retrieving the largest non-zero times difference in a nanosecond period. Forgive me for my sins

Parameters:

diff - The difference in nanoseconds between two points

Returns:

A new TimePoint representing the largest represented time

Since:

0.0.1