de.ipcon.tools.date

Interface IdentifiableTimespanI

All Superinterfaces:

SettableTimespanI, TimespanI

All Known Subinterfaces:

StartableAndStoppableTimespanI

public interface IdentifiableTimespanI
extends SettableTimespanI

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	$0

Fields inherited from interface de.ipcon.tools.date.SettableTimespanI

log

Fields inherited from interface de.ipcon.tools.date.TimespanI

L10N_KEY_ERR_INCONSISTENT_DATES, L10N_KEY_ERR_INDET_NUMBER_OVERLAPPING, L10N_KEY_ERR_UNWANTED_OPEN_TIMESPAN

Method Summary

Modifier and Type	Method and Description
java.lang.String	conciseDesc()
java.lang.String	describe()
java.lang.String	describe(java.lang.String pattern)
static java.util.Map	getAllOverlapping(java.util.Collection col) Returns a Map containing all IdentifiableTimespanI objects and their Ids from the given collection, whose time periods overlap either fully or partially with each other.
static java.util.Map	getAllOverlapping(java.util.Collection col, boolean sameDayOverlaps) Returns a Map containing all IdentifiableTimespanI objects and their Ids from the given collection, whose time periods overlap either fully or partially with each other.
static java.util.Map	getAllOverlapping(java.util.Collection col, java.lang.Class onlyOfClass)
static java.util.Map	getAllOverlapping(java.util.Collection col, java.lang.Class onlyOfClass, boolean sameDayOverlaps)
static java.util.Map	getAllOverlappingWith(IdentifiableTimespanI candidate, java.util.Collection col) Returns a Map containing all IdentifiableTimespanI objects and their Ids from the given collection, whose time periods overlap either fully or partially with the provided candidate.
static java.util.Map	getAllOverlappingWith(IdentifiableTimespanI candidate, java.util.Collection col, boolean sameDayOverlaps) Returns a Map containing all IdentifiableTimespanI objects and their Ids from the given collection, whose time periods overlap either fully or partially with the provided candidate.
static java.util.Map	getAllOverlappingWith(IdentifiableTimespanI candidate, java.util.Collection col, java.lang.Class<? extends IdentifiableTimespanI> onlyOfClass)
static java.util.Map	getAllOverlappingWith(IdentifiableTimespanI candidate, java.util.Collection col, java.lang.Class<? extends IdentifiableTimespanI> onlyOfClass, boolean sameDayOverlaps)
static java.util.Map	getAllPartiallyValidDuring(java.util.Collection c, java.util.Date from, java.util.Date upto) Returns a Map with all IdentifiableTimespanI-s among the values of the passed Collection that are at least partially valid between the passed from and upto (ignoring time).
static java.util.Map	getAllPartiallyValidDuring(java.util.Collection c, java.util.Date from, java.util.Date upto, boolean $throw)
static java.util.Map	getAllPartiallyValidDuring(java.util.Collection c, java.util.Date from, java.util.Date upto, boolean $throw, java.lang.Class onlyOfClass)
static java.util.Map	getAllPartiallyValidDuring(java.util.Collection c, TimespanI during) Returns a Map with all IdentifiableTimespanI-s among the values of the passed Collection that are at least partially valid during the passed TimespanI (ignoring time).
static java.util.Map	getAllPartiallyValidDuring(java.util.Collection c, TimespanI during, boolean $throw)
static java.util.Map	getAllPartiallyValidDuring(java.util.Collection c, TimespanI during, boolean $throw, java.lang.Class onlyOfClass)
static java.util.Map	getAllPartiallyValidDuring(java.util.Map m, java.util.Date from, java.util.Date upto) Returns a Map with all IdentifiableTimespanI-s among the values of the passed Map that are at least partially valid between the passed from and upto (ignoring time).
static java.util.Map	getAllPartiallyValidDuring(java.util.Map m, java.util.Date from, java.util.Date upto, boolean $throw)
static java.util.Map	getAllPartiallyValidDuring(java.util.Map m, java.util.Date from, java.util.Date upto, boolean $throw, java.lang.Class onlyOfClass)
static java.util.Map	getAllPartiallyValidDuring(java.util.Map m, TimespanI during) Returns a Map with all IdentifiableTimespanI-s among the values of the passed Map that are at least partially valid during the passed TimespanI (ignoring time).
static java.util.Map	getAllPartiallyValidDuring(java.util.Map m, TimespanI during, boolean $throw)
static java.util.Map	getAllPartiallyValidDuring(java.util.Map m, TimespanI during, boolean $throw, java.lang.Class onlyOfClass)
static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI>	getAllValid(java.util.Collection<? extends IdentifiableTimespanI> c, java.util.Date d) Returns a Map with all IdentifiableTimespanI-s among the values in the passed Collection that are valid at the passed date.
static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI>	getAllValid(java.util.Collection<? extends IdentifiableTimespanI> c, java.util.Date d, boolean ignoreTime)
static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI>	getAllValid(java.util.Collection<? extends IdentifiableTimespanI> c, java.util.Date d, boolean ignoreTime, boolean $throw)
static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI>	getAllValid(java.util.Collection<? extends IdentifiableTimespanI> c, java.util.Date d, boolean ignoreTime, boolean $throw, java.lang.Class<? extends IdentifiableTimespanI> onlyOfClass)
static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI>	getAllValid(java.util.Map<java.lang.Long,? extends IdentifiableTimespanI> m, java.util.Date d) Returns a Map with all IdentifiableTimespanI-s among the values of the passed Map that are valid at the passed date.
static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI>	getAllValid(java.util.Map<java.lang.Long,? extends IdentifiableTimespanI> m, java.util.Date d, boolean ignoreTime)
static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI>	getAllValid(java.util.Map<java.lang.Long,? extends IdentifiableTimespanI> m, java.util.Date d, boolean ignoreTime, boolean $throw)
static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI>	getAllValid(java.util.Map<java.lang.Long,? extends IdentifiableTimespanI> m, java.util.Date d, boolean ignoreTime, boolean $throw, java.lang.Class onlyOfClass)
static java.util.Map	getAllValidDuring(java.util.Collection c, java.util.Date from, java.util.Date upto) Returns a Map with all IdentifiableTimespanI-s among the values in the passed Collection that are valid during the passed TimespanI (ignoring time).
static java.util.Map	getAllValidDuring(java.util.Collection c, java.util.Date from, java.util.Date upto, boolean mustBeCompletelyValid)
static java.util.Map	getAllValidDuring(java.util.Collection c, java.util.Date from, java.util.Date upto, boolean mustBeCompletelyValid, boolean $throw)
static java.util.Map	getAllValidDuring(java.util.Collection c, java.util.Date from, java.util.Date upto, boolean mustBeCompletelyValid, boolean $throw, java.lang.Class<? extends IdentifiableTimespanI> onlyOfClass)
static java.util.Map	getAllValidDuring(java.util.Map m, java.util.Date from, java.util.Date upto) Returns a Map with all IdentifiableTimespanI-s among the values of the passed Map that are valid between the passed from and upto (ignoring time).
static java.util.Map	getAllValidDuring(java.util.Map m, java.util.Date from, java.util.Date upto, boolean mustBeCompletelyValid)
static java.util.Map	getAllValidDuring(java.util.Map m, java.util.Date from, java.util.Date upto, boolean mustBeCompletelyValid, boolean $throw)
static java.util.Map	getAllValidDuring(java.util.Map m, java.util.Date from, java.util.Date upto, boolean mustBeCompletelyValid, boolean $throw, java.lang.Class onlyOfClass)
static java.util.Map	getAllValidDuring(java.util.Map m, TimespanI during) Returns a Map with all IdentifiableTimespanI-s among the values of the passed Map that are valid during the passed TimespanI (ignoring time).
static java.util.Map	getAllValidDuring(java.util.Map m, TimespanI during, boolean mustBeCompletelyValid)
static java.util.Map	getAllValidDuring(java.util.Map m, TimespanI during, boolean mustBeCompletelyValid, boolean $throw)
static java.util.Map	getAllValidDuring(java.util.Map m, TimespanI during, boolean mustBeCompletelyValid, boolean $throw, java.lang.Class onlyOfClass)
java.lang.Long	getId()
static IdentifiableTimespanI	getNewestValid(java.util.Collection c)
static IdentifiableTimespanI	getNewestValid(java.util.Collection c, java.lang.Class onlyOfClass)
static IdentifiableTimespanI	getNewestValidAfter(java.util.Collection c, java.util.Date limit)
static IdentifiableTimespanI	getNewestValidAfter(java.util.Collection c, java.util.Date limit, java.lang.Class onlyOfClass)
static IdentifiableTimespanI	getNewestValidBefore(java.util.Collection c, java.util.Date limit)
static IdentifiableTimespanI	getNewestValidBefore(java.util.Collection c, java.util.Date limit, java.lang.Class onlyOfClass)
static IdentifiableTimespanI	getOldestOrNewestValidBeforeOrAfter(java.util.Collection<IdentifiableTimespanI> c, java.util.Date d, java.lang.Class onlyOfClass, boolean returnOldest, boolean before)
static IdentifiableTimespanI	getOldestOrNewestValidBeforeOrAfter(java.util.Collection<IdentifiableTimespanI> c, java.util.Date d, java.lang.Class onlyOfClass, boolean returnOldest, boolean before, boolean nullDateIsValid)
static IdentifiableTimespanI	getOldestValid(java.util.Collection c)
static IdentifiableTimespanI	getOldestValid(java.util.Collection c, java.lang.Class onlyOfClass)
static IdentifiableTimespanI	getOldestValidAfter(java.util.Collection c, java.util.Date limit)
static IdentifiableTimespanI	getOldestValidAfter(java.util.Collection c, java.util.Date limit, java.lang.Class onlyOfClass)
static IdentifiableTimespanI	getOldestValidBefore(java.util.Collection c, java.util.Date limit)
static IdentifiableTimespanI	getOldestValidBefore(java.util.Collection c, java.util.Date limit, java.lang.Class onlyOfClass)
default IdentifiableTimespanI	getPredecessor(java.util.Collection c) Returns the temporal predecessor among the passed Collection of IdentifiableTimespanI-s regarding the DateStart of the passed candidate.
default IdentifiableTimespanI	getPredecessor(java.util.Map m) Returns the temporal predecessor among the passed Map of IdentifiableTimespanI-s regarding the DateStart of the passed candidate.
default IdentifiableTimespanI	getSuccessor(java.util.Collection c) Returns the temporal successor among the passed Collection of IdentifiableTimespanI-s regarding our DateEnd.
default IdentifiableTimespanI	getSuccessor(java.util.Map m) Returns the temporal successor among the passed Map of IdentifiableTimespanI-s regarding our DateStart.
static IdentifiableTimespanI	getValid(java.util.Collection c, java.util.Date d) Returns the IdentifiableTimespanI object from the values in the passed Collection that is valid at the specified date.
static IdentifiableTimespanI	getValid(java.util.Collection c, java.util.Date d, boolean ignoreTime)
static IdentifiableTimespanI	getValid(java.util.Collection c, java.util.Date d, boolean ignoreTime, boolean $throw)
static IdentifiableTimespanI	getValid(java.util.Collection c, java.util.Date d, boolean ignoreTime, boolean $throw, java.lang.Class onlyOfClass)
static IdentifiableTimespanI	getValid(java.util.Map m, java.util.Date d) Returns the IdentifiableTimespanI object from the values of the passed Map that is valid at the specified date.
static IdentifiableTimespanI	getValid(java.util.Map m, java.util.Date d, boolean ignoreTime)
static IdentifiableTimespanI	getValid(java.util.Map m, java.util.Date d, boolean ignoreTime, boolean $throw)
static IdentifiableTimespanI	getValid(java.util.Map m, java.util.Date d, boolean ignoreTime, boolean $throw, java.lang.Class onlyOfClass)
boolean	hasActiveTransaction()
boolean	isDeleted()
static boolean	isTimespanCompletelyCovered(java.util.Collection col)
static boolean	isTimespanCompletelyCovered(java.util.Collection col, java.util.Date from)
static boolean	isTimespanCompletelyCovered(java.util.Collection col, java.util.Date from, java.util.Date upto)
static boolean	isTimespanCompletelyCovered(java.util.Collection col, java.util.Date from, java.util.Date upto, java.lang.Class<? extends IdentifiableTimespanI> onlyOfClazz)
default boolean	isValid() Checks if this TimespanI is valid at the current time.

Methods inherited from interface de.ipcon.tools.date.SettableTimespanI

initStartAndEndDate, limitTo, setDateEnd, setDateStart

Methods inherited from interface de.ipcon.tools.date.TimespanI

checkConsistentDates, checkConsistentDates, checkConsistentDates, checkIsClosedTimespanWithConsistentDates, checkIsClosedTimespanWithConsistentDates, coversAtMostOneMonth, endsAfterOrOnStartOf, endsAfterOrOnStartOf, equalDates, equalDates, getDateEnd, getDateStart, hasUndefinedTimespan, isAlwaysValid, isCompletelyValidDuring, isCompletelyValidDuring, isPartiallyValidDuring, isPartiallyValidDuring, isPartiallyValidDuring, isPartiallyValidDuring, isValidAt, isValidAt, isValidAtOrAfter, isValidAtOrBefore, isValidFromStartOfTime, isValidOn, isValidUntilEndOfTime, numberOfDays, overlappingDaysWith, overlapsWith, overlapsWith, startsBeforeOrOnEndOf, startsBeforeOrOnEndOf

Field Detail

$0

static final java.lang.String $0

See Also:

Constant Field Values

Method Detail

describe

java.lang.String describe()

describe

java.lang.String describe(java.lang.String pattern)

conciseDesc

java.lang.String conciseDesc()

getId

java.lang.Long getId()

isDeleted

boolean isDeleted()

hasActiveTransaction

boolean hasActiveTransaction()

isValid

default boolean isValid()

Description copied from interface: TimespanI

Checks if this TimespanI is valid at the current time. A TimespanI is considered "valid" at a given date, if the date is included in the interval defined by this TimespanI.

Specified by:

isValid in interface TimespanI

Returns:

true if this TimespanI is currently "valid" i.e. the current date is included in the interval defined by this TimespanI

getPredecessor

default IdentifiableTimespanI getPredecessor(java.util.Map m)

Returns the temporal predecessor among the passed Map of IdentifiableTimespanI-s regarding the DateStart of the passed candidate.

getPredecessor

default IdentifiableTimespanI getPredecessor(java.util.Collection c)

Returns the temporal predecessor among the passed Collection of IdentifiableTimespanI-s regarding the DateStart of the passed candidate.

getSuccessor

default IdentifiableTimespanI getSuccessor(java.util.Map m)

Returns the temporal successor among the passed Map of IdentifiableTimespanI-s regarding our DateStart.

getSuccessor

default IdentifiableTimespanI getSuccessor(java.util.Collection c)

Returns the temporal successor among the passed Collection of IdentifiableTimespanI-s regarding our DateEnd.

getAllValid

static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI> getAllValid(java.util.Map<java.lang.Long,? extends IdentifiableTimespanI> m,
                                                                                 java.util.Date d)

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

getAllValid

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

getAllValid

static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI> getAllValid(java.util.Map<java.lang.Long,? extends IdentifiableTimespanI> m,
                                                                                 java.util.Date d,
                                                                                 boolean ignoreTime,
                                                                                 boolean $throw)

getAllValid

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

getAllValid

static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI> getAllValid(java.util.Collection<? extends IdentifiableTimespanI> c,
                                                                                 java.util.Date d)

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

getAllValid

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

getAllValid

static java.util.Map<java.lang.Long,? extends IdentifiableTimespanI> getAllValid(java.util.Collection<? extends IdentifiableTimespanI> c,
                                                                                 java.util.Date d,
                                                                                 boolean ignoreTime,
                                                                                 boolean $throw)

getAllValid

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

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Map m,
                                       java.util.Date from,
                                       java.util.Date upto)

Returns a Map with all IdentifiableTimespanI-s among the values of the passed Map that are valid between the passed from and upto (ignoring time).

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Map m,
                                       java.util.Date from,
                                       java.util.Date upto,
                                       boolean mustBeCompletelyValid)

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Map m,
                                       java.util.Date from,
                                       java.util.Date upto,
                                       boolean mustBeCompletelyValid,
                                       boolean $throw)

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Map m,
                                       java.util.Date from,
                                       java.util.Date upto,
                                       boolean mustBeCompletelyValid,
                                       boolean $throw,
                                       java.lang.Class onlyOfClass)

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Map m,
                                       TimespanI during)

Returns a Map with all IdentifiableTimespanI-s among the values of the passed Map that are valid during the passed TimespanI (ignoring time).

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Map m,
                                       TimespanI during,
                                       boolean mustBeCompletelyValid)

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Map m,
                                       TimespanI during,
                                       boolean mustBeCompletelyValid,
                                       boolean $throw)

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Map m,
                                       TimespanI during,
                                       boolean mustBeCompletelyValid,
                                       boolean $throw,
                                       java.lang.Class onlyOfClass)

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Map m,
                                                TimespanI during)

Returns a Map with all IdentifiableTimespanI-s among the values of the passed Map that are at least partially valid during the passed TimespanI (ignoring time).

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Map m,
                                                TimespanI during,
                                                boolean $throw)

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Map m,
                                                TimespanI during,
                                                boolean $throw,
                                                java.lang.Class onlyOfClass)

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Map m,
                                                java.util.Date from,
                                                java.util.Date upto)

Returns a Map with all IdentifiableTimespanI-s among the values of the passed Map that are at least partially valid between the passed from and upto (ignoring time).

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Map m,
                                                java.util.Date from,
                                                java.util.Date upto,
                                                boolean $throw)

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Map m,
                                                java.util.Date from,
                                                java.util.Date upto,
                                                boolean $throw,
                                                java.lang.Class onlyOfClass)

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Collection c,
                                                TimespanI during)

Returns a Map with all IdentifiableTimespanI-s among the values of the passed Collection that are at least partially valid during the passed TimespanI (ignoring time).

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Collection c,
                                                TimespanI during,
                                                boolean $throw)

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Collection c,
                                                TimespanI during,
                                                boolean $throw,
                                                java.lang.Class onlyOfClass)

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Collection c,
                                                java.util.Date from,
                                                java.util.Date upto)

Returns a Map with all IdentifiableTimespanI-s among the values of the passed Collection that are at least partially valid between the passed from and upto (ignoring time).

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Collection c,
                                                java.util.Date from,
                                                java.util.Date upto,
                                                boolean $throw)

getAllPartiallyValidDuring

static java.util.Map getAllPartiallyValidDuring(java.util.Collection c,
                                                java.util.Date from,
                                                java.util.Date upto,
                                                boolean $throw,
                                                java.lang.Class onlyOfClass)

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Collection c,
                                       java.util.Date from,
                                       java.util.Date upto)

Returns a Map with all IdentifiableTimespanI-s among the values in the passed Collection that are valid during the passed TimespanI (ignoring time). I.e. a timespan of the collection "is valid during" the passed timespan if the passed timespan is completely covered by the collection's timespan.

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Collection c,
                                       java.util.Date from,
                                       java.util.Date upto,
                                       boolean mustBeCompletelyValid)

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Collection c,
                                       java.util.Date from,
                                       java.util.Date upto,
                                       boolean mustBeCompletelyValid,
                                       boolean $throw)

getAllValidDuring

static java.util.Map getAllValidDuring(java.util.Collection c,
                                       java.util.Date from,
                                       java.util.Date upto,
                                       boolean mustBeCompletelyValid,
                                       boolean $throw,
                                       java.lang.Class<? extends IdentifiableTimespanI> onlyOfClass)

getValid

static IdentifiableTimespanI getValid(java.util.Map m,
                                      java.util.Date d)

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.

throwException - 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

static IdentifiableTimespanI getValid(java.util.Map m,
                                      java.util.Date d,
                                      boolean ignoreTime)

getValid

static IdentifiableTimespanI getValid(java.util.Map m,
                                      java.util.Date d,
                                      boolean ignoreTime,
                                      boolean $throw)

getValid

static IdentifiableTimespanI getValid(java.util.Map m,
                                      java.util.Date d,
                                      boolean ignoreTime,
                                      boolean $throw,
                                      java.lang.Class onlyOfClass)

getValid

static IdentifiableTimespanI getValid(java.util.Collection c,
                                      java.util.Date d)

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.

throwException - 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

static IdentifiableTimespanI getValid(java.util.Collection c,
                                      java.util.Date d,
                                      boolean ignoreTime)

getValid

static IdentifiableTimespanI getValid(java.util.Collection c,
                                      java.util.Date d,
                                      boolean ignoreTime,
                                      boolean $throw)

getValid

static IdentifiableTimespanI getValid(java.util.Collection c,
                                      java.util.Date d,
                                      boolean ignoreTime,
                                      boolean $throw,
                                      java.lang.Class onlyOfClass)

getAllOverlapping

static java.util.Map getAllOverlapping(java.util.Collection col,
                                       boolean sameDayOverlaps)

Returns a Map containing all IdentifiableTimespanI objects and their Ids from the given collection, whose time periods overlap either fully or partially with each other. Note: Due to limitations in the ability to define generic return values in NetRexx at this time, there may be compilation problems upon usage if the return type would be ''.

Parameters:

col - The collection of IdentifiableTimespanI objects to check for overlaps.

sameDayOverlaps - A boolean indicating whether same-day overlaps should be considered. Set to 'true' to include same-day overlaps, 'false' otherwise.

Returns:

A Map containing the overlapping IdentifiableTimespanI objects and their Ids.

getAllOverlapping

static java.util.Map getAllOverlapping(java.util.Collection col)

Returns a Map containing all IdentifiableTimespanI objects and their Ids from the given collection, whose time periods overlap either fully or partially with each other. Note: Due to limitations in the ability to define generic return values in NetRexx at this time, there may be compilation problems upon usage if the return type would be ''.

Parameters:

col - The collection of IdentifiableTimespanI objects to check for overlaps.

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

sameDayOverlaps - A boolean indicating whether same-day overlaps should be considered. Set to 'true' to include same-day overlaps, 'false' otherwise.

Returns:

A Map containing the overlapping IdentifiableTimespanI objects and their Ids.

getAllOverlapping

static java.util.Map getAllOverlapping(java.util.Collection col,
                                       java.lang.Class onlyOfClass)

getAllOverlapping

static java.util.Map getAllOverlapping(java.util.Collection col,
                                       java.lang.Class onlyOfClass,
                                       boolean sameDayOverlaps)

getAllOverlappingWith

static java.util.Map getAllOverlappingWith(IdentifiableTimespanI candidate,
                                           java.util.Collection col,
                                           boolean sameDayOverlaps)

Returns a Map containing all IdentifiableTimespanI objects and their Ids from the given collection, whose time periods overlap either fully or partially with the provided candidate. The candidate will be included in the resulting map only if there is at least one other overlapping entry in the collection. If the candidate is also part of the collection, it is ignored for the overlapping check. If no entry in the collection overlaps with the candidate, an empty map is returned. Note: Due to limitations in the ability to define generic return values in NetRexx at this time, there may be compilation problems upon usage if the return type would be ''.

Parameters:

candidate - The candidate IdentifiableTimespanI object to check for overlaps.

col - The collection of IdentifiableTimespanI objects to compare against.

sameDayOverlaps - A boolean indicating whether same-day overlaps should be considered. Set to 'true' to include same-day overlaps, 'false' otherwise.

Returns:

A Map containing the overlapping IdentifiableTimespanI objects and their IDs.

getAllOverlappingWith

static java.util.Map getAllOverlappingWith(IdentifiableTimespanI candidate,
                                           java.util.Collection col)

Returns a Map containing all IdentifiableTimespanI objects and their Ids from the given collection, whose time periods overlap either fully or partially with the provided candidate. The candidate will be included in the resulting map only if there is at least one other overlapping entry in the collection. If the candidate is also part of the collection, it is ignored for the overlapping check. If no entry in the collection overlaps with the candidate, an empty map is returned. Note: Due to limitations in the ability to define generic return values in NetRexx at this time, there may be compilation problems upon usage if the return type would be ''.

Parameters:

candidate - The candidate IdentifiableTimespanI object to check for overlaps.

col - The collection of IdentifiableTimespanI objects to compare against.

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

sameDayOverlaps - A boolean indicating whether same-day overlaps should be considered. Set to 'true' to include same-day overlaps, 'false' otherwise.

Returns:

A Map containing the overlapping IdentifiableTimespanI objects and their Ids.

getAllOverlappingWith

static java.util.Map getAllOverlappingWith(IdentifiableTimespanI candidate,
                                           java.util.Collection col,
                                           java.lang.Class<? extends IdentifiableTimespanI> onlyOfClass)

getAllOverlappingWith

static java.util.Map getAllOverlappingWith(IdentifiableTimespanI candidate,
                                           java.util.Collection col,
                                           java.lang.Class<? extends IdentifiableTimespanI> onlyOfClass,
                                           boolean sameDayOverlaps)

getOldestValid

static IdentifiableTimespanI getOldestValid(java.util.Collection c)

getOldestValid

static IdentifiableTimespanI getOldestValid(java.util.Collection c,
                                            java.lang.Class onlyOfClass)

getNewestValid

static IdentifiableTimespanI getNewestValid(java.util.Collection c)

getNewestValid

static IdentifiableTimespanI getNewestValid(java.util.Collection c,
                                            java.lang.Class onlyOfClass)

getNewestValidBefore

static IdentifiableTimespanI getNewestValidBefore(java.util.Collection c,
                                                  java.util.Date limit)

Returns:

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

getNewestValidBefore

static IdentifiableTimespanI getNewestValidBefore(java.util.Collection c,
                                                  java.util.Date limit,
                                                  java.lang.Class onlyOfClass)

getOldestValidBefore

static IdentifiableTimespanI getOldestValidBefore(java.util.Collection c,
                                                  java.util.Date limit)

Returns:

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

getOldestValidBefore

static IdentifiableTimespanI getOldestValidBefore(java.util.Collection c,
                                                  java.util.Date limit,
                                                  java.lang.Class onlyOfClass)

getNewestValidAfter

static IdentifiableTimespanI getNewestValidAfter(java.util.Collection c,
                                                 java.util.Date limit)

Returns:

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

getNewestValidAfter

static IdentifiableTimespanI getNewestValidAfter(java.util.Collection c,
                                                 java.util.Date limit,
                                                 java.lang.Class onlyOfClass)

getOldestValidAfter

static IdentifiableTimespanI getOldestValidAfter(java.util.Collection c,
                                                 java.util.Date limit)

Returns:

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

getOldestValidAfter

static IdentifiableTimespanI getOldestValidAfter(java.util.Collection c,
                                                 java.util.Date limit,
                                                 java.lang.Class onlyOfClass)

getOldestOrNewestValidBeforeOrAfter

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

Parameters:

sortByStartDate - if true, will use the start date of timespans for sorting. if false, the end date is used instead.

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

getOldestOrNewestValidBeforeOrAfter

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

isTimespanCompletelyCovered

static boolean isTimespanCompletelyCovered(java.util.Collection col)

Parameters:

from - Date check starting from this date, may be null (null = infinite)

upto - Date check until this date, may be null (null = infinite)

Returns:

false if there are gaps within the given collection of timespans or the from - till duration is not completely covered.

isTimespanCompletelyCovered

static boolean isTimespanCompletelyCovered(java.util.Collection col,
                                           java.util.Date from)

isTimespanCompletelyCovered

static boolean isTimespanCompletelyCovered(java.util.Collection col,
                                           java.util.Date from,
                                           java.util.Date upto)

isTimespanCompletelyCovered

static boolean isTimespanCompletelyCovered(java.util.Collection col,
                                           java.util.Date from,
                                           java.util.Date upto,
                                           java.lang.Class<? extends IdentifiableTimespanI> onlyOfClazz)