Package com.nomagic.magicreport.engine

Class MemoryReader

java.lang.Object
java.io.Reader
com.nomagic.magicreport.engine.MemoryReader
All Implemented Interfaces:
Closeable, AutoCloseable, Readable
@OpenApiAll public class MemoryReader extends Reader
A character stream whose source is memory.
Since:
Sep 3, 2007

  • Field Summary

    Fields inherited from class java.io.Reader

    lock

  • Constructor Summary

    Constructors
    Constructor
    Description
    MemoryReader(String s)
    Create a new memory reader.
    MemoryReader(StringBuilder s)
    Create a new memory reader.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Close the stream.
    StringBuilder
    getBuffer()
    Return the string buffer itself.
    void
    mark(int readAheadLimit)
    Mark the present position in the stream.
    boolean
    markSupported()
    Tell whether this stream supports the mark() operation, which it does.
    int
    read()
    Read a single character.
    int
    read(char[] cbuf, int off, int len)
    Read characters into a portion of an array.
    boolean
    ready()
    Tell whether this stream is ready to be read.
    void
    reset()
    Reset the stream to the most recent mark, or to the beginning of the string if it has never been marked.
    long
    skip(long ns)
    Skips the specified number of characters in the stream.
    String
    toString()
    Return the buffer's current value as a string.

    Methods inherited from class java.io.Reader

    nullReader, read, read, transferTo

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • MemoryReader

      public MemoryReader(StringBuilder s)
      Create a new memory reader.
      Parameters:
      s - StringBuilder providing the character stream.

    • MemoryReader

      public MemoryReader(String s)
      Create a new memory reader.
      Parameters:
      s - String providing the character stream.

  • Method Details

    • read

      public int read() throws IOException
      Read a single character.
      Overrides:
      read in class Reader
      Returns:
      The character read, or -1 if the end of the stream has been reached
      Throws:
      IOException - If an I/O error occurs

    • read

      public int read(char[] cbuf, int off, int len) throws IOException
      Read characters into a portion of an array.
      Specified by:
      read in class Reader
      Parameters:
      cbuf - Destination buffer
      off - Offset at which to start writing characters
      len - Maximum number of characters to read
      Returns:
      The number of characters read, or -1 if the end of the stream has been reached
      Throws:
      IOException - If an I/O error occurs

    • skip

      public long skip(long ns) throws IOException
      Skips the specified number of characters in the stream. Returns the number of characters that were skipped.

      The ns parameter may be negative, even though the skip method of the Reader superclass throws an exception in this case. Negative values of ns cause the stream to skip backwards. Negative return values indicate a skip backwards. It is not possible to skip backwards past the beginning of the string.

      If the entire string has been read or skipped, then this method has no effect and always returns 0.

      Overrides:
      skip in class Reader
      Parameters:
      ns - The number of characters to skip
      Returns:
      The number of characters actually skipped
      Throws:
      IOException - If an I/O error occurs

    • ready

      public boolean ready() throws IOException
      Tell whether this stream is ready to be read.
      Overrides:
      ready in class Reader
      Returns:
      True if the next read() is guaranteed not to block for input
      Throws:
      IOException - If the stream is closed

    • markSupported

      public boolean markSupported()
      Tell whether this stream supports the mark() operation, which it does.
      Overrides:
      markSupported in class Reader
      Returns:
      true if and only if this stream supports the mark operation.

    • mark

      public void mark(int readAheadLimit) throws IOException
      Mark the present position in the stream. Subsequent calls to reset() will reposition the stream to this point.
      Overrides:
      mark in class Reader
      Parameters:
      readAheadLimit - Limit on the number of characters that may be read while still preserving the mark. Because the stream's input comes from a string, there is no actual limit, so this argument must not be negative, but is otherwise ignored.
      Throws:
      IllegalArgumentException - If readAheadLimit is < 0
      IOException - If an I/O error occurs

    • reset

      public void reset() throws IOException
      Reset the stream to the most recent mark, or to the beginning of the string if it has never been marked.
      Overrides:
      reset in class Reader
      Throws:
      IOException - If an I/O error occurs

    • close

      public void close()
      Close the stream.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in class Reader

    • getBuffer

      public StringBuilder getBuffer() throws IOException
      Return the string buffer itself.
      Returns:
      StringBuilder holding the current buffer value.
      Throws:
      IOException - the stream has been closed

    • toString

      public String toString()
      Return the buffer's current value as a string.
      Overrides:
      toString in class Object
      Returns:
      buffer value