rasmus_torkel.set.chars

Class CharSet

java.lang.Object

rasmus_torkel.set.chars.CharSet

All Implemented Interfaces:

GenericSet<java.lang.String>, JustifyingGenericSet<java.lang.String>, JustifyingStringSet, StringSet

Direct Known Subclasses:

ArrayCharSet, ComboCharSet, RangeCharSet, SingleCharSet

public abstract class CharSet
extends java.lang.Object
implements JustifyingStringSet

Defines a character set. Technically, all characters have 16 bits, but when we talk about n bit sets (where n is smaller than 16), we are implying that for all characters in the set all bits other than the least significant n are 0.

Field Summary

Fields

Modifier and Type	Field and Description
int	_bitQty Number of bits needed to represent the character.
java.lang.String	_label Free format character string which describes the set in one word or short phrase.
char	_max The highest character that the set contains.

Constructor Summary

Constructors

Constructor and Description
CharSet(char max, java.lang.String label)
CharSet(int bitQty, java.lang.String label)

Method Summary

Methods

Modifier and Type	Method and Description
int	firstOutCharPosition(java.lang.String s) Determines the position of the first character which is not in the set.
abstract boolean	isIn(char ch) Determines whether a character is in the set.
boolean	isIn(java.lang.String s) Determines whether all character of a string are in the set.
java.lang.String	outReason(java.lang.String s) Gives a reason for the object being outside the set.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_max

public final char _max

The highest character that the set contains. It is not a huge problem if this field is higher than the actual maximum, but it must not be smaller.

_bitQty

public final int _bitQty

Number of bits needed to represent the character. For example, if _max is at least 128 but less than 256, 8 bits are required.

_label

public final java.lang.String _label

Free format character string which describes the set in one word or short phrase. Also used for toString function.

Constructor Detail

CharSet

public CharSet(char max,
       java.lang.String label)

CharSet

public CharSet(int bitQty,
       java.lang.String label)

Method Detail

isIn

public abstract boolean isIn(char ch)

Determines whether a character is in the set. In this base class we treat all characters from (char)0 to _max as being in the set. However, subclasses may override this.

Parameters:

ch - The character being tested for set membership

Returns:

True if and only if ch is in the set

isIn

public boolean isIn(java.lang.String s)

Determines whether all character of a string are in the set.

Specified by:

isIn in interface GenericSet<java.lang.String>

Parameters:

s - The string for which the characters are being tested for set membership

Returns:

True if and only if all characters of s are in the set

outReason

public java.lang.String outReason(java.lang.String s)

Description copied from interface: JustifyingGenericSet

Gives a reason for the object being outside the set. The reason will be given as a phrase such as "is less than 5" or "has capital letters". The point is that the invoker can convert the object that is outside the set and prepend it to the reason.

Specified by:

outReason in interface JustifyingGenericSet<java.lang.String>

Returns:

firstOutCharPosition

public int firstOutCharPosition(java.lang.String s)

Determines the position of the first character which is not in the set. It is a precondition to this function that it has already been established that the string has a character which is not in the set.

Parameters:

s -

Returns:

position of first character not in the set.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object