org.apache.commons.lang
クラス CharSet

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

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

Serializable

public class CharSet

extends Object

implements Serializable

文字のセット。

A set of characters.

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

Instances are immutable, but instances of subclasses may not be.

導入されたバージョン:

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

関連項目:

直列化された形式

翻訳者:

日置 聡

翻訳状況:

初稿(校正者募集中)

翻訳更新日:

2003/09/05

フィールドの概要

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。

A CharSet defining no characters.

導入されたバージョン:

2.0

ASCII_ALPHA

public static final CharSet ASCII_ALPHA

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

A CharSet defining ASCII alphabetic characters "a-zA-Z".

導入されたバージョン:

2.0

ASCII_ALPHA_LOWER

public static final CharSet ASCII_ALPHA_LOWER

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

A CharSet defining ASCII alphabetic characters "a-z".

導入されたバージョン:

2.0

ASCII_ALPHA_UPPER

public static final CharSet ASCII_ALPHA_UPPER

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

A CharSet defining ASCII alphabetic characters "A-Z".

導入されたバージョン:

2.0

ASCII_NUMERIC

public static final CharSet ASCII_NUMERIC

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

A CharSet defining ASCII alphabetic characters "0-9".

導入されたバージョン:

2.0

COMMON

protected static final Map COMMON

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

A Map of the common cases used in the factory. Subclasses can add more common patterns if desired.

導入されたバージョン:

2.0

コンストラクタの詳細

CharSet

protected CharSet(String setStr)

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

Constructs a new CharSet using the set syntax.

パラメータ:

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

the String describing the set, may be null

導入されたバージョン:

2.0

CharSet

protected CharSet(String[] set)

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

Constructs a new CharSet using the set syntax. Each string is merged in with the set.

パラメータ:

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

Strings to merge into the initial set

例外:

NullPointerException - set が null だった場合

if set is null

メソッドの詳細

getInstance

public static CharSet getInstance(String setStr)

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

Factory method to create a new CharSet using a special syntax.

• null または空文字列("") - 文字を含まないセット
  null or empty string ("") - set containing no characters
• "a" のような単一の文字 - 指定された文字のみをもつセット
  Single character, such as "a" - set containing just that character
• "a-e" のような複数の文字 - 指定された文字の間に位置する文字をもつセット
  Multi character, such as "a-e" - set containing characters from one character to the other
• "^a" または "^a-e" のような否定条件 - 指定された文字以外の全ての文字をもつセット
  Negated, such as "^a" or "^a-e" - set containing all characters except those defined
• "abe-g" のような組み合わせ - 個々の条件に該当する全ての文字をもつセット
  Combinations, such as "abe-g" - set containing all the characters from the individual sets

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

The matching order is:

1. "^a-e" のような複数の文字範囲の否定条件
   Negated multi character range, such as "^a-e"
2. "a-e" のような複数の文字範囲の通常の指定
   Ordinary multi character range, such as "a-e"
3. "^a" のような単一の文字の否定条件
   Negated single character, such as "^a"
4. "a" のような単一の文字の通常の指定
   Ordinary single character, such as "a"

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

Matching works left to right. Once a match is found the search starts again from the next character.

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

If the same range is defined twice using the same syntax, only one range will be kept. Thus, "a-ca-c" creates only one range of "a-c".

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

If the start and end of a range are in the wrong order, they are reversed. Thus "a-e" is the same as "e-a". As a result, "a-ee-a" would create only one range, as the "a-e" and "e-a" are the same.

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

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

All CharSet objects returned by this method will be immutable.

パラメータ:

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

the String describing the set, may be null

戻り値:

a CharSet インスタンス

a CharSet instance

導入されたバージョン:

2.0

add

protected void add(String str)

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

Add a set definition string to the CharSet.

パラメータ:

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

set definition string

getCharRanges

public CharRange[] getCharRanges()

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

Gets the internal set as an array of CharRange objects.

戻り値:

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

an array of immutable CharRange objects

導入されたバージョン:

2.0

contains

public boolean contains(char ch)

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

Does the CharSet contain the specified character ch.

パラメータ:

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

the character to check for

戻り値:

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

true if the set contains the characters

equals

public boolean equals(Object obj)

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

Compares two CharSet objects, returning true if they represent exactly the same set of characters defined in the same way.

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

The two sets abc and a-c are not equal according to this method.

パラメータ:

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

the object to compare to

戻り値:

true 等しい場合、true

true if equal

導入されたバージョン:

2.0

hashCode

public int hashCode()

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

Gets a hashCode compatable with the equals method.

戻り値:

適切なハッシュコード

a suitable hashCode

導入されたバージョン:

2.0

toString

public String toString()

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

Gets a string representation of the set.

戻り値:

このセットの文字列表現

string representation of the set