CharSet (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.d2d2.infra.CharSet

All Implemented Interfaces:

Serializable, Cloneable
```
public class CharSet
extends Object
implements Cloneable, Serializable
```
Implements Character Sets as an ordered sequence of ranges.
Behaves already IMMUTABLE.
ALGEBRAIC "equals()" MISSING FIXME.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class CharSet.CharRange

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`CharSet.CharRange`

Field Summary

Fields
Modifier and Type	Field and Description
`static CharSet`	`EMPTY_SET`
`static char`	`HI` Highest possible character value, currently `0xffffffff`, needed for the definition of `negate()`.
`protected List<CharSet.CharRange>`	`list`
`static char`	`LOW` Lowest possible character value, currently `0x0000`, needed for the definition of `negate()`.

Constructor Summary

Constructors
Constructor and Description
`CharSet()`
`CharSet(char l)`
`CharSet(char l, char u)` Creates a `CharSet` containing the range from `l` to `u`.
`CharSet(String s)` Creates a `CharSet` containing the all characters contained in the string argument.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(char c)`
`CharSet`	`cut(CharSet cs2)`
`CharSet`	`join(CharSet cs2)`
`static CharSet`	`makeCharSet(String chars)` Returns a `CharSet` containing the all characters contained in the string argument.
`CharSet`	`negate()`
`Character`	`singletonContents()`
`static String`	`staticStringRepD2d(CharSet cs)`
`String`	`stringRep()`
`String`	`stringRepD2d()`
`protected static String`	`xn(char c)`

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

- Field Detail
  - LOW
```
public static final char LOW
```
    Lowest possible character value, currently 0x0000, needed for the definition of negate().
    
    See Also:
    
    Constant Field Values
  - HI
```
public static final char HI
```
    Highest possible character value, currently 0xffffffff, needed for the definition of negate().
    
    See Also:
    
    Constant Field Values
  - list
```
protected List<CharSet.CharRange> list
```
  - EMPTY_SET
```
public static final CharSet EMPTY_SET
```
- Constructor Detail
  - CharSet
```
public CharSet()
```
  - CharSet
```
public CharSet(char l,
               char u)
```
    Creates a CharSet containing the range from l to u.
    
    Throws:
    
    IllegalArgumentException - in case l is nuermically larger than u.
  - CharSet
```
public CharSet(char l)
```
  - CharSet
```
public CharSet(String s)
```
    Creates a CharSet containing the all characters contained in the string argument.
- Method Detail
  - makeCharSet
```
public static CharSet makeCharSet(String chars)
```
    Returns a CharSet containing the all characters contained in the string argument.
  - contains
```
public boolean contains(char c)
```
  - singletonContents
```
public Character singletonContents()
```
    Returns:
    
    the only member of this, if it is a singleton set, otherwise null.
  - cut
```
public CharSet cut(CharSet cs2)
```
  - negate
```
public CharSet negate()
```
  - join
```
public CharSet join(CharSet cs2)
```
  - xn
```
protected static String xn(char c)
```
  - stringRep
```
public String stringRep()
```
    Returns:
    
    a symbolic string representation, showing characters and decimal values.
  - stringRepD2d
```
public String stringRepD2d()
```
    Returns:
    
    the un-parsed representation according to D2d module syntax.
  - staticStringRepD2d
```
public static String staticStringRepD2d(CharSet cs)
```

Class CharSet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOW

HI

list

EMPTY_SET

Constructor Detail

CharSet

CharSet

CharSet

CharSet

Method Detail

makeCharSet

contains

singletonContents

cut

negate

join

xn

stringRep

stringRepD2d

staticStringRepD2d