net.sf.extjwnl.util

Interface PointedCharSequence

All Superinterfaces:

java.lang.CharSequence

All Known Implementing Classes:

ByteArrayCharSequence, CharBufferCharSequence

public interface PointedCharSequence
extends java.lang.CharSequence

PointedCharSequence is a char sequence with the position of its last byte in the original file.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.String anotherString) Compares the sequence and the string lexicographically.
long	getLastBytePosition() Position of the last byte of this sequence in the file (exclusive).
int	indexOf(java.lang.String str) Returns the index within this sequence of the first occurrence of the specified substring.

Methods inherited from interface java.lang.CharSequence

charAt, chars, codePoints, length, subSequence, toString

Method Detail

getLastBytePosition

long getLastBytePosition()

Position of the last byte of this sequence in the file (exclusive).

Returns:

position of the last byte of this sequence in the file (exclusive)

indexOf

int indexOf(java.lang.String str)

Returns the index within this sequence of the first occurrence of the specified substring.

The returned index is the smallest value k for which:

 this.startsWith(str, k)
 

If no such value of k exists, then -1 is returned.

Parameters:

str - the substring to search for.

Returns:

the index of the first occurrence of the specified substring, or -1 if there is no such occurrence.

compareTo

int compareTo(java.lang.String anotherString)

Compares the sequence and the string lexicographically. The comparison is based on the Unicode value of each character in the strings. The character sequence represented by this object is compared lexicographically to the character sequence represented by the argument string. The result is a negative integer if this object lexicographically precedes the argument string. The result is a positive integer if this object lexicographically follows the argument string. The result is zero if the strings are equal; compareTo returns 0 exactly when the equals(Object) method would return true.

This is the definition of lexicographic ordering. If two strings are different, then either they have different characters at some index that is a valid index for both strings, or their lengths are different, or both. If they have different characters at one or more index positions, let k be the smallest such index; then the string whose character at position k has the smaller value, as determined by using the < operator, lexicographically precedes the other string. In this case, compareTo returns the difference of the two character values at position k in the two string -- that is, the value:

 this.charAt(k)-anotherString.charAt(k)
 

If there is no index position at which they differ, then the shorter string lexicographically precedes the longer string. In this case, compareTo returns the difference of the lengths of the strings -- that is, the value:

 this.length()-anotherString.length()
 

Parameters:

anotherString - the String to be compared.

Returns:

the value 0 if the argument string is equal to this string; a value less than 0 if this string is lexicographically less than the string argument; and a value greater than 0 if this string is lexicographically greater than the string argument.