CSet

java.lang.Object
- org.stekikun.dolmen.common.CSet

All Implemented Interfaces:

Comparable<CSet>
```
public abstract class CSet
extends Object
implements Comparable<CSet>
```
A class to represent character sets.
Characters are Java characters, i.e. 16-bit unsigned integers. Character sets are mostly encoded as an ordered list of character intervals, with some special values for degenerate cases, and are thus optimized for space rather than for lookup speed.
The special value 0xFFFF is reserved to denote end of file. It is not a valid Unicode character anyway.
Instances of this class are immutable.
They implement the Comparable interface via a total ordering based on the lexicographic comparison of the character set, with the empty character set being a conventional minimum. It is not a particularly meaningful total order but it is used to guarantee a deterministic traversal order in CSet-indexed maps. A more natural, yet partial, order based on character set inclusion can be retrieved via the method included(CSet, CSet).

Author:

Stéphane Lescuyer

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CSet.Gen
Generates random character sets based on a probability configuration and a random number generator

Nested Classes
Modifier and Type	Class and Description
`static class`	`CSet.Gen` Generates random character sets based on a probability configuration and a random number generator

Field Summary

Fields
Modifier and Type	Field and Description
`static CSet`	`ALL` The set of all possible characters, including the special end-of-file marker.
`static CSet`	`ALL_BUT_EOF` Like `ALL` but does not contain the special end-of-input marker
`static CSet`	`EMPTY` The empty character set
`static CSet`	`EOF` Special character set used to denote end-of-file

Constructor Summary

Constructors
Constructor and Description

CSet()

Constructors
Constructor and Description
`CSet()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract int`	`cardinal()`
`static CSet`	`chars(char... chars)`
`static String`	`charToString(char ch, boolean javaSafe)`
`int`	`compareTo(@Nullable CSet cs)`
`static CSet`	`complement(CSet cs)`
`abstract boolean`	`contains(char ch)`
`static CSet`	`diff(CSet cs1, CSet cs2)`
`boolean`	`equals(@Nullable Object o)`
`static boolean`	`equivalent(CSet cs1, CSet cs2)`
`void`	`forEach(Consumer<? super Character> f)` Applies the function `f` to all characters in the character set
`void`	`forEachInterval(BiConsumer<? super Character,? super Character> f)` Applies the function `f` to all intervals in the character set.
`static CSet.Gen`	`generator()`
`abstract int`	`hashCode()`
`static boolean`	`included(CSet cs1, CSet cs2)`
`static CSet`	`inter(CSet cs1, CSet cs2)` Returns the intersection of the two given character sets
`static CSet`	`interval(char first, char last)`
`abstract boolean`	`isEmpty()`
`static CSet`	`singleton(char c)`
`abstract String`	`toString()`
`static CSet`	`union(CSet... charSets)`
`static CSet`	`union(CSet cs1, CSet cs2)` Returns the union of the two given character sets
`static Iterable<Character>`	`witnesses(CSet cset)`

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

- Field Detail
  - ALL
```
public static final CSet ALL
```
    The set of all possible characters, including the special end-of-file marker.
    Warning: also contains character values which do not correspond to a valid Unicode character.
  - EMPTY
```
public static final CSet EMPTY
```
    The empty character set
  - EOF
```
public static final CSet EOF
```
    Special character set used to denote end-of-file
  - ALL_BUT_EOF
```
public static final CSet ALL_BUT_EOF
```
    Like ALL but does not contain the special end-of-input marker
- Constructor Detail
  - CSet
```
public CSet()
```
- Method Detail
  - isEmpty
```
public abstract boolean isEmpty()
```
    Returns:
    
    true if this character set is empty
  - contains
```
public abstract boolean contains(char ch)
```
    Parameters:
    
    ch -
    
    Returns:
    
    whether this character set contains ch
  - cardinal
```
public abstract int cardinal()
```
    Returns:
    
    the number of characters in this set
  - toString
```
public abstract String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public final boolean equals(@Nullable Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public abstract int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public final int compareTo(@Nullable CSet cs)
```
    Specified by:
    
    compareTo in interface Comparable<CSet>
  - charToString
```
public static String charToString(char ch,
                                  boolean javaSafe)
```
    Parameters:
    
    ch -
    
    javaSafe - should be true if the result string may end up in Java sources
    
    Returns:
    
    a string to display ch, either using the character itself if appropriate, or the '\\uxxxx' form. If javaSafe is true the '\\uxxxx' is not used because it would be unescaped by a Java compiler, and the prefix '0x' is used instead
  - singleton
```
public static CSet singleton(char c)
```
    Parameters:
    
    c -
    
    Returns:
    
    the singleton character set containing c
  - interval
```
public static CSet interval(char first,
                            char last)
```
    Parameters:
    
    first -
    
    last -
    
    Returns:
    
    the character set describing the single character range from first to last, inclusive
  - forEach
```
public void forEach(Consumer<? super Character> f)
```
    Applies the function f to all characters in the character set
    
    Parameters:
    
    f -
  - forEachInterval
```
public void forEachInterval(BiConsumer<? super Character,? super Character> f)
```
    Applies the function f to all intervals in the character set. The intervals are guaranteed to be normalized in the following fashion:
    - there will be no empty intervals
    - intervals are visited in a strict increasing order
    - in particular, two successive intervals are necessarily separated by at least one character or they would have been merged
    Parameters:
    
    f -
  - union
```
public static CSet union(CSet cs1,
                         CSet cs2)
```
    Returns the union of the two given character sets
  - union
```
public static CSet union(CSet... charSets)
```
    Parameters:
    
    charSets -
    
    Returns:
    
    the union of all the given character sets
  - chars
```
public static CSet chars(char... chars)
```
    Parameters:
    
    chars -
    
    Returns:
    
    the character set containing exactly the given characters
  - inter
```
public static CSet inter(CSet cs1,
                         CSet cs2)
```
    Returns the intersection of the two given character sets
  - diff
```
public static CSet diff(CSet cs1,
                        CSet cs2)
```
    Parameters:
    
    cs1 -
    
    cs2 -
    
    Returns:
    
    the character set of all characters in cs1 except those that are in cs2
  - complement
```
public static CSet complement(CSet cs)
```
    Parameters:
    
    cs -
    
    Returns:
    
    the complement of the character set cs, excluding the end-of-input marker
  - equivalent
```
public static boolean equivalent(CSet cs1,
                                 CSet cs2)
```
    Parameters:
    
    cs1 -
    
    cs2 -
    
    Returns:
    
    true if and only if the two given character sets are equivalent
  - included
```
public static boolean included(CSet cs1,
                               CSet cs2)
```
    Parameters:
    
    cs1 -
    
    cs2 -
    
    Returns:
    
    true if and only if the character set cs1 is included in cs2
  - generator
```
public static CSet.Gen generator()
```
    Returns:
    
    a character set random generator based on default configuration
  - witnesses
```
public static Iterable<Character> witnesses(CSet cset)
```
    Parameters:
    
    cset -
    
    Returns:
    
    an iterable sequence of (some, not necessary all) characters that belong to cset

Class CSet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALL

EMPTY

EOF

ALL_BUT_EOF

Constructor Detail

CSet

Method Detail

isEmpty

contains

cardinal

toString

equals

hashCode

compareTo

charToString

singleton

interval

forEach

forEachInterval

union

union

chars

inter

diff

complement

equivalent

included

generator

witnesses