org.apache.commons.lang
クラス CharSet

java.lang.Object
  org.apache.commons.lang.CharSet

すべての実装インタフェース:

Serializable

public class CharSet

extends Object

implements Serializable

文字のセット。

このインスタンスは不変(immutable)ですが、サブクラスのインスタンスはそうでない可能性があります。

導入されたバージョン:

1.0

バージョン:

$Id: CharSet.java,v 1.1.1.1 2004/02/13 10:02:05 hioki Exp $

作成者:

Henri Yandell, Stephen Colebourne, Phil Steitz, Pete Gieser, Gary Gregory

関連項目:

直列化された形式

翻訳者:

日置 聡

フィールドの概要

static CharSet	ASCII_ALPHA ASCIIのアルファベット文字 "a-zA-Z" を定義した CharSet。
static CharSet	ASCII_ALPHA_LOWER ASCIIのアルファベット文字 "a-z" を定義した CharSet。
static CharSet	ASCII_ALPHA_UPPER ASCIIのアルファベット文字 "A-Z" を定義した CharSet。
static CharSet	ASCII_NUMERIC ASCIIの数字を表す文字 "0-9" を定義した CharSet。
protected static Map	COMMON ファクトリにて使用される一般的な用法の Map。
static CharSet	EMPTY 文字が指定されていない CharSet。

コンストラクタの概要

protected	CharSet(String setStr) セットの文法を使用して新規 CharSet を生成します。
protected	CharSet(String[] set) セットの文法を使用して新規 CharSet を生成します。

メソッドの概要

protected void	add(String str) CharSet に定義文字列を追加します。
boolean	contains(char ch) 指定された文字 ch がこの CharSet に含まれるかどうかを評価します。
boolean	equals(Object obj) 2つの CharSet オブジェクトを比較し、同じ方法で同じ文字セットを示している場合に true を返します。
CharRange[]	getCharRanges() 内部の CharRange オブジェクトの配列を取得します。
static CharSet	getInstance(String setStr) 特有の文法を使用して新規 CharSet を生成するファクトリメソッドです。
int	hashCode() equals メソッドと互換性のあるハッシュコードを取得します。
String	toString() このセットの文字列表現を取得します。

クラス java.lang.Object から継承したメソッド

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

フィールドの詳細

EMPTY

public static final CharSet EMPTY

文字が指定されていない CharSet。

導入されたバージョン:

2.0

ASCII_ALPHA

public static final CharSet ASCII_ALPHA

ASCIIのアルファベット文字 "a-zA-Z" を定義した CharSet。

導入されたバージョン:

2.0

ASCII_ALPHA_LOWER

public static final CharSet ASCII_ALPHA_LOWER

ASCIIのアルファベット文字 "a-z" を定義した CharSet。

導入されたバージョン:

2.0

ASCII_ALPHA_UPPER

public static final CharSet ASCII_ALPHA_UPPER

ASCIIのアルファベット文字 "A-Z" を定義した CharSet。

導入されたバージョン:

2.0

ASCII_NUMERIC

public static final CharSet ASCII_NUMERIC

ASCIIの数字を表す文字 "0-9" を定義した CharSet。

導入されたバージョン:

2.0

COMMON

protected static final Map COMMON

ファクトリにて使用される一般的な用法の Map。 必要があればサブクラスにて一般的なパターンを追加することができます。

導入されたバージョン:

2.0

コンストラクタの詳細

CharSet

protected CharSet(String setStr)

セットの文法を使用して新規 CharSet を生成します。

パラメータ:

setStr - セットを定義する String、 null を許可します。

導入されたバージョン:

2.0

CharSet

protected CharSet(String[] set)

セットの文法を使用して新規 CharSet を生成します。 各文字列はセット内でマージされます。

パラメータ:

set - セットの初期化でマージされる文字列の配列

例外:

NullPointerException - set が null だった場合

メソッドの詳細

getInstance

public static CharSet getInstance(String setStr)

特有の文法を使用して新規 CharSet を生成するファクトリメソッドです。

• null または空文字列("") - 文字を含まないセット
• "a" のような単一の文字 - 指定された文字のみをもつセット
• "a-e" のような複数の文字 - 指定された文字の間に位置する文字をもつセット
• "^a" または "^a-e" のような否定条件 - 指定された文字以外の全ての文字をもつセット
• "abe-g" のような組み合わせ - 個々の条件に該当する全ての文字をもつセット

適用の順番は以下のようになります:

1. "^a-e" のような複数の文字範囲の否定条件
2. "a-e" のような複数の文字範囲の通常の指定
3. "^a" のような単一の文字の否定条件
4. "a" のような単一の文字の通常の指定

指定の適用は左から右に行われます。 1度適用できる記述が見つかると次の文字から再び適用できる記述を探します。

同じ文法で記述された同じ範囲が2度見つかった場合には1つだけ保持します。 従って "a-ca-c" の記述は "a-c" の範囲のみを生成します。

開始と終了の文字の順番が正しくない場合、逆に置き換えられます。 従って a-e の指定は e-a と等しくなります。 "a-e" と "e-a" は同等なため、 "a-ee-a" の記述は1つの範囲のみを生成します。

表現される文字のセットは指定された(複数の)範囲の集合となります。 The set of characters represented is the union of the specified ranges.}

このメソッドで返される全ての CharSet オブジェクトは不変(immutable)です。

パラメータ:

setStr - セットを記述した String、null を許可します

戻り値:

a CharSet インスタンス

導入されたバージョン:

2.0

add

protected void add(String str)

CharSet に定義文字列を追加します。

パラメータ:

str - セットを定義する文字列

getCharRanges

public CharRange[] getCharRanges()

内部の CharRange オブジェクトの配列を取得します。

戻り値:

不変(immutable)な CharRange オブジェクトの配列

導入されたバージョン:

2.0

contains

public boolean contains(char ch)

指定された文字 ch がこの CharSet に含まれるかどうかを評価します。

パラメータ:

ch - チェック対象となる文字

戻り値:

指定された文字が文字セットに含まれる場合、true

equals

public boolean equals(Object obj)

2つの CharSet オブジェクトを比較し、同じ方法で同じ文字セットを示している場合に true を返します。

このメソッドでは abc と a-c の2つの文字セットは等しいとみなされません。

パラメータ:

obj - 比較対照となるオブジェクト

戻り値:

true 等しい場合、true

導入されたバージョン:

2.0

hashCode

public int hashCode()

equals メソッドと互換性のあるハッシュコードを取得します。

戻り値:

適切なハッシュコード

導入されたバージョン:

2.0

toString

public String toString()

このセットの文字列表現を取得します。

戻り値:

このセットの文字列表現