IntervalSet (ANTLR 4 Runtime 4.0-rc-1 API)

java.lang.Object
- org.antlr.v4.runtime.misc.IntervalSet

All Implemented Interfaces:

IntSet
```
public class IntervalSet
extends Object
implements IntSet
```
A set of integers that relies on ranges being common to do "run-length-encoded" like compression (if you view an IntSet like a BitSet with runs of 0s and 1s). Only ranges are recorded so that a few ints up near value 1000 don't cause massive bitsets, just two integer intervals. element values may be negative. Useful for sets of EPSILON and EOF. 0..9 char range is index pair ['0','9']. Multiple ranges are encoded with multiple index pairs. Isolated elements are encoded with an index pair where both intervals are the same. The ranges are ordered and disjoint so that 2..6 appears before 101..103.

Field Summary

Fields
Modifier and Type	Field and Description
`static IntervalSet`	`COMPLETE_CHAR_SET`
`static IntervalSet`	`EMPTY_SET`
`protected List<Interval>`	`intervals` The list of sorted, disjoint intervals.
`protected boolean`	`readonly`

Constructor Summary

Constructors
Constructor and Description

IntervalSet(int... els)

IntervalSet(IntervalSet set)

IntervalSet(List<Interval> intervals)

Constructors
Constructor and Description
`IntervalSet(int... els)`
`IntervalSet(IntervalSet set)`
`IntervalSet(List<Interval> intervals)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(int el)` Add a single element to the set.
`protected void`	`add(Interval addition)`
`void`	`add(int a, int b)` Add interval; i.e., add all integers from a to b to set.
`IntervalSet`	`addAll(IntSet set)` Add all elements from incoming set to this set.
`IntervalSet`	`and(IntSet other)` Return a new set with the intersection of this set with other.
`void`	`clear()`
`IntervalSet`	`complement(int minElement, int maxElement)`
`IntervalSet`	`complement(IntSet vocabulary)` Given the set of possible values (rather than, say UNICODE or MAXINT), return a new set containing all elements in vocabulary, but not in this.
`boolean`	`contains(int el)` Is el in any range of this set?
`protected String`	`elementName(String[] tokenNames, int a)`
`boolean`	`equals(Object obj)` Are two IntervalSets equal? Because all intervals are sorted and disjoint, equals is a simple linear walk over both lists to make sure they are the same.
`int`	`get(int i)` Get the ith element of ordered set.
`List<Interval>`	`getIntervals()` Return a list of Interval objects.
`int`	`getMaxElement()`
`int`	`getMinElement()` Return minimum element >= 0
`int`	`getSingleElement()` If this set is a single integer, return it otherwise Token.INVALID_TYPE
`int`	`hashCode()`
`boolean`	`isNil()` return true if this set has no members
`boolean`	`isReadonly()`
`static IntervalSet`	`of(int a)` Create a set with a single element, el.
`static IntervalSet`	`of(int a, int b)` Create a set with all ints within range [a..b] (inclusive)
`static IntervalSet`	`or(IntervalSet[] sets)` combine all sets in the array returned the or'd value
`IntervalSet`	`or(IntSet a)`
`void`	`remove(int el)` remove this element from this set
`void`	`setReadonly(boolean readonly)`
`int`	`size()` Return the size of this set (not the underlying implementation's allocated memory size, for example).
`IntervalSet`	`subtract(IntSet other)` Compute this-other via this&~other.
`int[]`	`toArray()`
`IntegerList`	`toIntegerList()`
`List<Integer>`	`toList()`
`Set<Integer>`	`toSet()`
`String`	`toString()`
`String`	`toString(boolean elemAreChar)`
`String`	`toString(String[] tokenNames)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - COMPLETE_CHAR_SET
```
public static final IntervalSet COMPLETE_CHAR_SET
```
  - EMPTY_SET
```
public static final IntervalSet EMPTY_SET
```
  - intervals
```
protected List<Interval> intervals
```
    The list of sorted, disjoint intervals.
  - readonly
```
protected boolean readonly
```
- Constructor Detail
  - IntervalSet
```
public IntervalSet(List<Interval> intervals)
```
  - IntervalSet
```
public IntervalSet(IntervalSet set)
```
  - IntervalSet
```
public IntervalSet(int... els)
```
- Method Detail
  - of
```
@NotNull
public static IntervalSet of(int a)
```
    Create a set with a single element, el.
  - of
```
public static IntervalSet of(int a,
             int b)
```
    Create a set with all ints within range [a..b] (inclusive)
  - clear
```
public void clear()
```
  - add
```
public void add(int el)
```
    Add a single element to the set. An isolated element is stored as a range el..el.
    
    Specified by:
    
    add in interface IntSet
  - add
```
public void add(int a,
       int b)
```
    Add interval; i.e., add all integers from a to b to set. If b
  - add
```
protected void add(Interval addition)
```
  - or
```
public static IntervalSet or(IntervalSet[] sets)
```
    combine all sets in the array returned the or'd value
  - addAll
```
public IntervalSet addAll(IntSet set)
```
    Description copied from interface: IntSet
    
    Add all elements from incoming set to this set. Can limit to set of its own type. Return "this" so we can chain calls.
    
    Specified by:
    
    addAll in interface IntSet
  - complement
```
public IntervalSet complement(int minElement,
                     int maxElement)
```
  - complement
```
public IntervalSet complement(IntSet vocabulary)
```
    Given the set of possible values (rather than, say UNICODE or MAXINT), return a new set containing all elements in vocabulary, but not in this. The computation is (vocabulary - this). 'this' is assumed to be either a subset or equal to vocabulary.
    
    Specified by:
    
    complement in interface IntSet
  - subtract
```
public IntervalSet subtract(IntSet other)
```
    Compute this-other via this&~other. Return a new set containing all elements in this but not in other. other is assumed to be a subset of this; anything that is in other but not in this will be ignored.
    
    Specified by:
    
    subtract in interface IntSet
  - or
```
public IntervalSet or(IntSet a)
```
    Specified by:
    
    or in interface IntSet
  - and
```
public IntervalSet and(IntSet other)
```
    Return a new set with the intersection of this set with other. Because the intervals are sorted, we can use an iterator for each list and just walk them together. This is roughly O(min(n,m)) for interval list lengths n and m.
    
    Specified by:
    
    and in interface IntSet
  - contains
```
public boolean contains(int el)
```
    Is el in any range of this set?
    
    Specified by:
    
    contains in interface IntSet
  - isNil
```
public boolean isNil()
```
    return true if this set has no members
    
    Specified by:
    
    isNil in interface IntSet
  - getSingleElement
```
public int getSingleElement()
```
    If this set is a single integer, return it otherwise Token.INVALID_TYPE
    
    Specified by:
    
    getSingleElement in interface IntSet
  - getMaxElement
```
public int getMaxElement()
```
  - getMinElement
```
public int getMinElement()
```
    Return minimum element >= 0
  - getIntervals
```
public List<Interval> getIntervals()
```
    Return a list of Interval objects.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Are two IntervalSets equal? Because all intervals are sorted and disjoint, equals is a simple linear walk over both lists to make sure they are the same. Interval.equals() is used by the List.equals() method to check the ranges.
    
    Specified by:
    
    equals in interface IntSet
    
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface IntSet
    
    Overrides:
    
    toString in class Object
  - toString
```
public String toString(boolean elemAreChar)
```
  - toString
```
public String toString(String[] tokenNames)
```
  - elementName
```
protected String elementName(String[] tokenNames,
                 int a)
```
  - size
```
public int size()
```
    Description copied from interface: IntSet
    
    Return the size of this set (not the underlying implementation's allocated memory size, for example).
    
    Specified by:
    
    size in interface IntSet
  - toIntegerList
```
public IntegerList toIntegerList()
```
  - toList
```
public List<Integer> toList()
```
    Specified by:
    
    toList in interface IntSet
  - toSet
```
public Set<Integer> toSet()
```
  - get
```
public int get(int i)
```
    Get the ith element of ordered set. Used only by RandomPhrase so don't bother to implement if you're not doing that for a new ANTLR code gen target.
  - toArray
```
public int[] toArray()
```
  - remove
```
public void remove(int el)
```
    Description copied from interface: IntSet
    
    remove this element from this set
    
    Specified by:
    
    remove in interface IntSet
  - isReadonly
```
public boolean isReadonly()
```
  - setReadonly
```
public void setReadonly(boolean readonly)
```

Class IntervalSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMPLETE_CHAR_SET

EMPTY_SET

intervals

readonly

Constructor Detail

IntervalSet

IntervalSet

IntervalSet

Method Detail

of

of

clear

add

add

add

or

addAll

complement

complement

subtract

or

and

contains

isNil

getSingleElement

getMaxElement

getMinElement

getIntervals

hashCode

equals

toString

toString

toString

elementName

size

toIntegerList

toList

toSet

get

toArray

remove

isReadonly

setReadonly