International Components for Unicode for Java (icu4j) 74.2 · com.ibm.icu.text.StringCharacterIterator

Modifier and Type	Field and Description
private int	begin
private int	end
private int	pos
private String	text

Access	Constructor and Description
public	StringCharacterIterator(String text) Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Constructs an iterator with an initial index of 0.
public	StringCharacterIterator(String The String to be iterated over text, int Initial iterator position pos) Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Constructs an iterator with the specified initial index.
public	StringCharacterIterator(String The String to be iterated over text, int Index of the first character begin, int Index of the character following the last character end, int Initial iterator position pos) Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Constructs an iterator over the given range of the given string, with the index set at the specified position.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: A copy of this clone() Overrides java.lang.Object.clone. Implements java.text.CharacterIterator.clone. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Creates a copy of this iterator.
public char	current() Implements java.text.CharacterIterator.current. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.current() for String.
public boolean	Returns: true if the given obj is the same as this StringCharacterIterator object; false otherwise. equals(Object the StringCharacterIterator object to be compared with. obj) Overrides java.lang.Object.equals. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Compares the equality of two StringCharacterIterator objects.
public char	first() Implements java.text.CharacterIterator.first. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.first() for String.
public int	getBeginIndex() Implements java.text.CharacterIterator.getBeginIndex. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.getBeginIndex() for String.
public int	getEndIndex() Implements java.text.CharacterIterator.getEndIndex. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.getEndIndex() for String.
public int	getIndex() Implements java.text.CharacterIterator.getIndex. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.getIndex() for String.
public int	Returns: A hash code hashCode() Overrides java.lang.Object.hashCode. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Computes a hashcode for this iterator.
public char	last() Implements java.text.CharacterIterator.last. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.last() for String.
public char	next() Implements java.text.CharacterIterator.next. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.next() for String.
public char	previous() Implements java.text.CharacterIterator.previous. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.previous() for String.
public char	setIndex(int the position within the text. Valid values range from getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown if an invalid value is supplied. p) Implements java.text.CharacterIterator.setIndex. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.setIndex() for String.
public void	setText(String The String to be iterated over text) Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Reset this iterator to point to a new string.

Inherited from java.lang.Object:: finalize getClass notify notifyAll toString wait wait wait

begin	back to summary
private int begin

end	back to summary
private int end

pos	back to summary
private int pos

text	back to summary
private String text

StringCharacterIterator	back to summary
public StringCharacterIterator(String text) Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Constructs an iterator with an initial index of 0. Annotations @Deprecated

StringCharacterIterator	back to summary
public StringCharacterIterator(String text, int pos) Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Constructs an iterator with the specified initial index. Parameters text:String The String to be iterated over pos:int Initial iterator position Annotations @Deprecated

StringCharacterIterator	back to summary
public StringCharacterIterator(String text, int begin, int end, int pos) Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Constructs an iterator over the given range of the given string, with the index set at the specified position. Parameters text:String The String to be iterated over begin:int Index of the first character end:int Index of the character following the last character pos:int Initial iterator position Annotations @Deprecated

Method Detail

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Implements java.text.CharacterIterator.clone. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Creates a copy of this iterator. Returns:Object A copy of this Annotations @Deprecated

clone

back to summary

public Object clone()

Overrides java.lang.Object.clone.

Implements java.text.CharacterIterator.clone.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Creates a copy of this iterator.

Returns:Object

A copy of this

Annotations

@Deprecated

current back to summary

current	back to summary
public char current() Implements java.text.CharacterIterator.current. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.current() for String. Returns:char Doc from java.text.CharacterIterator.current. the character at the current position or DONE if the current position is off the end of the text. Annotations @Deprecated See Also `CharacterIterator#current`

public char current()

Implements java.text.CharacterIterator.current.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Implements CharacterIterator.current() for String.

Returns:char

Doc from java.text.CharacterIterator.current.

the character at the current position or DONE if the current position is off the end of the text.

Annotations

@Deprecated

See Also

CharacterIterator#current

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Compares the equality of two StringCharacterIterator objects. Parameters obj:Object the StringCharacterIterator object to be compared with. Returns:boolean true if the given obj is the same as this StringCharacterIterator object; false otherwise. Annotations @Deprecated

equals

back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Compares the equality of two StringCharacterIterator objects.

Parameters

obj:Object: the StringCharacterIterator object to be compared with.

Returns:boolean

true if the given obj is the same as this StringCharacterIterator object; false otherwise.

Annotations

@Deprecated

first back to summary

first	back to summary
public char first() Implements java.text.CharacterIterator.first. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.first() for String. Returns:char Doc from java.text.CharacterIterator.first. the first character in the text, or DONE if the text is empty Annotations @Deprecated See Also `CharacterIterator#first`

public char first()

Implements java.text.CharacterIterator.first.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Implements CharacterIterator.first() for String.

Returns:char

Doc from java.text.CharacterIterator.first.

the first character in the text, or DONE if the text is empty

Annotations

@Deprecated

See Also

CharacterIterator#first

getBeginIndex back to summary

getBeginIndex	back to summary
public int getBeginIndex() Implements java.text.CharacterIterator.getBeginIndex. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.getBeginIndex() for String. Returns:int Doc from java.text.CharacterIterator.getBeginIndex. the index at which the text begins. Annotations @Deprecated See Also `CharacterIterator#getBeginIndex`

public int getBeginIndex()

Implements java.text.CharacterIterator.getBeginIndex.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Implements CharacterIterator.getBeginIndex() for String.

Returns:int

Doc from java.text.CharacterIterator.getBeginIndex.

the index at which the text begins.

Annotations

@Deprecated

See Also

CharacterIterator#getBeginIndex

getEndIndex back to summary

getEndIndex	back to summary
public int getEndIndex() Implements java.text.CharacterIterator.getEndIndex. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.getEndIndex() for String. Returns:int Doc from java.text.CharacterIterator.getEndIndex. the index after the last character in the text Annotations @Deprecated See Also `CharacterIterator#getEndIndex`

public int getEndIndex()

Implements java.text.CharacterIterator.getEndIndex.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Implements CharacterIterator.getEndIndex() for String.

Returns:int

Doc from java.text.CharacterIterator.getEndIndex.

the index after the last character in the text

Annotations

@Deprecated

See Also

CharacterIterator#getEndIndex

getIndex back to summary

getIndex	back to summary
public int getIndex() Implements java.text.CharacterIterator.getIndex. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.getIndex() for String. Returns:int Doc from java.text.CharacterIterator.getIndex. the current index. Annotations @Deprecated See Also `CharacterIterator#getIndex`

public int getIndex()

Implements java.text.CharacterIterator.getIndex.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Implements CharacterIterator.getIndex() for String.

Returns:int

Doc from java.text.CharacterIterator.getIndex.

the current index.

Annotations

@Deprecated

See Also

CharacterIterator#getIndex

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Computes a hashcode for this iterator. Returns:int A hash code Annotations @Deprecated

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Computes a hashcode for this iterator.

Returns:int

A hash code

Annotations

@Deprecated

last back to summary

last	back to summary
public char last() Implements java.text.CharacterIterator.last. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.last() for String. Returns:char Doc from java.text.CharacterIterator.last. the last character in the text, or DONE if the text is empty Annotations @Deprecated See Also `CharacterIterator#last`

public char last()

Implements java.text.CharacterIterator.last.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Implements CharacterIterator.last() for String.

Returns:char

Doc from java.text.CharacterIterator.last.

the last character in the text, or DONE if the text is empty

Annotations

@Deprecated

See Also

CharacterIterator#last

next back to summary

next	back to summary
public char next() Implements java.text.CharacterIterator.next. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.next() for String. Returns:char Doc from java.text.CharacterIterator.next. the character at the new position or DONE if the new position is off the end of the text range. Annotations @Deprecated See Also `CharacterIterator#next`

public char next()

Implements java.text.CharacterIterator.next.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Implements CharacterIterator.next() for String.

Returns:char

Doc from java.text.CharacterIterator.next.

the character at the new position or DONE if the new position is off the end of the text range.

Annotations

@Deprecated

See Also

CharacterIterator#next

previous back to summary

previous	back to summary
public char previous() Implements java.text.CharacterIterator.previous. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.previous() for String. Returns:char Doc from java.text.CharacterIterator.previous. the character at the new position or DONE if the current position is equal to getBeginIndex(). Annotations @Deprecated See Also `CharacterIterator#previous`

public char previous()

Implements java.text.CharacterIterator.previous.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Implements CharacterIterator.previous() for String.

Returns:char

Doc from java.text.CharacterIterator.previous.

the character at the new position or DONE if the current position is equal to getBeginIndex().

Annotations

@Deprecated

See Also

CharacterIterator#previous

setIndex back to summary

setIndex	back to summary
public char setIndex(int p) Implements java.text.CharacterIterator.setIndex. Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Implements CharacterIterator.setIndex() for String. Parameters p:int Doc from java.text.CharacterIterator.setIndex. the position within the text. Valid values range from getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown if an invalid value is supplied. Returns:char Doc from java.text.CharacterIterator.setIndex. the character at the specified position or DONE if the specified position is equal to getEndIndex() Annotations @Deprecated See Also `CharacterIterator#setIndex`

public char setIndex(int p)

Implements java.text.CharacterIterator.setIndex.

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Implements CharacterIterator.setIndex() for String.

Parameters

p:int

Doc from java.text.CharacterIterator.setIndex.

the position within the text. Valid values range from getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown if an invalid value is supplied.

Returns:char

Doc from java.text.CharacterIterator.setIndex.

the character at the specified position or DONE if the specified position is equal to getEndIndex()

Annotations

@Deprecated

See Also

CharacterIterator#setIndex

setText	back to summary
public void setText(String text) Deprecated ICU 2.4. Use java.text.StringCharacterIterator instead. Reset this iterator to point to a new string. This package-visible method is used by other java.text classes that want to avoid allocating new StringCharacterIterator objects every time their setText method is called. Parameters text:String The String to be iterated over Annotations @Deprecated

setText

back to summary

public void setText(String text)

Deprecated

ICU 2.4. Use java.text.StringCharacterIterator instead.

Reset this iterator to point to a new string. This package-visible method is used by other java.text classes that want to avoid allocating new StringCharacterIterator objects every time their setText method is called.

Parameters

text:String: The String to be iterated over

Annotations

@Deprecated

public final Class StringCharacterIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail