net.time4j.range

Enum IntervalRelation

java.lang.Object

java.lang.Enum<IntervalRelation>

net.time4j.range.IntervalRelation

All Implemented Interfaces:

Serializable, Comparable<IntervalRelation>

public enum IntervalRelation
extends Enum<IntervalRelation>

Represents an Allen-relation between two intervals.

Given any two intervals, there is always a unique and distinct relation between them without ambivalence. There are 13 possible relations.

Allen-Relations

precedes
meets
overlaps
finishedBy
encloses
starts
equivalent
startedBy
enclosedBy
finishes
overlappedBy
metBy
precededBy

Further explanations can be found at the website of Allen's interval algebra.

Since:

2.0

Author:

Meno Hochschild

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENCLOSED_BY See IsoInterval.enclosedBy(IsoInterval).
ENCLOSES See IsoInterval.encloses(IsoInterval).
EQUIVALENT See IsoInterval.equivalentTo(IsoInterval).
FINISHED_BY See IsoInterval.finishedBy(IsoInterval).
FINISHES See IsoInterval.finishes(IsoInterval).
MEETS See IsoInterval.meets(IsoInterval).
MET_BY See IsoInterval.metBy(IsoInterval).
OVERLAPPED_BY See IsoInterval.overlappedBy(IsoInterval).
OVERLAPS See IsoInterval.overlaps(IsoInterval).
PRECEDED_BY See IsoInterval.precededBy(IsoInterval).
PRECEDES See IsoInterval.precedes(IsoInterval).
STARTED_BY See IsoInterval.startedBy(IsoInterval).
STARTS See IsoInterval.starts(IsoInterval).

Method Summary

Modifier and Type	Method and Description
static IntervalRelation	between(ClockInterval a, ClockInterval b) Determines the relation between given intervals.
static IntervalRelation	between(DateInterval a, DateInterval b) Determines the relation between given intervals.
static IntervalRelation	between(MomentInterval a, MomentInterval b) Determines the relation between given intervals.
static IntervalRelation	between(TimestampInterval a, TimestampInterval b) Determines the relation between given intervals.
IntervalRelation	inverse() Determines the opposite relation.
boolean	matches(ClockInterval a, ClockInterval b) Does this relation match the relation between given intervals?
boolean	matches(DateInterval a, DateInterval b) Does this relation match the relation between given intervals?
boolean	matches(MomentInterval a, MomentInterval b) Does this relation match the relation between given intervals?
boolean	matches(TimestampInterval a, TimestampInterval b) Does this relation match the relation between given intervals?
static IntervalRelation	valueOf(String name) Returns the enum constant of this type with the specified name.
static IntervalRelation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PRECEDES

public static final IntervalRelation PRECEDES

See IsoInterval.precedes(IsoInterval).

MEETS

public static final IntervalRelation MEETS

See IsoInterval.meets(IsoInterval).

OVERLAPS

public static final IntervalRelation OVERLAPS

See IsoInterval.overlaps(IsoInterval).

FINISHES

public static final IntervalRelation FINISHES

See IsoInterval.finishes(IsoInterval).

STARTS

public static final IntervalRelation STARTS

See IsoInterval.starts(IsoInterval).

ENCLOSES

public static final IntervalRelation ENCLOSES

See IsoInterval.encloses(IsoInterval).

EQUIVALENT

public static final IntervalRelation EQUIVALENT

See IsoInterval.equivalentTo(IsoInterval).

ENCLOSED_BY

public static final IntervalRelation ENCLOSED_BY

See IsoInterval.enclosedBy(IsoInterval).

STARTED_BY

public static final IntervalRelation STARTED_BY

See IsoInterval.startedBy(IsoInterval).

FINISHED_BY

public static final IntervalRelation FINISHED_BY

See IsoInterval.finishedBy(IsoInterval).

OVERLAPPED_BY

public static final IntervalRelation OVERLAPPED_BY

See IsoInterval.overlappedBy(IsoInterval).

MET_BY

public static final IntervalRelation MET_BY

See IsoInterval.metBy(IsoInterval).

PRECEDED_BY

public static final IntervalRelation PRECEDED_BY

See IsoInterval.precededBy(IsoInterval).

Method Detail

values

public static IntervalRelation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IntervalRelation c : IntervalRelation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IntervalRelation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

inverse

public IntervalRelation inverse()

Determines the opposite relation.

Returns:

opposite relation

Since:

2.0

matches

public boolean matches(DateInterval a,
                       DateInterval b)

Does this relation match the relation between given intervals?

Parameters:

a - first interval

b - second interval

Returns:

true if both intervals have this relation to each other else false

Since:

2.0

matches

public boolean matches(ClockInterval a,
                       ClockInterval b)

Does this relation match the relation between given intervals?

Parameters:

a - first interval

b - second interval

Returns:

true if both intervals have this relation to each other else false

Since:

2.0

matches

public boolean matches(TimestampInterval a,
                       TimestampInterval b)

Does this relation match the relation between given intervals?

Parameters:

a - first interval

b - second interval

Returns:

true if both intervals have this relation to each other else false

Since:

2.0

matches

public boolean matches(MomentInterval a,
                       MomentInterval b)

Does this relation match the relation between given intervals?

Parameters:

a - first interval

b - second interval

Returns:

true if both intervals have this relation to each other else false

Since:

2.0

between

public static IntervalRelation between(DateInterval a,
                                       DateInterval b)

Determines the relation between given intervals.

Parameters:

a - first interval

b - second interval

Returns:

relation between given intervals

Since:

2.0

between

public static IntervalRelation between(ClockInterval a,
                                       ClockInterval b)

Determines the relation between given intervals.

Parameters:

a - first interval

b - second interval

Returns:

relation between given intervals

Since:

2.0

between

public static IntervalRelation between(TimestampInterval a,
                                       TimestampInterval b)

Determines the relation between given intervals.

Parameters:

a - first interval

b - second interval

Returns:

relation between given intervals

Since:

2.0

between

public static IntervalRelation between(MomentInterval a,
                                       MomentInterval b)

Determines the relation between given intervals.

Parameters:

a - first interval

b - second interval

Returns:

relation between given intervals

Since:

2.0