Package com.helger.commons.string.util

Class StringScanner

java.lang.Object

com.helger.commons.string.util.StringScanner

@NotThreadSafe
public class StringScanner
extends Object

Simple string scanner.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
StringScanner(String sInput)

Method Summary

Modifier and Type	Method	Description
int	findFirstIndex(char... aChars)
char	getCharAtIndex(int nIndex)
char	getCurrentChar()
int	getCurrentIndex()
int	getRemainingChars()
String	getRest()	Get all remaining chars, and set the index to the end of the input string
String	getUntil(char cEndExcl)	Get the string until the specified end character, but excluding the end character.
String	getUntilBalanced(int nStartLevel, char cOpenChar, char cCloseChar)
String	getUntilIndex(int nEndIndex)
String	getUntilWhiteSpace()
boolean	isCurrentChar(char c)
StringScanner	setIndex(int nIndex)
StringScanner	skip(int nCount)
StringScanner	skipbackWhitespaces()
StringScanner	skipWhitespaces()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StringScanner

public StringScanner(@Nonnull
                     String sInput)

Method Detail

getCurrentIndex

@Nonnegative
public int getCurrentIndex()

getRemainingChars

@Nonnegative
public int getRemainingChars()

skipWhitespaces

@Nonnull
public StringScanner skipWhitespaces()

skipbackWhitespaces

@Nonnull
public StringScanner skipbackWhitespaces()

skip

@Nonnull
public StringScanner skip(int nCount)

findFirstIndex

public int findFirstIndex(@Nonnull
                          char... aChars)

getCharAtIndex

public char getCharAtIndex(int nIndex)

getCurrentChar

public char getCurrentChar()

isCurrentChar

public boolean isCurrentChar(char c)

setIndex

@Nonnull
public StringScanner setIndex(@Nonnegative
                              int nIndex)

getRest

@Nonnull
public String getRest()

Get all remaining chars, and set the index to the end of the input string

Returns:

The remaining string. May not be null but may be empty.

getUntilIndex

@Nonnull
public String getUntilIndex(int nEndIndex)

getUntilWhiteSpace

@Nonnull
public String getUntilWhiteSpace()

getUntil

@Nonnull
public String getUntil(char cEndExcl)

Get the string until the specified end character, but excluding the end character.

Parameters:

cEndExcl - The end character to search.

Returns:

A non-null string with all characters from the current index until the end character, but not including the end character.

getUntilBalanced

@Nonnull
public String getUntilBalanced(int nStartLevel,
                               char cOpenChar,
                               char cCloseChar)

toString

public String toString()

Overrides:

toString in class Object