Cursor (Javolution Core (Java) for MSFTBX 6.11.3 API)

java.lang.Object
- javolution.text.Cursor

public class Cursor
extends Object

A parsing cursor over the characters read. Cursor allows for token iterations over any CharSequence.

     String str = "this is a test";
     Cursor cursor = new Cursor();
     for (CharSequence token; (token=cursor.nextToken(str, ' '))!= null;)
            System.out.println(token);

Prints the following output:

        this
        is
        a
        test

Cursors are typically used with TextFormat instances.

     // Parses decimal number (e.g. "xxx.xxxxxExx" or "NaN")
     public Decimal parse(CharSequence csq, Cursor cursor) throws IllegalArgumentException {
         TextFormat<LargeInteger> largeIntegerFormat = TextContext.getFormat(LargeInteger.class);
         if (cursor.skip("NaN", csq))
             return Decimal.NaN;
         LargeInteger significand = LargeIntegerFormat.parse(csq, cursor);
         LargeInteger fraction = cursor.skip('.', csq) ? largeIntegerFormat.parse(csq, cursor) : LargeInteger.ZERO;
         int exponent = cursor.skip(CharSet.valueOf('E', 'e'), csq) ? TypeFormat.parseInt(csq, cursor) : 0;
         int fractionDigits = fraction.digitLength();
         return Decimal.valueOf(significand.E(fractionDigits).plus(fraction), exponent - fractionDigits);
     }

Version:: 5.4, November 19, 2009
Author:: Jean-Marie Dautelle

Constructor Summary

Constructors
Constructor and Description

Cursor()
Default constructor.

Cursor(int startingIndex)
Constructor to initialize a Cursor with the specified index

Constructors
Constructor and Description
`Cursor()` Default constructor.
`Cursor(int startingIndex)` Constructor to initialize a Cursor with the specified index

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`at(char c, CharSequence csq)` Indicates if this cursor points to the specified character in the specified character sequence.
`boolean`	`at(CharSet charSet, CharSequence csq)` Indicates if this cursor points to any of the specified character in the specified character sequence.
`boolean`	`at(String str, CharSequence csq)` Indicates if this cursor points to the specified characters in the specified sequence.
`boolean`	`atEnd(CharSequence csq)` Indicates if this cursor points to the end of the specified character sequence.
`char`	`currentChar(CharSequence csq)` Returns the current character at this cursor position.
`boolean`	`equals(Object obj)` Indicates if this cursor is equals to the specified object.
`int`	`getIndex()` Returns this cursor index.
`int`	`hashCode()` Returns the hash code for this cursor.
`CharSequence`	`head(CharSequence csq)` Returns the head of the specified character sequence until this cursor position.
`Cursor`	`increment()` Increments the cursor index by one.
`Cursor`	`increment(int i)` Increments the cursor index by the specified value.
`char`	`nextChar(CharSequence csq)` Returns the next character at this cursor position.The cursor position is incremented by one.
`CharSequence`	`nextToken(CharSequence csq, char c)` Returns the subsequence from the specified cursor position not holding the specified character.
`CharSequence`	`nextToken(CharSequence csq, CharSet charSet)` Returns the subsequence from the specified cursor position not holding any of the characters specified.
`void`	`setIndex(int i)` Sets the cursor current index.
`boolean`	`skip(char c, CharSequence csq)` Moves this cursor forward only if at the specified character.
`boolean`	`skip(CharSet charSet, CharSequence csq)` Moves this cursor forward only if at any of the specified character.
`boolean`	`skip(String str, CharSequence csq)` Moves this cursor forward only if at the specified string.
`boolean`	`skipAny(char c, CharSequence csq)` Moves this cursor forward until it points to a character different from the specified character.
`boolean`	`skipAny(CharSet charSet, CharSequence csq)` Moves this cursor forward until it points to a character different from any of the character in the specified set.
`CharSequence`	`tail(CharSequence csq)` Returns the tail of the specified character sequence starting at this cursor position.
`String`	`toString()` Returns the string representation of this cursor.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Cursor
```
public Cursor()
```
    Default constructor.
  - Cursor
```
public Cursor(int startingIndex)
```
    Constructor to initialize a Cursor with the specified index
    
    Parameters:
    startingIndex - Index to initially point at;
    
    Throws:
    
    IllegalArgumentException - if the startingIndex provided is negative
- Method Detail
  - getIndex
```
public final int getIndex()
```
    Returns this cursor index.
    
    Returns:
    the index of the next character to parse.
  - setIndex
```
public final void setIndex(int i)
```
    Sets the cursor current index.
    
    Parameters:
    i - the index of the next character to parse.
    
    Throws:
    
    IllegalArgumentException - if the index provided is negative
  - atEnd
```
public final boolean atEnd(CharSequence csq)
```
    Indicates if this cursor points to the end of the specified character sequence.
    
    Parameters:
    csq - the character sequence iterated by this cursor.
    
    Returns:
    getIndex() >= csq.length()
  - at
```
public final boolean at(char c,
         CharSequence csq)
```
    Indicates if this cursor points to the specified character in the specified character sequence.
    
    Parameters:
    c - the character to test.
    csq - the character sequence iterated by this cursor.
    
    Returns:
    csq.charAt(this.getIndex()) == c
  - at
```
public final boolean at(CharSet charSet,
         CharSequence csq)
```
    Indicates if this cursor points to any of the specified character in the specified character sequence.
    
    Parameters:
    charSet - any of the character to test.
    csq - the character sequence iterated by this cursor.
    
    Returns:
    csq.charAt(this.getIndex()) == c
  - at
```
public final boolean at(String str,
         CharSequence csq)
```
    Indicates if this cursor points to the specified characters in the specified sequence.
    
    Parameters:
    str - the characters to test.
    csq - the character sequence iterated by this cursor.
    
    Returns:
    true if this cursor points to the specified characters; false otherwise.
  - currentChar
```
public final char currentChar(CharSequence csq)
```
    Returns the current character at this cursor position.
    
    Parameters:
    csq - the character sequence iterated by this cursor.
    
    Returns:
    the current character this cursor points to.
    
    Throws:
    
    IndexOutOfBoundsException - if this.atEnd(csq)
  - nextChar
```
public final char nextChar(CharSequence csq)
```
    Returns the next character at this cursor position.The cursor position is incremented by one.
    
    Parameters:
    csq - the character sequence iterated by this cursor.
    
    Returns:
    the next character this cursor points to.
    
    Throws:
    
    IndexOutOfBoundsException - if this.atEnd(csq)
  - skipAny
```
public final boolean skipAny(char c,
              CharSequence csq)
```
    Moves this cursor forward until it points to a character different from the specified character.
    
    Parameters:
    c - the character to skip.
    csq - the character sequence iterated by this cursor.
    
    Returns:
    true if this cursor has skipped at least one character;false otherwise (e.g. end of sequence reached).
  - skipAny
```
public final boolean skipAny(CharSet charSet,
              CharSequence csq)
```
    Moves this cursor forward until it points to a character different from any of the character in the specified set. For example:
    // Reads numbers separated by tabulations or spaces. FastTable<Integer> numbers = new FastTable<Integer>(); while (cursor.skipAny(CharSet.SPACE_OR_TAB, csq)) { numbers.add(TypeFormat.parseInt(csq, cursor)); }
    Parameters:
    charSet - the character to skip.
    csq - the character sequence iterated by this cursor.
    
    Returns:
    true if this cursor has skipped at least one character;false otherwise (e.g. end of sequence reached).
  - skip
```
public final boolean skip(char c,
           CharSequence csq)
```
    Moves this cursor forward only if at the specified character. This method is equivalent to:
    if (at(c, csq)) increment();
    Parameters:
    c - the character to skip.
    csq - the character sequence iterated by this cursor.
    
    Returns:
    true if this cursor has skipped the specified character;false otherwise.
  - skip
```
public final boolean skip(CharSet charSet,
           CharSequence csq)
```
    Moves this cursor forward only if at any of the specified character. This method is equivalent to:
    if (at(charSet, csq)) increment();
    Parameters:
    charSet - holding the characters to skip.
    csq - the character sequence iterated by this cursor.
    
    Returns:
    true if this cursor has skipped any the specified character;false otherwise.
  - skip
```
public final boolean skip(String str,
           CharSequence csq)
```
    Moves this cursor forward only if at the specified string. This method is equivalent to:
    if (at(str, csq)) increment(str.length());
    Parameters:
    str - the string to skip.
    csq - the character sequence iterated by this cursor.
    
    Returns:
    true if this cursor has skipped the specified string;false otherwise (e.g. end of sequence reached).
  - nextToken
```
public final CharSequence nextToken(CharSequence csq,
                     char c)
```
    Returns the subsequence from the specified cursor position not holding the specified character. For example:
    CharSequence csq = "This is a test"; for (CharSequence token; (token=cursor.nextToken(csq, ' '))!= null;) { System.out.println(token); // Prints one word at a time. }
    Parameters:
    csq - the character sequence iterated by this cursor.
    c - the character being skipped.
    
    Returns:
    the subsequence not holding the specified character or null if none.
  - nextToken
```
public final CharSequence nextToken(CharSequence csq,
                     CharSet charSet)
```
    Returns the subsequence from the specified cursor position not holding any of the characters specified. For example:
    CharSequence csq = "This is a test"; for (CharSequence token; (token=cursor.nextToken(csq, CharSet.WHITESPACE))!= null;) { System.out.println(token); // Prints one word at a time. }
    Parameters:
    csq - the character sequence iterated by this cursor.
    charSet - the characters being skipped.
    
    Returns:
    the subsequence not holding the specified character or null if none.
  - head
```
public final CharSequence head(CharSequence csq)
```
    Returns the head of the specified character sequence until this cursor position.
    
    Returns:
    the corresponding sub-sequence.
  - tail
```
public final CharSequence tail(CharSequence csq)
```
    Returns the tail of the specified character sequence starting at this cursor position.
    
    Returns:
    the corresponding sub-sequence.
  - increment
```
public final Cursor increment()
```
    Increments the cursor index by one.
    
    Returns:
    this
  - increment
```
public final Cursor increment(int i)
```
    Increments the cursor index by the specified value.
    
    Parameters:
    i - the increment value.
    
    Returns:
    this
  - toString
```
public String toString()
```
    Returns the string representation of this cursor.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    the index value as a string.
  - equals
```
public boolean equals(Object obj)
```
    Indicates if this cursor is equals to the specified object.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    true if the specified object is a cursor at the same index; false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this cursor.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    the hash code value for this object

Class Cursor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cursor

Cursor

Method Detail

getIndex

setIndex

atEnd

at

at

at

currentChar

nextChar

skipAny

skipAny

skip

skip

skip

nextToken

nextToken

head

tail

increment

increment

toString

equals

hashCode