com.codelanx.codelanxlib.util

Class TimeUtil.TimePoint

java.lang.Object

com.codelanx.codelanxlib.util.TimeUtil.TimePoint

All Implemented Interfaces:

Comparable<TimeUtil.TimePoint>

Enclosing class:

TimeUtil

public static class TimeUtil.TimePoint
extends Object
implements Comparable<TimeUtil.TimePoint>

Constructor Summary

Constructors

Constructor and Description
TimePoint(long time, TimeUnit unit, TimeUtil.TimePoint next)

Method Summary

Modifier and Type	Method and Description
int	compareTo(TimeUtil.TimePoint o)
static TimeUtil.TimePoint	findClosestAndWipe(TreeSet<? extends TimeUtil.TimePoint> points, TimeUtil.TimePoint now) This is a helper method to find the closest TimeUtil.TimePoint in a collection that is still of a greater value than the passed TimeUtil.TimePoint.
String	format()
String	format(TimeUnit min)
long	getAmount(TimeUnit unit)
TimeUtil.TimePoint	getNext()
TimeUtil.TimePoint	getNextNonZero()
TimeUtil.TimePoint	getPoint(TimeUnit unit)
long	getTime()
TimeUnit	getUnit()
String	properName()
TimeUtil.TimePoint	setNext(TimeUtil.TimePoint next)

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,
                 TimeUtil.TimePoint next)

Method Detail

getAmount

public long getAmount(TimeUnit unit)

getPoint

public TimeUtil.TimePoint getPoint(TimeUnit unit)

getTime

public long getTime()

getUnit

public TimeUnit getUnit()

getNext

public TimeUtil.TimePoint getNext()

getNextNonZero

public TimeUtil.TimePoint getNextNonZero()

setNext

public TimeUtil.TimePoint setNext(TimeUtil.TimePoint next)

properName

public String properName()

format

public String format(TimeUnit min)

format

public String format()

compareTo

public int compareTo(TimeUtil.TimePoint o)

Specified by:

compareTo in interface Comparable<TimeUtil.TimePoint>

findClosestAndWipe

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

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

Parameters:

points - The TimeUtil.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