com.nobigsoftware.dfalex

Class CharRange.Builder

java.lang.Object

com.nobigsoftware.dfalex.CharRange.Builder

Enclosing class:

CharRange

public static class CharRange.Builder
extends java.lang.Object

Instances of this class are used to incrementally build CharRanges

Initially it contains an empty set of matching characters (CharRange.NONE). Methods like addChars, addRange, exclude, etc. are called to add and remove characters from the set, and then build() is called to produce an immutable CharRange object that matches characters in the set.

Constructor Summary

Constructors

Constructor and Description
Builder() Create a new Builder.

Method Summary

Modifier and Type	Method and Description
CharRange.Builder	addChar(char c) Add a character to the current set
CharRange.Builder	addChars(java.lang.String chars) Add characters to the current set
CharRange.Builder	addRange(char first, char last) Add a range of characters to the current set
CharRange.Builder	addRange(CharRange cr) Add characters from another CharRange
CharRange	build() Produce a CharRange for the current set
CharRange.Builder	clear() Clears the current range.
CharRange.Builder	exclude(CharRange cr) Remove characters from another CharRange
CharRange.Builder	expandCases() Make the current range case independent.
CharRange.Builder	intersect(CharRange cr) Intersect with another CharRange
CharRange.Builder	invert() Invert the current set

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Create a new Builder.

It's usually a little more convenient to use CharRange.builder()

Method Detail

clear

public CharRange.Builder clear()

Clears the current range.

After this call, build() will return CharRange.NONE

Returns:

this

addChar

public CharRange.Builder addChar(char c)

Add a character to the current set

Parameters:

c - This character will be added to the set

Returns:

this

addChars

public CharRange.Builder addChars(java.lang.String chars)

Add characters to the current set

Parameters:

chars - All characters in this string will be added to the set

Returns:

this

addRange

public CharRange.Builder addRange(char first,
                                  char last)

Add a range of characters to the current set

Adds all characters x such that first <= x and x <= last

Parameters:

first - least-valued character to add

last - greatest-valued character to add

Returns:

this

addRange

public CharRange.Builder addRange(CharRange cr)

Add characters from another CharRange

Parameters:

cr - All characters matched by this CharRange will be added to the current set

Returns:

this

exclude

public final CharRange.Builder exclude(CharRange cr)

Remove characters from another CharRange

This is implemented using invert() and addRange(CharRange)

Parameters:

cr - All characters matched by this CharRange will be removed from the current set

Returns:

this

intersect

public final CharRange.Builder intersect(CharRange cr)

Intersect with another CharRange

This is implemented by exclude(CharRange)ing cr.getComplement()

Parameters:

cr - All characters that are NOT matched by this CharRange will be removed from the current set

Returns:

this

expandCases

public CharRange.Builder expandCases()

Make the current range case independent.

For every char c in the range, Character.toUpperCase(c) and Character.toLowerCase(c) are added.

Returns:

this

invert

public CharRange.Builder invert()

Invert the current set

When this returns the current set will include only those characters that were NOT in the set before the call.

Returns:

this

build

public CharRange build()

Produce a CharRange for the current set

This method does not alter the current set in any way -- it may be further modified and used to produce more CharRange objects.

Returns:

the new CharRange. Multiple calls that build equivalent ranges may or may not return the same object.