OpenJDK 27 · javax.swing.text.Segment · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public char[]	array This is the array containing the text of interest.
pack-priv boolean	copy Whether the array is a copy of data or not.
public int	count This is the number of array elements that make up the text of interest.
public int	offset This is the offset into the array that the desired text begins.
private boolean	partialReturn
private int	pos

Access	Constructor and Description
public	Segment() Creates a new segment.
public	Segment(char[] the array to refer to array, int the offset into the array offset, int the number of characters count) Creates a new segment referring to an existing array.

Method Summary

Modifier and Type	Method and Description
public char	charAt(int index) Implements java.lang.CharSequence.charAt. Returns the `char` value at the specified index.
public Object	Returns: the copy clone() Overrides java.lang.Object.clone. Implements java.text.CharacterIterator.clone. Creates a shallow copy.
public char	Returns: the character at the current position or DONE if the current position is off the end of the text. current() Implements java.text.CharacterIterator.current. Gets the character at the current position (as returned by getIndex()).
public char	Returns: the first character in the text, or DONE if the text is empty first() Implements java.text.CharacterIterator.first. Sets the position to getBeginIndex() and returns the character at that position.
public int	Returns: the index at which the text begins. getBeginIndex() Implements java.text.CharacterIterator.getBeginIndex. Returns the start index of the text.
public int	Returns: the index after the last character in the text getEndIndex() Implements java.text.CharacterIterator.getEndIndex. Returns the end index of the text.
public int	Returns: the current index. getIndex() Implements java.text.CharacterIterator.getIndex. Returns the current index.
public boolean	Returns: whether or not partial returns are valid. isPartialReturn() Flag to indicate that partial returns are valid.
public char	Returns: the last character in the text, or DONE if the text is empty last() Implements java.text.CharacterIterator.last. Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
public int	length() Implements java.lang.CharSequence.length. Returns the length of this character sequence.
public char	Returns: the character at the new position or DONE if the new position is off the end of the text range. next() Implements java.text.CharacterIterator.next. Increments the iterator's index by one and returns the character at the new index.
public char	Returns: the character at the new position or DONE if the current position is equal to getBeginIndex(). previous() Implements java.text.CharacterIterator.previous. Decrements the iterator's index by one and returns the character at the new index.
public char	Returns: the character at the specified position or DONE if the specified position is equal to getEndIndex() setIndex(int the position within the text. Valid values range from getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown if an invalid value is supplied. position) Implements java.text.CharacterIterator.setIndex. Sets the position to the specified position in the text and returns that character.
public void	setPartialReturn(boolean whether or not partial returns are valid. p) Flag to indicate that partial returns are valid.
public CharSequence	subSequence(int start, int end) Implements java.lang.CharSequence.subSequence. Returns a `CharSequence` that is a subsequence of this sequence.
public String	Returns: the string toString() Overrides java.lang.Object.toString. Implements java.lang.CharSequence.toString. Converts a segment into a String.

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

array	back to summary
public char[] array This is the array containing the text of interest. This array should never be modified; it is available only for efficiency.

copy	back to summary
pack-priv boolean copy Whether the array is a copy of data or not.

count	back to summary
public int count This is the number of array elements that make up the text of interest.

offset	back to summary
public int offset This is the offset into the array that the desired text begins.

partialReturn	back to summary
private boolean partialReturn

pos	back to summary
private int pos

Segment	back to summary
public Segment() Creates a new segment.

Segment	back to summary
public Segment(char[] array, int offset, int count) Creates a new segment referring to an existing array. Parameters array:char[] the array to refer to offset:int the offset into the array count:int the number of characters

Method Detail

charAt back to summary

charAt	back to summary
public char charAt(int index) Implements java.lang.CharSequence.charAt. Doc from java.lang.CharSequence.charAt. Returns the `char` value at the specified index. An index ranges from zero to `length() - 1`. The first `char` value of the sequence is at index zero, the next at index one, and so on, as for array indexing. If the `char` value specified by the index is a surrogate, the surrogate value is returned. Since 1.6

public char charAt(int index)

Implements java.lang.CharSequence.charAt.

Doc from java.lang.CharSequence.charAt.

Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Since: 1.6

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Implements java.text.CharacterIterator.clone. Creates a shallow copy. Returns:Object the copy

clone

back to summary

public Object clone()

Overrides java.lang.Object.clone.

Implements java.text.CharacterIterator.clone.

Creates a shallow copy.

Returns:Object: the copy

current back to summary

current	back to summary
public char current() Implements java.text.CharacterIterator.current. Gets the character at the current position (as returned by getIndex()). Returns:char the character at the current position or DONE if the current position is off the end of the text. Since 1.3 See Also `getIndex`

public char current()

Implements java.text.CharacterIterator.current.

Gets the character at the current position (as returned by getIndex()).

Returns:char: the character at the current position or DONE if the current position is off the end of the text.
Since: 1.3
See Also: getIndex

first back to summary

first	back to summary
public char first() Implements java.text.CharacterIterator.first. Sets the position to getBeginIndex() and returns the character at that position. Returns:char the first character in the text, or DONE if the text is empty Since 1.3 See Also `getBeginIndex`

public char first()

Implements java.text.CharacterIterator.first.

Sets the position to getBeginIndex() and returns the character at that position.

Returns:char: the first character in the text, or DONE if the text is empty
Since: 1.3
See Also: getBeginIndex

getBeginIndex	back to summary
public int getBeginIndex() Implements java.text.CharacterIterator.getBeginIndex. Returns the start index of the text. Returns:int the index at which the text begins. Since 1.3

getBeginIndex

back to summary

public int getBeginIndex()

Implements java.text.CharacterIterator.getBeginIndex.

Returns the start index of the text.

Returns:int: the index at which the text begins.
Since: 1.3

getEndIndex	back to summary
public int getEndIndex() Implements java.text.CharacterIterator.getEndIndex. Returns the end index of the text. This index is the index of the first character following the end of the text. Returns:int the index after the last character in the text Since 1.3

getEndIndex

back to summary

public int getEndIndex()

Implements java.text.CharacterIterator.getEndIndex.

Returns the end index of the text. This index is the index of the first character following the end of the text.

Returns:int: the index after the last character in the text
Since: 1.3

getIndex	back to summary
public int getIndex() Implements java.text.CharacterIterator.getIndex. Returns the current index. Returns:int the current index. Since 1.3

getIndex

back to summary

public int getIndex()

Implements java.text.CharacterIterator.getIndex.

Returns the current index.

Returns:int: the current index.
Since: 1.3

isPartialReturn	back to summary
public boolean isPartialReturn() Flag to indicate that partial returns are valid. Returns:boolean whether or not partial returns are valid. Since 1.4

isPartialReturn

back to summary

public boolean isPartialReturn()

Flag to indicate that partial returns are valid.

Returns:boolean: whether or not partial returns are valid.
Since: 1.4

last back to summary

last	back to summary
public char last() Implements java.text.CharacterIterator.last. Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position. Returns:char the last character in the text, or DONE if the text is empty Since 1.3 See Also `getEndIndex`

public char last()

Implements java.text.CharacterIterator.last.

Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.

Returns:char: the last character in the text, or DONE if the text is empty
Since: 1.3
See Also: getEndIndex

length back to summary

length	back to summary
public int length() Implements java.lang.CharSequence.length. Doc from java.lang.CharSequence.length. Returns the length of this character sequence. The length is the number of 16-bit `char`s in the sequence. Since 1.6

public int length()

Implements java.lang.CharSequence.length.

Doc from java.lang.CharSequence.length.

Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Since: 1.6

next	back to summary
public char next() Implements java.text.CharacterIterator.next. Increments the iterator's index by one and returns the character at the new index. If the resulting index is greater or equal to getEndIndex(), the current index is reset to getEndIndex() and a value of DONE is returned. Returns:char the character at the new position or DONE if the new position is off the end of the text range. Since 1.3

back to summary

public char next()

Implements java.text.CharacterIterator.next.

Increments the iterator's index by one and returns the character at the new index. If the resulting index is greater or equal to getEndIndex(), the current index is reset to getEndIndex() and a value of DONE is returned.

Returns:char: the character at the new position or DONE if the new position is off the end of the text range.
Since: 1.3

previous	back to summary
public char previous() Implements java.text.CharacterIterator.previous. Decrements the iterator's index by one and returns the character at the new index. If the current index is getBeginIndex(), the index remains at getBeginIndex() and a value of DONE is returned. Returns:char the character at the new position or DONE if the current position is equal to getBeginIndex(). Since 1.3

back to summary

public char previous()

Implements java.text.CharacterIterator.previous.

Decrements the iterator's index by one and returns the character at the new index. If the current index is getBeginIndex(), the index remains at getBeginIndex() and a value of DONE is returned.

Returns:char: the character at the new position or DONE if the current position is equal to getBeginIndex().
Since: 1.3

setIndex	back to summary
public char setIndex(int position) Implements java.text.CharacterIterator.setIndex. Sets the position to the specified position in the text and returns that character. Parameters position:int the position within the text. Valid values range from getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown if an invalid value is supplied. Returns:char the character at the specified position or DONE if the specified position is equal to getEndIndex() Since 1.3

setIndex

back to summary

public char setIndex(int position)

Implements java.text.CharacterIterator.setIndex.

Sets the position to the specified position in the text and returns that character.

Parameters

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

Returns:char

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

Since

1.3

setPartialReturn	back to summary
public void setPartialReturn(boolean p) Flag to indicate that partial returns are valid. If the flag is true, an implementation of the interface method Document.getText(position,length,Segment) should return as much text as possible without making a copy. The default state of the flag is false which will cause Document.getText(position,length,Segment) to provide the same return behavior it always had, which may or may not make a copy of the text depending upon the request. Parameters p:boolean whether or not partial returns are valid. Since 1.4

setPartialReturn

back to summary

public void setPartialReturn(boolean p)

Flag to indicate that partial returns are valid. If the flag is true, an implementation of the interface method Document.getText(position,length,Segment) should return as much text as possible without making a copy. The default state of the flag is false which will cause Document.getText(position,length,Segment) to provide the same return behavior it always had, which may or may not make a copy of the text depending upon the request.

Parameters

p:boolean: whether or not partial returns are valid.

Since

1.4

subSequence back to summary

subSequence	back to summary
public CharSequence subSequence(int start, int end) Implements java.lang.CharSequence.subSequence. Doc from java.lang.CharSequence.subSequence. Returns a `CharSequence` that is a subsequence of this sequence. The subsequence starts with the `char` value at the specified index and ends with the `char` value at index `end - 1`. The length (in `char`s) of the returned sequence is `end - start`, so if `start == end` then an empty sequence is returned. Since 1.6

public CharSequence subSequence(int start, int end)

Implements java.lang.CharSequence.subSequence.

Doc from java.lang.CharSequence.subSequence.

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Since: 1.6

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements java.lang.CharSequence.toString. Converts a segment into a String. Returns:String the string

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Implements java.lang.CharSequence.toString.

Converts a segment into a String.

Returns:String: the string

public Class Segment

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail