fr.umlv.tatoo.runtime.buffer.impl
Class ReadableWrapper

java.lang.Object
  extended by fr.umlv.tatoo.runtime.buffer.impl.AbstractBufferWrapper
      extended by fr.umlv.tatoo.runtime.buffer.impl.ReadableWrapper
All Implemented Interfaces:
LexerBuffer, TokenBuffer<CharBuffer>

public class ReadableWrapper
extends AbstractBufferWrapper
implements TokenBuffer<CharBuffer>

A ReadableWrapper wraps a Readable in order to allow a lexer to process its content in order to have its tokens extracted.

Author:
Julien
See Also:
Lexer

Constructor Summary
ReadableWrapper(boolean direct, int capacity, int increment, int chunkSize, Readable readable, LocationTracker tracker)
          Construct a ReadableWrapper used by the lexer to process the Readable.
ReadableWrapper(Readable readable, LocationTracker tracker)
          Constructs a ReadableWrapper with default behavior.
 
Method Summary
protected  void discardImpl()
           
 boolean hasRemaining()
          Returns true if more characters are availables in the buffer.
 int lastChar()
          Returns last read char or -1 if not available.
protected  int nextImpl()
          Returns next character in buffer without taking care of locations
 boolean previousWasNewLine()
          Determines if the last unwinded character was an end of line.
 boolean read()
          Reads at some bytes from the stream.
protected  void resetImpl()
          Moves current position back to first non unwinded character without taking care of locations
protected  void restartImpl()
           
 String toString()
          Returns a String representation of the current token
protected  void unwindImpl(int l)
          Performs unwind operation on buffer without taking care of locations
 CharBuffer view()
          Returns the token part of the buffer as a CharBuffer.
 
Methods inherited from class fr.umlv.tatoo.runtime.buffer.impl.AbstractBufferWrapper
discard, getLocationProvider, locationClear, next, reset, restart, unwind
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface fr.umlv.tatoo.runtime.buffer.TokenBuffer
discard
 

Constructor Detail

ReadableWrapper

public ReadableWrapper(Readable readable,
                       LocationTracker tracker)
Constructs a ReadableWrapper with default behavior.

Parameters:
readable - the Readable to wrap
tracker - the location tracker

ReadableWrapper

public ReadableWrapper(boolean direct,
                       int capacity,
                       int increment,
                       int chunkSize,
                       Readable readable,
                       LocationTracker tracker)
Construct a ReadableWrapper used by the lexer to process the Readable. The parameters specify how the underlying buffer which stores data in allocated and reallocated when more space is needed.

Parameters:
direct - if the CharBuffer must be direct
capacity - the initial capacity
increment - how much to increment the size of the buffer when more space is required
chunkSize - how many bytes are read at once is the input
readable - the input
Method Detail

resetImpl

protected void resetImpl()
Description copied from class: AbstractBufferWrapper
Moves current position back to first non unwinded character without taking care of locations

Specified by:
resetImpl in class AbstractBufferWrapper
See Also:
LexerBuffer.reset()

unwindImpl

protected void unwindImpl(int l)
Description copied from class: AbstractBufferWrapper
Performs unwind operation on buffer without taking care of locations

Specified by:
unwindImpl in class AbstractBufferWrapper
Parameters:
l - the number of characters to unwind
See Also:
LexerBuffer.unwind(int)

previousWasNewLine

public boolean previousWasNewLine()
Description copied from interface: LexerBuffer
Determines if the last unwinded character was an end of line.

Specified by:
previousWasNewLine in interface LexerBuffer
Returns:
true if the last unwinded character was an end of line; false otherwise

hasRemaining

public boolean hasRemaining()
Description copied from interface: LexerBuffer
Returns true if more characters are availables in the buffer. If the end of file has been reached and backtracked by lexer this method must return true.

Specified by:
hasRemaining in interface LexerBuffer
Returns:
true if more characters are availables in the buffer

read

public boolean read()
             throws IOException
Description copied from interface: LexerBuffer
Reads at some bytes from the stream. This operation is optionnal and only used by SimpleLexer.run().

Specified by:
read in interface LexerBuffer
Returns:
false at end of stream
Throws:
IOException - if an i/o operation failed.

nextImpl

protected int nextImpl()
Description copied from class: AbstractBufferWrapper
Returns next character in buffer without taking care of locations

Specified by:
nextImpl in class AbstractBufferWrapper
Returns:
the next character in the buffer
See Also:
LexerBuffer.next()

discardImpl

protected void discardImpl()
Specified by:
discardImpl in class AbstractBufferWrapper

restartImpl

protected void restartImpl()
Specified by:
restartImpl in class AbstractBufferWrapper

view

public CharBuffer view()
Returns the token part of the buffer as a CharBuffer. The Buffer.limit() index must not be moved, the Buffer.position() can be moved, but any data before it can be discarded by the wrapper.

Specified by:
view in interface TokenBuffer<CharBuffer>
Returns:
the token part of the buffer as a CharBuffer

toString

public String toString()
Returns a String representation of the current token

Overrides:
toString in class Object
Returns:
a String representation of the current token

lastChar

public int lastChar()
Description copied from interface: LexerBuffer
Returns last read char or -1 if not available. This method is used for logging and error reporting. This operation is optional since this method can return -1 anytime

Specified by:
lastChar in interface LexerBuffer
Returns:
last read char or -1 if not available