org.owasp.fileio.codecs

Class PushbackString

java.lang.Object

org.owasp.fileio.codecs.PushbackString

public class PushbackString
extends Object

The pushback string is used by Codecs to allow them to push decoded characters back onto a string for further decoding. This is necessary to detect double-encoding.

Constructor Summary

Constructors

Constructor and Description
PushbackString(String input) Constructs a new instance of PushbackString

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
int	index() Get the current index of the PushbackString.
static boolean	isHexDigit(Character c) Returns true if the parameter character is a hexidecimal digit 0 through 9, a through f, or A through F.
static boolean	isOctalDigit(Character c) Returns true if the parameter character is an octal digit 0 through 7.
void	mark()
Character	next()
Character	nextHex()
Character	nextOctal()
Character	peek() Return the next character without affecting the current index.
boolean	peek(char c) Test to see if the next character is a particular value without affecting the current index.
void	pushback(Character c)
protected String	remainder()
void	reset()

Methods inherited from class java.lang.Object

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

Constructor Detail

PushbackString

public PushbackString(String input)

Constructs a new instance of PushbackString

Parameters:

input - the String to decode

Method Detail

pushback

public void pushback(Character c)

Parameters:

c - The character to set as the pushback

index

public int index()

Get the current index of the PushbackString. Typically used in error messages.

Returns:

The current index of the PushbackString.

hasNext

public boolean hasNext()

Returns:

true if there are more characters to process

next

public Character next()

Returns:

the next character

nextHex

public Character nextHex()

Returns:

the next hex digit in the input, or null if the next character is not hex

nextOctal

public Character nextOctal()

Returns:

the next octal digit in the input, or null if the next character is not octal

isHexDigit

public static boolean isHexDigit(Character c)

Returns true if the parameter character is a hexidecimal digit 0 through 9, a through f, or A through F.

Parameters:

c - The Character to test

Returns:

true if the input character is a hex digit (0-F)

isOctalDigit

public static boolean isOctalDigit(Character c)

Returns true if the parameter character is an octal digit 0 through 7.

Parameters:

c - The Character to test

Returns:

true if the input character is an octal digit (0-7)

peek

public Character peek()

Return the next character without affecting the current index.

Returns:

the next Character in the input

peek

public boolean peek(char c)

Test to see if the next character is a particular value without affecting the current index.

Parameters:

c - The character to test for

Returns:

true if the next character matches the input character

mark

public void mark()

reset

public void reset()

remainder

protected String remainder()

Returns:

the remainder of the input String, prepended with any pushback, if necessary