de.ipcon.tools.date

Class TimespanTools

java.lang.Object

de.ipcon.tools.date.TimespanTools

public class TimespanTools
extends java.lang.Object

modern tools class for use with instances implementing IdentifiableTimespanI FIXME to-be remigrated into IdentifiableTimespanI once that is completely translated into Java

Constructor Summary

Constructors

Constructor and Description
TimespanTools()

Method Summary

Modifier and Type	Method and Description
static <T extends IdentifiableTimespanI> java.util.Map<java.lang.Long,T>	getAllValid(java.util.Collection<T> c, java.util.Date d, boolean ignoreTime, boolean doThrow, java.lang.Class<? extends T> onlyOfClass) Returns a Map with all IdentifiableTimespanI-s among the values in the passed Collection that are valid at the passed date.
static <T extends IdentifiableTimespanI> java.util.Map<java.lang.Long,T>	getAllValid(java.util.Map<java.lang.Long,T> m, java.util.Date d, boolean ignoreTime, boolean doThrow, java.lang.Class<? extends T> onlyOfClass) Returns a Map with all IdentifiableTimespanI-s among the values of the passed Map that are valid at the passed date.
static <T extends IdentifiableTimespanI> T	getNewestValid(java.util.Collection<T> c)
static <T extends IdentifiableTimespanI> T	getNewestValid(java.util.Collection<T> c, java.lang.Class<? extends T> onlyOfClass)
static <T extends IdentifiableTimespanI> T	getNewestValidAfter(java.util.Collection<T> c, java.util.Date limit)
static <T extends IdentifiableTimespanI> T	getNewestValidAfter(java.util.Collection<T> c, java.util.Date limit, java.lang.Class<? extends T> onlyOfClass)
static <T extends IdentifiableTimespanI> T	getNewestValidBefore(java.util.Collection<T> c, java.util.Date limit)
static <T extends IdentifiableTimespanI> T	getNewestValidBefore(java.util.Collection<T> c, java.util.Date limit, java.lang.Class<? extends T> onlyOfClass)
static <T extends IdentifiableTimespanI> T	getOldestOrNewestValidBeforeOrAfter(java.util.Collection<T> c, java.util.Date d, java.lang.Class<? extends T> onlyOfClass, boolean returnOldest, boolean before)
static <T extends IdentifiableTimespanI> T	getOldestOrNewestValidBeforeOrAfter(java.util.Collection<T> c, java.util.Date d, java.lang.Class<? extends T> onlyOfClass, boolean returnOldest, boolean before, boolean nullDateIsValid)
static <T extends IdentifiableTimespanI> T	getOldestValid(java.util.Collection<T> c)
static <T extends IdentifiableTimespanI> T	getOldestValid(java.util.Collection<T> c, java.lang.Class<? extends T> onlyOfClass)
static <T extends IdentifiableTimespanI> T	getOldestValidAfter(java.util.Collection<T> c, java.util.Date limit)
static <T extends IdentifiableTimespanI> T	getOldestValidAfter(java.util.Collection<T> c, java.util.Date limit, java.lang.Class<? extends T> onlyOfClass)
static <T extends IdentifiableTimespanI> T	getOldestValidBefore(java.util.Collection<T> c, java.util.Date limit)
static <T extends IdentifiableTimespanI> T	getOldestValidBefore(java.util.Collection<T> c, java.util.Date limit, java.lang.Class<? extends T> onlyOfClass)
static <T extends IdentifiableTimespanI> T	getValid(java.util.Collection<T> c, java.util.Date d)
static <T extends IdentifiableTimespanI> T	getValid(java.util.Collection<T> c, java.util.Date d, boolean ignoreTime)
static <T extends IdentifiableTimespanI> T	getValid(java.util.Collection<T> c, java.util.Date d, boolean ignoreTime, boolean doThrow)
static <T extends IdentifiableTimespanI> T	getValid(java.util.Collection<T> c, java.util.Date d, boolean ignoreTime, boolean doThrow, java.lang.Class<? extends T> onlyOfClass) Returns the IdentifiableTimespanI object from the values in the passed Collection that is valid at the specified date.
static <T extends IdentifiableTimespanI> T	getValid(java.util.Map<java.lang.Long,T> m, java.util.Date d)
static <T extends IdentifiableTimespanI> T	getValid(java.util.Map<java.lang.Long,T> m, java.util.Date d, boolean ignoreTime)
static <T extends IdentifiableTimespanI> T	getValid(java.util.Map<java.lang.Long,T> m, java.util.Date d, boolean ignoreTime, boolean doThrow)
static <T extends IdentifiableTimespanI> T	getValid(java.util.Map<java.lang.Long,T> m, java.util.Date d, boolean ignoreTime, boolean doThrow, java.lang.Class<? extends T> onlyOfClass) Returns the IdentifiableTimespanI object from the values of the passed Map that is valid at the specified date.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimespanTools

public TimespanTools()

Method Detail

getAllValid

public static <T extends IdentifiableTimespanI> java.util.Map<java.lang.Long,T> getAllValid(java.util.Map<java.lang.Long,T> m,
                                                                                            java.util.Date d,
                                                                                            boolean ignoreTime,
                                                                                            boolean doThrow,
                                                                                            java.lang.Class<? extends T> onlyOfClass)

Returns a Map with all IdentifiableTimespanI-s among the values of the passed Map that are valid at the passed date.

getAllValid

public static <T extends IdentifiableTimespanI> java.util.Map<java.lang.Long,T> getAllValid(java.util.Collection<T> c,
                                                                                            java.util.Date d,
                                                                                            boolean ignoreTime,
                                                                                            boolean doThrow,
                                                                                            java.lang.Class<? extends T> onlyOfClass)

Returns a Map with all IdentifiableTimespanI-s among the values in the passed Collection that are valid at the passed date.

getValid

public static <T extends IdentifiableTimespanI> T getValid(java.util.Map<java.lang.Long,T> m,
                                                           java.util.Date d,
                                                           boolean ignoreTime,
                                                           boolean doThrow,
                                                           java.lang.Class<? extends T> onlyOfClass)

Returns the IdentifiableTimespanI object from the values of the passed Map that is valid at the specified date. Throws an IllegalStateException if no or more than one valid IdentifiableTimespanI object is found.

Parameters:

m - The Map containing the values to search through.

d - The Date representing the point in time to check for validity.

ignoreTime - A boolean indicating whether the time component should be ignored when checking validity. Set to 'true' to ignore the time component, 'false' otherwise.

doThrow - A boolean indicating whether an IllegalStateException should be thrown if no or more than one valid IdentifiableTimespanI object is found. Set to 'true' to throw an exception, 'false' to return null instead.

onlyOfClass - The Class object representing the specific subclass of IdentifiableTimespanI. Only objects of this class or its subclasses will be considered for validity.

Returns:

The valid IdentifiableTimespanI object at the specified date, or null if throwException is set to 'false' and no valid object is found.

Throws:

java.lang.IllegalStateException - if throwException is set to 'true' and no or more than one valid IdentifiableTimespanI object is found.

getValid

public static <T extends IdentifiableTimespanI> T getValid(java.util.Map<java.lang.Long,T> m,
                                                           java.util.Date d,
                                                           boolean ignoreTime,
                                                           boolean doThrow)

getValid

public static <T extends IdentifiableTimespanI> T getValid(java.util.Map<java.lang.Long,T> m,
                                                           java.util.Date d,
                                                           boolean ignoreTime)

getValid

public static <T extends IdentifiableTimespanI> T getValid(java.util.Map<java.lang.Long,T> m,
                                                           java.util.Date d)

getValid

public static <T extends IdentifiableTimespanI> T getValid(java.util.Collection<T> c,
                                                           java.util.Date d,
                                                           boolean ignoreTime,
                                                           boolean doThrow,
                                                           java.lang.Class<? extends T> onlyOfClass)

Returns the IdentifiableTimespanI object from the values in the passed Collection that is valid at the specified date. Throws an IllegalStateException if no or more than one valid IdentifiableTimespanI object is found.

Parameters:

c - The Collection containing the objects to search through.

d - The Date representing the point in time to check for validity.

ignoreTime - A boolean indicating whether the time component should be ignored when checking validity. Set to 'true' to ignore the time component, 'false' otherwise.

doThrow - A boolean indicating whether an IllegalStateException should be thrown if no or more than one valid IdentifiableTimespanI object is found. Set to 'true' to throw an exception, 'false' to return null instead.

onlyOfClass - The Class object representing the specific subclass of IdentifiableTimespanI. Only objects of this class or its subclasses will be considered for validity.

Returns:

The valid IdentifiableTimespanI object at the specified date, or null if throwException is set to 'false' and no valid object is found.

Throws:

java.lang.IllegalStateException - if throwException is set to 'true' and no or more than one valid IdentifiableTimespanI object is found.

getValid

public static <T extends IdentifiableTimespanI> T getValid(java.util.Collection<T> c,
                                                           java.util.Date d,
                                                           boolean ignoreTime,
                                                           boolean doThrow)

getValid

public static <T extends IdentifiableTimespanI> T getValid(java.util.Collection<T> c,
                                                           java.util.Date d,
                                                           boolean ignoreTime)

getValid

public static <T extends IdentifiableTimespanI> T getValid(java.util.Collection<T> c,
                                                           java.util.Date d)

getOldestValid

public static <T extends IdentifiableTimespanI> T getOldestValid(java.util.Collection<T> c)

getOldestValid

public static <T extends IdentifiableTimespanI> T getOldestValid(java.util.Collection<T> c,
                                                                 java.lang.Class<? extends T> onlyOfClass)

getNewestValid

public static <T extends IdentifiableTimespanI> T getNewestValid(java.util.Collection<T> c)

getNewestValid

public static <T extends IdentifiableTimespanI> T getNewestValid(java.util.Collection<T> c,
                                                                 java.lang.Class<? extends T> onlyOfClass)

getNewestValidBefore

public static <T extends IdentifiableTimespanI> T getNewestValidBefore(java.util.Collection<T> c,
                                                                       java.util.Date limit)

getNewestValidBefore

public static <T extends IdentifiableTimespanI> T getNewestValidBefore(java.util.Collection<T> c,
                                                                       java.util.Date limit,
                                                                       java.lang.Class<? extends T> onlyOfClass)

Returns:

the newest timespan which has been valid (or still is valid) before or on the given limit

getOldestValidBefore

public static <T extends IdentifiableTimespanI> T getOldestValidBefore(java.util.Collection<T> c,
                                                                       java.util.Date limit)

getOldestValidBefore

public static <T extends IdentifiableTimespanI> T getOldestValidBefore(java.util.Collection<T> c,
                                                                       java.util.Date limit,
                                                                       java.lang.Class<? extends T> onlyOfClass)

Returns:

the oldest timespan which has been valid (or still is valid) before or on the given limit

getNewestValidAfter

public static <T extends IdentifiableTimespanI> T getNewestValidAfter(java.util.Collection<T> c,
                                                                      java.util.Date limit)

getNewestValidAfter

public static <T extends IdentifiableTimespanI> T getNewestValidAfter(java.util.Collection<T> c,
                                                                      java.util.Date limit,
                                                                      java.lang.Class<? extends T> onlyOfClass)

Returns:

the newest timespan which will be valid (or already is valid) after or on the given limit

getOldestValidAfter

public static <T extends IdentifiableTimespanI> T getOldestValidAfter(java.util.Collection<T> c,
                                                                      java.util.Date limit)

getOldestValidAfter

public static <T extends IdentifiableTimespanI> T getOldestValidAfter(java.util.Collection<T> c,
                                                                      java.util.Date limit,
                                                                      java.lang.Class<? extends T> onlyOfClass)

Returns:

the oldest timespan which will be valid (or already is valid) after or on the given limit

getOldestOrNewestValidBeforeOrAfter

public static <T extends IdentifiableTimespanI> T getOldestOrNewestValidBeforeOrAfter(java.util.Collection<T> c,
                                                                                      java.util.Date d,
                                                                                      java.lang.Class<? extends T> onlyOfClass,
                                                                                      boolean returnOldest,
                                                                                      boolean before)

getOldestOrNewestValidBeforeOrAfter

public static <T extends IdentifiableTimespanI> T getOldestOrNewestValidBeforeOrAfter(java.util.Collection<T> c,
                                                                                      java.util.Date d,
                                                                                      java.lang.Class<? extends T> onlyOfClass,
                                                                                      boolean returnOldest,
                                                                                      boolean before,
                                                                                      boolean nullDateIsValid)

Parameters:

before - if true, will check if a timespan has started before or at the given date. if false, will check if a timespan has ended after or at the given date

returnOldest - if true, return the oldest timespan before or after the given date if false return the newest timespan before or after the given date

Returns:

depending on the given arguments, return the oldest or newest valid timespan, either (at the given date,) before or after the given date