java.lang.Object
- jflex.core.unicode.IntCharSet

All Implemented Interfaces:

Iterable<Integer>
```
public final class IntCharSet
extends Object
implements Iterable<Integer>
```
Mutable Char Set implemented with intervals.

Version:

JFlex 1.8.2

Author:

Gerwin Klein, Régis Décamps

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class IntCharSet.IntCharSetIterator
Iterator for enumerating the elements of this IntCharSet

Constructor Summary

Constructors
Constructor Description

IntCharSet()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`add(int c)`	Adds a single character.
`void`	`add(Interval interval)`	Adds a single interval to this IntCharSet.
`void`	`add(IntCharSet set)`	Merges the given set into this one.
`static IntCharSet`	`allChars()`	Creates the set of all characters.
`IntCharSet`	`and(IntCharSet set)`	Intersects two sets.
`static IntCharSet`	`complementOf(IntCharSet x)`	Returns the complement of the specified set x, that is, the set of all elements that are not contained in x.
`boolean`	`contains(int singleChar)`	Returns whether this set contains a given character.
`boolean`	`contains(IntCharSet other)`	Check whether this set contains a another set.
`boolean`	`containsElements()`	Returns whether the set contains elements.
`static IntCharSet`	`copyOf(IntCharSet intCharSet)`	Creates a IntCharSet from an existing IntCharSet.
`boolean`	`equals(Object o)`
`IntCharSet`	`getCaseless(UnicodeProperties unicodeProperties)`	Create a caseless version of this charset.
`List<Interval>`	`getIntervals()`	Returns the intervals.
`int`	`hashCode()`
`Iterator<Interval>`	`intervalIterator()`
`IntCharSet.IntCharSetIterator`	`iterator()`
`static IntCharSet`	`nlChars()`	The set of new-line characters.
`int`	`numIntervals()`	Returns the number of intervals.
`static IntCharSet`	`of(Interval interval)`	Creates a charset that contains only one interval.
`static IntCharSet`	`of(Interval... intervals)`	Creates a charset that contains the given intervals.
`static IntCharSet`	`ofCharacter(int singleChar)`	Creates a char set that contains only the given character.
`static IntCharSet`	`ofCharacterRange(int start, int end)`	Creates a charset that contains only one interval, given by its `start` and `end` values.
`int`	`size()`	Computes the size of this set.
`void`	`sub(IntCharSet set)`	Returns the relative complement of this set relative to the provided set.
`String`	`toString()`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - IntCharSet
```
public IntCharSet()
```
- Method Detail
  - of
```
public static IntCharSet of(Interval interval)
```
    Creates a charset that contains only one interval.
  - of
```
public static IntCharSet of(Interval... intervals)
```
    Creates a charset that contains the given intervals.
    
    Parameters:
    
    intervals - the intervals the new set should contains.
    
    Returns:
    
    a new IntCharSet with the given intervals.
  - ofCharacterRange
```
public static IntCharSet ofCharacterRange(int start,
                                          int end)
```
    Creates a charset that contains only one interval, given by its start and end values.
  - ofCharacter
```
public static IntCharSet ofCharacter(int singleChar)
```
    Creates a char set that contains only the given character.
  - allChars
```
public static IntCharSet allChars()
```
    Creates the set of all characters.
    
    Returns:
    
    a new IntCharSet that contains all characters.
  - nlChars
```
public static IntCharSet nlChars()
```
    The set of new-line characters.
    
    Returns:
    
    a new IntCharSet that contains all characters that are considered a new-line char in Java.
  - add
```
public void add(IntCharSet set)
```
    Merges the given set into this one.
  - add
```
public void add(Interval interval)
```
    Adds a single interval to this IntCharSet.
    
    Parameters:
    
    interval - a Interval object.
  - add
```
public void add(int c)
```
    Adds a single character.
    
    Parameters:
    
    c - Character to add.
  - contains
```
public boolean contains(int singleChar)
```
    Returns whether this set contains a given character.
    
    Parameters:
    
    singleChar - a single character (int).
    
    Returns:
    
    true iff singleChar is contained in the set.
  - contains
```
public boolean contains(IntCharSet other)
```
    Check whether this set contains a another set.
    
    Parameters:
    
    other - an IntCharSet.
    
    Returns:
    
    true iff all characters of other are contained in this set.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - and
```
public IntCharSet and(IntCharSet set)
```
    Intersects two sets.
    
    Parameters:
    
    set - a IntCharSet object.
    
    Returns:
    
    the IntCharSet common to the two sets.
  - sub
```
public void sub(IntCharSet set)
```
    Returns the relative complement of this set relative to the provided set.
    Assumes that set is non-null, and contained in this IntCharSet.
    
    Parameters:
    
    set - a IntCharSet to substract from this set.
  - complementOf
```
public static IntCharSet complementOf(IntCharSet x)
```
    Returns the complement of the specified set x, that is, the set of all elements that are not contained in x.
    
    Parameters:
    
    x - the IntCharSet to take the complement of.
    
    Returns:
    
    the complement of x
  - containsElements
```
public boolean containsElements()
```
    Returns whether the set contains elements.
    
    Returns:
    
    Whether the set is non-empty.
  - numIntervals
```
public int numIntervals()
```
    Returns the number of intervals.
    
    Returns:
    
    number of intervals.
  - getIntervals
```
public List<Interval> getIntervals()
```
    Returns the intervals.
    
    Returns:
    
    a List object.
  - intervalIterator
```
public Iterator<Interval> intervalIterator()
```
    Returns:
    
    an iterator over the intervals in this set
  - getCaseless
```
public IntCharSet getCaseless(UnicodeProperties unicodeProperties)
```
    Create a caseless version of this charset.
    The caseless version contains all characters of this char set, and additionally all lower/upper/title case variants of the characters in this set.
    
    Parameters:
    
    unicodeProperties - The Unicode Properties to use when generating caseless equivalence classes.
    
    Returns:
    
    a caseless copy of this set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - copyOf
```
public static IntCharSet copyOf(IntCharSet intCharSet)
```
    Creates a IntCharSet from an existing IntCharSet.
    
    Returns:
    
    a (deep) copy of the char set.
  - size
```
public int size()
```
    Computes the size of this set.
    
    Returns:
    
    how many elements are contained in this set
  - iterator
```
public IntCharSet.IntCharSetIterator iterator()
```
    Specified by:
    
    iterator in interface Iterable<Integer>

Class IntCharSet

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

IntCharSet

Method Detail

of

of

ofCharacterRange

ofCharacter

allChars

nlChars

add

add

add

contains

contains

equals

hashCode

and

sub

complementOf

containsElements

numIntervals

getIntervals

intervalIterator

getCaseless

toString

copyOf

size

iterator