AbstractPushbackSequence (ESAPI 2.2.3.1 API)

java.lang.Object
- org.owasp.esapi.codecs.AbstractPushbackSequence<T>

Type Parameters:

T -

All Implemented Interfaces:

PushbackSequence<T>

Direct Known Subclasses:

PushBackSequenceImpl, PushbackString
```
public abstract class AbstractPushbackSequence<T>
extends java.lang.Object
implements PushbackSequence<T>
```
This Abstract class provides the generic logic for using a PushbackSequence in regards to iterating strings. The final Impl is intended for the user to supply a type T such that the pushback interface can be utilized for sequences of type T. Presently this generic class is limited by the fact that input is a String.

Author:

Matt Seil

Field Summary

Fields
Modifier and Type Field Description

protected int index

protected java.lang.String input

protected int mark

protected T pushback

protected T temp

Constructor Summary

Constructors
Constructor Description

AbstractPushbackSequence(java.lang.String input)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`hasNext()`	Determine if this sequence has another element.
`int`	`index()`	Get the current index of the PushbackString.
`void`	`pushback(T c)`

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

Methods inherited from interface org.owasp.esapi.codecs.PushbackSequence
mark, next, nextHex, nextOctal, peek, peek, remainder, reset

- Field Detail
  - input
```
protected java.lang.String input
```
  - pushback
```
protected T pushback
```
  - temp
```
protected T temp
```
  - index
```
protected int index
```
  - mark
```
protected int mark
```
- Constructor Detail
  - AbstractPushbackSequence
```
public AbstractPushbackSequence(java.lang.String input)
```
- Method Detail
  - pushback
```
public void pushback(T c)
```
    Specified by:
    
    pushback in interface PushbackSequence<T>
  - index
```
public int index()
```
    Get the current index of the PushbackString. Typically used in error messages.
    
    Specified by:
    
    index in interface PushbackSequence<T>
    
    Returns:
    
    The current index of the PushbackSequence.
  - hasNext
```
public boolean hasNext()
```
    Determine if this sequence has another element.
    
    Specified by:
    
    hasNext in interface PushbackSequence<T>
    
    Returns:
    
    True if there is another element in this sequence. False otherwise.