StringChunker

java.lang.Object
- org.tmotte.common.text.StringChunker

```
public class StringChunker
extends java.lang.Object
```
Provides the ability to "walk" through a String using find() methods, parsing found "chunks" one at a time. Interally, there is a text buffer and a pointer to a position in that buffer; the pointer moves as find() executes.

Constructor Summary

Constructors
Constructor and Description

StringChunker()
Creates an uninitialized StringChunker.

StringChunker(java.lang.String text)
Creates a StringChunker ready to use.

Constructors
Constructor and Description
`StringChunker()` Creates an uninitialized StringChunker.
`StringChunker(java.lang.String text)` Creates a StringChunker ready to use.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`find(java.util.regex.Pattern regex)` Does the same as `find(String)`, but using a regular expression.
`boolean`	`find(java.lang.String lookFor)` Finds the given substring, starting at the current index, and sets the internal index to the location directly following the text found.
`boolean`	`findOrFinish(java.util.regex.Pattern regex)` Does the same as `findOrFinish(String)`, but using a regular expression.
`boolean`	`findOrFinish(java.lang.String lookFor)` Makes it easier to deal with end-of-String vs.
`boolean`	`finished()`
`int`	`foundAt()`
`java.lang.String`	`getEverythingSoFar()` Provides all the text up to the current position of the internal pointer; i.e.
`java.lang.String`	`getFound()` Obtains the text that was found by `find()`.
`java.lang.String`	`getIncluding()` Combines the results of `getUpTo()`.
`java.lang.String`	`getIncluding(java.lang.String lookFor)` Combines find() and getIncluding().
`int`	`getIndex()`
`java.lang.String`	`getRest()` Moves index to end of buffer and retrieves rest of text.
`java.lang.String`	`getText()`
`java.lang.String`	`getUpTo()` Obtains the text before the text found by `find()`.
`java.lang.String`	`getUpTo(java.lang.String lookFor)` Combines find() and getUpTo().
`java.lang.String`	`getUpToOrGetRest()` If last find() failed, invokes getRest(), else getUpTo().
`java.lang.String`	`getUpToOrGetRest(java.lang.String val)` Combines find() with getUpToOrGetRest().
`static void`	`main(java.lang.String[] args)` Call with two args: 1) A string to search 2) A regex to search with.
`void`	`move(int distance)` Moves the internal buffer index forward the specified distance.
`StringChunker`	`reset()` Sets the internal index back to 0, as if find() had never been invoked.
`StringChunker`	`reset(java.lang.String text)` Completely reinitializes this StringChunker.
`void`	`setIndex(int index)` Sets the internal buffer index to a specific position.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StringChunker
```
public StringChunker(java.lang.String text)
```
    Creates a StringChunker ready to use.
    
    Parameters:
    
    text - The String to be parsed.
  - StringChunker
```
public StringChunker()
```
    Creates an uninitialized StringChunker. Invoke reset(String) to initialize it.
- Method Detail
  - reset
```
public StringChunker reset()
```
    Sets the internal index back to 0, as if find() had never been invoked.
  - reset
```
public StringChunker reset(java.lang.String text)
```
    Completely reinitializes this StringChunker. Simply avoids creating a new instance when an old one is laying around.
  - getText
```
public java.lang.String getText()
```
    Returns:
    
    The entire internal buffer
  - getIndex
```
public int getIndex()
```
    Returns:
    
    The current index into the internal buffer. When getRest() is invoked, this will be the buffer length.
  - foundAt
```
public int foundAt()
```
    Returns:
    
    The index of where the last find() found something.
  - finished
```
public boolean finished()
```
    Returns:
    
    Whether the internal index has advanced to the end of the internal buffer.
  - move
```
public void move(int distance)
```
    Moves the internal buffer index forward the specified distance.
  - setIndex
```
public void setIndex(int index)
```
    Sets the internal buffer index to a specific position.
  - find
```
public boolean find(java.lang.String lookFor)
```
    Finds the given substring, starting at the current index, and sets the internal index to the location directly following the text found. Invoke getUpTo(), getIncluding(), getFound() etc. to retrieve the text found and text relative to its location.
    
    Returns:
    
    true if lookFor was located.
  - findOrFinish
```
public boolean findOrFinish(java.lang.String lookFor)
```
    Makes it easier to deal with end-of-String vs. text-found conditions in loops.
    
    Returns:
    
    true if lookFor is found, or if not found but the internal index was still before the end of the text. In the latter case, the next call to getUpTo() will return the remaining text, and further calls to findOrFinish() will return false.
  - find
```
public boolean find(java.util.regex.Pattern regex)
```
    Does the same as find(String), but using a regular expression.
  - findOrFinish
```
public boolean findOrFinish(java.util.regex.Pattern regex)
```
    Does the same as findOrFinish(String), but using a regular expression.
  - getUpTo
```
public java.lang.String getUpTo()
```
    Obtains the text before the text found by find().
    
    Returns:
    
    The text between text found by the last successful find() and the successful find() before that; or, if there has been only one successful find(), the text between position 0 and the text found by that find().
  - getFound
```
public java.lang.String getFound()
```
    Obtains the text that was found by find().
    
    Returns:
    
    text located during last execution of find()
  - getIncluding
```
public java.lang.String getIncluding()
```
    Combines the results of getUpTo(). and getFound().
    
    Returns:
    
    getUpTo() + getFound()
  - getEverythingSoFar
```
public java.lang.String getEverythingSoFar()
```
    Provides all the text up to the current position of the internal pointer; i.e. everything up to and including the last item found.
  - getUpTo
```
public java.lang.String getUpTo(java.lang.String lookFor)
```
    Combines find() and getUpTo().
    
    Returns:
    
    text located during the find()
  - getIncluding
```
public java.lang.String getIncluding(java.lang.String lookFor)
```
    Combines find() and getIncluding().
    
    Returns:
    
    text located during the find()
  - getRest
```
public java.lang.String getRest()
```
    Moves index to end of buffer and retrieves rest of text.
    
    Returns:
    
    Remainder of buffer, or "" if nothing is left.
  - getUpToOrGetRest
```
public java.lang.String getUpToOrGetRest()
```
    If last find() failed, invokes getRest(), else getUpTo().
  - getUpToOrGetRest
```
public java.lang.String getUpToOrGetRest(java.lang.String val)
```
    Combines find() with getUpToOrGetRest().
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Exception
```
    Call with two args: 1) A string to search 2) A regex to search with.
    
    Throws:
    
    java.lang.Exception

Class StringChunker

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringChunker

StringChunker

Method Detail

reset

reset

getText

getIndex

foundAt

finished

move

setIndex

find

findOrFinish

find

findOrFinish

getUpTo

getFound

getIncluding

getEverythingSoFar

getUpTo

getIncluding

getRest

getUpToOrGetRest

getUpToOrGetRest

main