jhelp.util.text

Class StringExtractor

java.lang.Object

jhelp.util.text.StringExtractor

public class StringExtractor
extends java.lang.Object

Cut string with separator, like StringTokenizer, but in addition it can detect Strings and not cut on them, it can also ignore escaped character.
By example, you type :

You will obtain
Hello
world
!
This is a phrase

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private char[]	escapeCharacters Escape characters
private int	index Current read index
private int	length String to parse length
private java.util.ArrayList<Pair<java.lang.Character,java.lang.Character>>	openCloseIgnore Open/close pairs, to consider like "normal" character something between an open and a close character
private boolean	returnSeparators Indicates if separators are return
private char[]	separators Separators characters
private char[]	string String to parse
private char[]	stringLimiters String delimiters

Constructor Summary

Constructors

Constructor and Description
StringExtractor(java.lang.String string) Create a new instance of StringExtractor with default separators (see UtilText.DEFAULT_SEPARATORS), string delimiters (see UtilText.DEFAULT_STRING_LIMITERS) and escape characters (see UtilText.DEFAULT_ESCAPE_CHARACTERS).
StringExtractor(java.lang.String string, boolean returnSeparators) Create a new instance of StringExtractor with default separators (see UtilText.DEFAULT_SEPARATORS), string delimiters (see UtilText.DEFAULT_STRING_LIMITERS) and escape characters (see UtilText.DEFAULT_ESCAPE_CHARACTERS)
StringExtractor(java.lang.String string, java.lang.String separators, java.lang.String stringLimiters, java.lang.String escapeCharacters) Create a new instance of StringExtractor with no return separators
StringExtractor(java.lang.String string, java.lang.String separators, java.lang.String stringLimiters, java.lang.String escapeCharacters, boolean returnSeparators) Create a new instance of StringExtractor

Method Summary

Methods

Modifier and Type	Method and Description
void	addOpenCloseIgnore(char open, char close) Add a open close pairs, to consider like "normal" character something between an open and a close character
java.lang.String	next() Next extracted string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

escapeCharacters

private final char[] escapeCharacters

Escape characters

index

private int index

Current read index

length

private final int length

String to parse length

openCloseIgnore

private final java.util.ArrayList<Pair<java.lang.Character,java.lang.Character>> openCloseIgnore

Open/close pairs, to consider like "normal" character something between an open and a close character

returnSeparators

private final boolean returnSeparators

Indicates if separators are return

separators

private final char[] separators

Separators characters

string

private final char[] string

String to parse

stringLimiters

private final char[] stringLimiters

String delimiters

Constructor Detail

StringExtractor

public StringExtractor(java.lang.String string)

Create a new instance of StringExtractor with default separators (see UtilText.DEFAULT_SEPARATORS), string delimiters (see UtilText.DEFAULT_STRING_LIMITERS) and escape characters (see UtilText.DEFAULT_ESCAPE_CHARACTERS). And no return of separators

Parameters:

string - String to parse

StringExtractor

public StringExtractor(java.lang.String string,
               boolean returnSeparators)

Create a new instance of StringExtractor with default separators (see UtilText.DEFAULT_SEPARATORS), string delimiters (see UtilText.DEFAULT_STRING_LIMITERS) and escape characters (see UtilText.DEFAULT_ESCAPE_CHARACTERS)

Parameters:

string - String to parse

returnSeparators - Indicates if return separators

StringExtractor

public StringExtractor(java.lang.String string,
               java.lang.String separators,
               java.lang.String stringLimiters,
               java.lang.String escapeCharacters)

Create a new instance of StringExtractor with no return separators

Parameters:

string - String to parse

separators - Separators list

stringLimiters - String delimiters

escapeCharacters - Escape characters

StringExtractor

public StringExtractor(java.lang.String string,
               java.lang.String separators,
               java.lang.String stringLimiters,
               java.lang.String escapeCharacters,
               boolean returnSeparators)

Create a new instance of StringExtractor

Parameters:

string - String to parse

separators - Separators list

stringLimiters - String delimiters

escapeCharacters - Escape characters

returnSeparators - Indicates if return separators

Method Detail

addOpenCloseIgnore

public void addOpenCloseIgnore(char open,
                      char close)

Add a open close pairs, to consider like "normal" character something between an open and a close character

Parameters:

open - Open character

close - Close character

next

public java.lang.String next()

Next extracted string.
It can be a separator if you ask for return them.
It returns null if no more string to extract

Returns:

Next part or null if no more to extract