IntervalSet (ANTLR 4 Runtime (Optimized) 4.11.1 API)

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

所有已实现的接口:

IntSet
```
public class IntervalSet
extends Object
implements IntSet
```
This class implements the IntSet backed by a sorted array of non-overlapping intervals. It is particularly efficient for representing large collections of numbers, where the majority of elements appear as part of a sequential range of numbers that are all part of the set. For example, the set { 1, 2, 3, 4, 7, 8 } may be represented as { [1, 4], [7, 8] }.
This class is able to represent sets containing any combination of values in the range Integer.MIN_VALUE to Integer.MAX_VALUE (inclusive).

字段概要

字段
限定符和类型	字段和说明
`static IntervalSet`	`COMPLETE_CHAR_SET`
`static IntervalSet`	`EMPTY_SET`
`protected List<Interval>`	`intervals` The list of sorted, disjoint intervals.
`protected boolean`	`readonly`

构造器概要

构造器
构造器和说明

IntervalSet(int... els)

IntervalSet(IntervalSet set)

IntervalSet(List<Interval> intervals)

构造器
构造器和说明
`IntervalSet(int... els)`
`IntervalSet(IntervalSet set)`
`IntervalSet(List<Interval> intervals)`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`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)` Modify the current `IntSet` object to contain all elements that are present in itself, the specified `set`, or both.
`IntervalSet`	`and(IntSet other)` Return a new `IntSet` object containing all elements that are present in both the current set and the specified set `a`.
`void`	`clear()`
`IntervalSet`	`complement(int minElement, int maxElement)`
`IntervalSet`	`complement(IntSet vocabulary)` Return a new `IntSet` object containing all elements that are present in `elements` but not present in the current set.
`boolean`	`contains(int el)` Returns `true` if the set contains the specified element.
`protected String`	`elementName(String[] tokenNames, int a)` 已过时。 Use `elementName(Vocabulary, int)` instead.
`protected String`	`elementName(Vocabulary vocabulary, int a)`
`boolean`	`equals(Object obj)` Are two IntervalSets equal?
`List<Interval>`	`getIntervals()` Return a list of Interval objects.
`int`	`getMaxElement()` Returns the maximum value contained in the set.
`int`	`getMinElement()` Returns the minimum value contained in the set.
`int`	`getSingleElement()` Returns the single value contained in the set, if `IntSet.size()` is 1; otherwise, returns `Token.INVALID_TYPE`.
`int`	`hashCode()`
`boolean`	`isNil()` Returns `true` if this set contains no elements.
`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)` Return a new `IntSet` object containing all elements that are present in the current set, the specified set `a`, or both.
`void`	`remove(int el)` Removes the specified value from the current set.
`void`	`setReadonly(boolean readonly)`
`int`	`size()` Return the total number of elements represented by the current set.
`static IntervalSet`	`subtract(IntervalSet left, IntervalSet right)` Compute the set difference between two interval sets.
`IntervalSet`	`subtract(IntSet a)` Return a new `IntSet` object containing all elements that are present in the current set but not present in the input set `a`.
`int[]`	`toArray()`
`IntegerList`	`toIntegerList()`
`List<Integer>`	`toList()` Return a list containing the elements represented by the current set.
`Set<Integer>`	`toSet()`
`String`	`toString()`
`String`	`toString(boolean elemAreChar)`
`String`	`toString(String[] tokenNames)` 已过时。 Use `toString(Vocabulary)` instead.
`String`	`toString(Vocabulary vocabulary)`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - 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
```
- 构造器详细资料
  - IntervalSet
```
public IntervalSet(List<Interval> intervals)
```
  - IntervalSet
```
public IntervalSet(IntervalSet set)
```
  - IntervalSet
```
public IntervalSet(int... els)
```
- 方法详细资料
  - 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.
    
    指定者:
    
    add 在接口中 IntSet
    
    参数:
    
    el - the value to add
  - add
```
public void add(int a,
                int b)
```
    Add interval; i.e., add all integers from a to b to set. If b<a, do nothing. Keep list in sorted order (by left range value). If overlap, combine ranges. For example, If this is {1..5, 10..20}, adding 6..7 yields {1..5, 6..7, 10..20}. Adding 4..8 yields {1..8, 10..20}.
  - 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)
```
    从接口复制的说明: IntSet
    
    Modify the current IntSet object to contain all elements that are present in itself, the specified set, or both.
    
    指定者:
    
    addAll 在接口中 IntSet
    
    参数:
    
    set - The set to add to the current set. A null argument is treated as though it were an empty set.
    
    返回:
    
    this (to support chained calls)
  - complement
```
public IntervalSet complement(int minElement,
                              int maxElement)
```
  - complement
```
public IntervalSet complement(IntSet vocabulary)
```
    Return a new IntSet object containing all elements that are present in elements but not present in the current set. The following expressions are equivalent for input non-null IntSet instances x and y.
    - x.complement(y)
    - y.subtract(x)
    指定者:
    
    complement 在接口中 IntSet
    
    参数:
    
    vocabulary - The set to compare with the current set. A null argument is treated as though it were an empty set.
    
    返回:
    
    A new IntSet instance containing the elements present in elements but not present in the current set. The value null may be returned in place of an empty result set.
  - subtract
```
public IntervalSet subtract(IntSet a)
```
    从接口复制的说明: IntSet
    Return a new IntSet object containing all elements that are present in the current set but not present in the input set a. The following expressions are equivalent for input non-null IntSet instances x and y.
    - y.subtract(x)
    - x.complement(y)
    指定者:
    
    subtract 在接口中 IntSet
    
    参数:
    
    a - The set to compare with the current set. A null argument is treated as though it were an empty set.
    
    返回:
    
    A new IntSet instance containing the elements present in elements but not present in the current set. The value null may be returned in place of an empty result set.
  - subtract
```
@NotNull
public static IntervalSet subtract(@Nullable
                                             IntervalSet left,
                                             @Nullable
                                             IntervalSet right)
```
    Compute the set difference between two interval sets. The specific operation is left - right. If either of the input sets is null, it is treated as though it was an empty set.
  - or
```
public IntervalSet or(IntSet a)
```
    从接口复制的说明: IntSet
    
    Return a new IntSet object containing all elements that are present in the current set, the specified set a, or both.
    This method is similar to IntSet.addAll(IntSet), but returns a new IntSet instance instead of modifying the current set.
    
    指定者:
    
    or 在接口中 IntSet
    
    参数:
    
    a - The set to union with the current set. A null argument is treated as though it were an empty set.
    
    返回:
    
    A new IntSet instance containing the union of the current set and a. The value null may be returned in place of an empty result set.
  - and
```
public IntervalSet and(IntSet other)
```
    Return a new IntSet object containing all elements that are present in both the current set and the specified set a.
    
    指定者:
    
    and 在接口中 IntSet
    
    参数:
    
    other - The set to intersect with the current set. A null argument is treated as though it were an empty set.
    
    返回:
    
    A new IntSet instance containing the intersection of the current set and a. The value null may be returned in place of an empty result set.
  - contains
```
public boolean contains(int el)
```
    Returns true if the set contains the specified element.
    
    指定者:
    
    contains 在接口中 IntSet
    
    参数:
    
    el - The element to check for.
    
    返回:
    
    true if the set contains el; otherwise false.
  - isNil
```
public boolean isNil()
```
    Returns true if this set contains no elements.
    
    指定者:
    
    isNil 在接口中 IntSet
    
    返回:
    
    true if the current set contains no elements; otherwise, false.
  - getSingleElement
```
public int getSingleElement()
```
    Returns the single value contained in the set, if IntSet.size() is 1; otherwise, returns Token.INVALID_TYPE.
    
    指定者:
    
    getSingleElement 在接口中 IntSet
    
    返回:
    
    the single value contained in the set, if IntSet.size() is 1; otherwise, returns Token.INVALID_TYPE.
  - getMaxElement
```
public int getMaxElement()
```
    Returns the maximum value contained in the set.
    
    返回:
    
    the maximum value contained in the set. If the set is empty, this method returns Token.INVALID_TYPE.
  - getMinElement
```
public int getMinElement()
```
    Returns the minimum value contained in the set.
    
    返回:
    
    the minimum value contained in the set. If the set is empty, this method returns Token.INVALID_TYPE.
  - getIntervals
```
public List<Interval> getIntervals()
```
    Return a list of Interval objects.
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 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.
    
    指定者:
    
    equals 在接口中 IntSet
    
    覆盖:
    
    equals 在类中 Object
  - toString
```
public String toString()
```
    从接口复制的说明: IntSet
    
    指定者:
    
    toString 在接口中 IntSet
    
    覆盖:
    
    toString 在类中 Object
  - toString
```
public String toString(boolean elemAreChar)
```
  - toString
```
@Deprecated
public String toString(String[] tokenNames)
```
    已过时。 Use toString(Vocabulary) instead.
  - toString
```
public String toString(@NotNull
                       Vocabulary vocabulary)
```
  - elementName
```
@Deprecated
protected String elementName(String[] tokenNames,
                                          int a)
```
    已过时。 Use elementName(Vocabulary, int) instead.
  - elementName
```
@NotNull
protected String elementName(@NotNull
                                       Vocabulary vocabulary,
                                       int a)
```
  - size
```
public int size()
```
    从接口复制的说明: IntSet
    
    Return the total number of elements represented by the current set.
    
    指定者:
    
    size 在接口中 IntSet
    
    返回:
    
    the total number of elements represented by the current set, regardless of the manner in which the elements are stored.
  - toIntegerList
```
public IntegerList toIntegerList()
```
  - toList
```
public List<Integer> toList()
```
    从接口复制的说明: IntSet
    
    Return a list containing the elements represented by the current set. The list is returned in ascending numerical order.
    
    指定者:
    
    toList 在接口中 IntSet
    
    返回:
    
    A list containing all element present in the current set, sorted in ascending numerical order.
  - toSet
```
public Set<Integer> toSet()
```
  - toArray
```
public int[] toArray()
```
  - remove
```
public void remove(int el)
```
    从接口复制的说明: IntSet
    
    Removes the specified value from the current set. If the current set does not contain the element, no changes are made.
    
    指定者:
    
    remove 在接口中 IntSet
    
    参数:
    
    el - the value to remove
  - isReadonly
```
public boolean isReadonly()
```
  - setReadonly
```
public void setReadonly(boolean readonly)
```

类 IntervalSet

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

COMPLETE_CHAR_SET

EMPTY_SET

intervals

readonly

构造器详细资料

IntervalSet

IntervalSet

IntervalSet

方法详细资料

of

of

clear

add

add

add

or

addAll

complement

complement

subtract

subtract

or

and

contains

isNil

getSingleElement

getMaxElement

getMinElement

getIntervals

hashCode

equals

toString

toString

toString

toString

elementName

elementName

size

toIntegerList

toList

toSet

toArray

remove

isReadonly

setReadonly