モジュール java.base

パッケージ java.text

クラスStringCharacterIterator

java.lang.Object

java.text.StringCharacterIterator

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

Cloneable, CharacterIterator

public final class StringCharacterIterator extends Object implements CharacterIterator

StringCharacterIteratorは、String用のCharacterIteratorプロトコルを実装しています。 StringCharacterIteratorクラスは、特定のString全体に対する繰返し機能を提供します。 textがnullの場合、すべてのコンストラクタはNullPointerExceptionをスローします。

導入されたバージョン:

1.1

関連項目:

• CharacterIterator

フィールドのサマリー

インタフェースjava.text.CharacterIteratorで宣言されているフィールド

DONE

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
StringCharacterIterator(String text)	初期インデックス0のイテレータを構築します。
StringCharacterIterator(String text, int pos)	指定された初期インデックスを持つイテレータを構築します。
StringCharacterIterator(String text, int begin, int end, int pos)	指定された文字列の指定された範囲に対するイテレータを構築します。インデックスは指定された位置に設定します。

メソッドのサマリー

修飾子と型	メソッド	説明
Object	clone()	このイテレータのコピーを作成します。
char	current()	CharacterIterator.current()のString用実装です。
boolean	equals(Object obj)	2つのStringCharacterIteratorオブジェクトを比較して両者が等しいかどうかを判定します。
char	first()	CharacterIterator.first()のString用実装です。
int	getBeginIndex()	CharacterIterator.getBeginIndex()のString用実装です。
int	getEndIndex()	CharacterIterator.getEndIndex()のString用実装です。
int	getIndex()	CharacterIterator.getIndex()のString用実装です。
int	hashCode()	このイテレータのハッシュ・コードを計算します。
char	last()	CharacterIterator.last()のString用実装です。
char	next()	CharacterIterator.next()のString用実装です。
char	previous()	CharacterIterator.previous()のString用実装です。
char	setIndex(int p)	CharacterIterator.setIndex()のString用実装です。
void	setText(String text)	このイテレータをリセットして新しい文字列を指すようにします。

クラスjava.lang.Objectで宣言されたメソッド

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

StringCharacterIterator

public StringCharacterIterator(String text)

初期インデックス0のイテレータを構築します。

パラメータ:

text - 反復対象のString

StringCharacterIterator

public StringCharacterIterator(String text, int pos)

指定された初期インデックスを持つイテレータを構築します。

パラメータ:

text - 反復対象のString

pos - イテレータの初期位置

例外:

IllegalArgumentException - posが、0からtextまでの範囲(inclusive)の範囲内にない場合

StringCharacterIterator

public StringCharacterIterator(String text, int begin, int end, int pos)

指定された文字列の指定された範囲に対するイテレータを構築します。インデックスは指定された位置に設定します。

パラメータ:

text - 反復対象のString

begin - 先頭文字のインデックス

end - 末尾文字の次の文字のインデックス

pos - イテレータの初期位置

例外:

IllegalArgumentException - beginおよびendが0からtextまでの範囲(inclusive)の範囲内にない場合、beginがendより大きい場合、またはposがbeginからendまでの範囲(inclusive)の範囲内にない場合

メソッドの詳細

setText

public void setText(String text)

このイテレータをリセットして新しい文字列を指すようにします。 このメソッドはパッケージ内で可視であり、自身のsetTextメソッドが呼び出されるたびに新しいStringCharacterIteratorオブジェクトを割り当てたくないほかのjava.textクラスによって使用されます。

パラメータ:

text - 反復対象のString

例外:

NullPointerException - textがnullの場合

導入されたバージョン:

1.2

first

public char first()

CharacterIterator.first()のString用実装です。

定義:

first、インタフェースCharacterIterator

戻り値:

テキスト内の先頭文字。テキストが空の場合はDONE

関連項目:

• CharacterIterator.first()

last

public char last()

CharacterIterator.last()のString用実装です。

定義:

last、インタフェースCharacterIterator

戻り値:

テキスト内の最後の文字。テキストが空の場合はDONE

関連項目:

• CharacterIterator.last()

setIndex

public char setIndex(int p)

CharacterIterator.setIndex()のString用実装です。

定義:

setIndex、インタフェースCharacterIterator

パラメータ:

p - テキスト内の位置。 有効な値は、getBeginIndex()からgetEndIndex()。 無効な値を指定すると、IllegalArgumentExceptionがスローされる。

戻り値:

指定された位置にある文字。指定された位置がgetEndIndex()に等しい場合はDONE

例外:

IllegalArgumentException - pがgetBeginIndex()の(inclusive)からgetEndIndex()の範囲内にない場合

関連項目:

• CharacterIterator.setIndex(int)

current

public char current()

CharacterIterator.current()のString用実装です。

定義:

current、インタフェースCharacterIterator

戻り値:

現在位置にある文字。現在位置がテキストの終わりを過ぎている場合はDONE。

関連項目:

• CharacterIterator.current()

next

public char next()

CharacterIterator.next()のString用実装です。

定義:

next、インタフェースCharacterIterator

戻り値:

新しい位置にある文字。新しい位置がテキスト範囲の終わりを過ぎている場合はDONE。

関連項目:

• CharacterIterator.next()

previous

public char previous()

CharacterIterator.previous()のString用実装です。

定義:

previous、インタフェースCharacterIterator

戻り値:

新しい位置にある文字。現在の位置がgetBeginIndex()に等しい場合はDONE。

関連項目:

• CharacterIterator.previous()

getBeginIndex

public int getBeginIndex()

CharacterIterator.getBeginIndex()のString用実装です。

定義:

getBeginIndex、インタフェースCharacterIterator

戻り値:

テキストが始まる位置のインデックス。

関連項目:

• CharacterIterator.getBeginIndex()

getEndIndex

public int getEndIndex()

CharacterIterator.getEndIndex()のString用実装です。

定義:

getEndIndex、インタフェースCharacterIterator

戻り値:

テキスト内の最後の文字の次のインデックス

関連項目:

• CharacterIterator.getEndIndex()

getIndex

public int getIndex()

CharacterIterator.getIndex()のString用実装です。

定義:

getIndex、インタフェースCharacterIterator

戻り値:

現在のインデックス。

関連項目:

• CharacterIterator.getIndex()

equals

public boolean equals(Object obj)

2つのStringCharacterIteratorオブジェクトを比較して両者が等しいかどうかを判定します。

オーバーライド:

equals、クラスObject

パラメータ:

obj - 比較対象のStringCharacterIteratorオブジェクト。

戻り値:

指定されたobjがこのStringCharacterIteratorオブジェクトと同じである場合はtrue、そうでない場合はfalse。

関連項目:

• Object.hashCode()
• HashMap

hashCode

public int hashCode()

このイテレータのハッシュ・コードを計算します。

オーバーライド:

hashCode、クラスObject

戻り値:

ハッシュ・コード

関連項目:

• Object.equals(java.lang.Object)
• System.identityHashCode(java.lang.Object)

clone

public Object clone()

このイテレータのコピーを作成します。

定義:

clone、インタフェースCharacterIterator

オーバーライド:

clone、クラスObject

戻り値:

このイテレータのコピー

関連項目:

• Cloneable