ANTLR 4 Runtime (Optimized) 4.9.0 · org.antlr.v4.runtime.misc.Interval

Modifier and Type	Field and Description
public final int	a The start of the interval.
public final int	b The end of the interval (inclusive).
private static Interval[]	cache
public static final int	INTERVAL_POOL_MAX_VALUE
public static final Interval	INVALID

Access	Constructor and Description
public	Interval(int a, int b)

Method Summary

Modifier and Type	Method and Description
public boolean	adjacent(Interval other) Are two intervals adjacent such as 0..41 and 42..42?
public Interval	differenceNotProperlyContained(Interval other) Return the interval with elements from `this` not in `other`; `other` must not be totally enclosed (properly contained) within `this`, which would result in two disjoint intervals instead of the single one returned by this method.
public boolean	disjoint(Interval other) Are both ranges disjoint?
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public Interval	intersection(Interval other) Return the interval in common between this and o
public int	length() return number of elements between a and b inclusively.
public static Interval	of(int a, int b) Interval objects are used readonly so share all with the same single value a==b up to some max size.
public boolean	properlyContains(Interval other)
public boolean	startsAfter(Interval other) Does this.a start after other.b?
public boolean	startsAfterDisjoint(Interval other) Does this start completely after other?
public boolean	startsAfterNonDisjoint(Interval other) Does this start after other?
public boolean	startsBeforeDisjoint(Interval other) Does this start completely before other?
public boolean	startsBeforeNonDisjoint(Interval other) Does this start at or before other?
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Interval	union(Interval other) Return the interval computed from combining this and other

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

a	back to summary
public final int a The start of the interval.

b	back to summary
public final int b The end of the interval (inclusive).

cache	back to summary
private static Interval[] cache

INTERVAL_POOL_MAX_VALUE	back to summary
public static final int INTERVAL_POOL_MAX_VALUE

INVALID	back to summary
public static final Interval INVALID

Interval	back to summary
public Interval(int a, int b)

Method Detail

adjacent	back to summary
public boolean adjacent(Interval other) Are two intervals adjacent such as 0..41 and 42..42?

differenceNotProperlyContained	back to summary
public Interval differenceNotProperlyContained(Interval other) Return the interval with elements from `this` not in `other`; `other` must not be totally enclosed (properly contained) within `this`, which would result in two disjoint intervals instead of the single one returned by this method.

disjoint	back to summary
public boolean disjoint(Interval other) Are both ranges disjoint? I.e., no overlap?

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

intersection	back to summary
public Interval intersection(Interval other) Return the interval in common between this and o

length	back to summary
public int length() return number of elements between a and b inclusively. x..x is length 1. if b < a, then length is 0. 9..10 has length 2.

of	back to summary
public static Interval of(int a, int b) Interval objects are used readonly so share all with the same single value a==b up to some max size. Use an array as a perfect hash. Return shared object for 0..INTERVAL_POOL_MAX_VALUE or a new Interval object with a..a in it. On Java.g4, 218623 IntervalSets have a..a (set with 1 element).

properlyContains	back to summary
public boolean properlyContains(Interval other)

startsAfter	back to summary
public boolean startsAfter(Interval other) Does this.a start after other.b? May or may not be disjoint

startsAfterDisjoint	back to summary
public boolean startsAfterDisjoint(Interval other) Does this start completely after other? Disjoint

startsAfterNonDisjoint	back to summary
public boolean startsAfterNonDisjoint(Interval other) Does this start after other? NonDisjoint

startsBeforeDisjoint	back to summary
public boolean startsBeforeDisjoint(Interval other) Does this start completely before other? Disjoint

startsBeforeNonDisjoint	back to summary
public boolean startsBeforeNonDisjoint(Interval other) Does this start at or before other? Nondisjoint

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

union	back to summary
public Interval union(Interval other) Return the interval computed from combining this and other

public Class Interval

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail