Package com.helger.base.io.nonblocking

Class NonBlockingStringReader

java.lang.Object
java.io.Reader
com.helger.base.io.nonblocking.NonBlockingStringReader
All Implemented Interfaces:
Closeable, AutoCloseable, Readable
@NotThreadSafe public class NonBlockingStringReader extends Reader
A non-synchronized copy of the class StringReader.
Note: super class Reader uses the lock object internally only for long skip(long n) and as this method is overwritten in here, the lock is never used.
Author:
Philip Helger
See Also:

  • Field Summary

    Fields inherited from class java.io.Reader

    lock

  • Constructor Summary

    Constructors
    Constructor
    Description
    NonBlockingStringReader(char @NonNull [] aChars)
    Creates a new string reader from a char array.
    NonBlockingStringReader(char @NonNull [] aChars, int nOfs, int nLen)
    Creates a new string reader from a portion of a char array.
    NonBlockingStringReader(@NonNull String sStr)
    Creates a new string reader.
    NonBlockingStringReader(@NonNull String sStr, int nOfs, int nLen)
    Creates a new string reader from a portion of a String.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Closes the stream and releases any system resources associated with it.
    void
    mark(int nReadAheadLimit)
    Marks the present position in the stream.
    boolean
    markSupported()
    Tells whether this stream supports the mark() operation, which it does.
    int
    read()
    Reads a single character.
    int
    read(char @NonNull [] aBuf, int nOfs, int nLen)
    Reads characters into a portion of an array.
    boolean
    ready()
    Tells whether this stream is ready to be read.
    void
    reset()
    Resets the stream to the most recent mark, or to the beginning of the string if it has never been marked.
    long
    skip(long nCharsToSkip)
    Skips the specified number of characters in the stream.

    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, toString, wait, wait, wait

  • Constructor Details

    • NonBlockingStringReader

      public NonBlockingStringReader(char @NonNull [] aChars)
      Creates a new string reader from a char array.
      Parameters:
      aChars - The char array providing the character stream. May not be null.

    • NonBlockingStringReader

      public NonBlockingStringReader(char @NonNull [] aChars, @Nonnegative int nOfs, @Nonnegative int nLen)
      Creates a new string reader from a portion of a char array.
      Parameters:
      aChars - The char array providing the character stream. May not be null.
      nOfs - The offset into the char array. Must be ≥ 0.
      nLen - The number of chars to read. Must be ≥ 0.

    • NonBlockingStringReader

      public NonBlockingStringReader(@NonNull String sStr)
      Creates a new string reader.
      Parameters:
      sStr - String providing the character stream. May not be null.

    • NonBlockingStringReader

      public NonBlockingStringReader(@NonNull String sStr, @Nonnegative int nOfs, @Nonnegative int nLen)
      Creates a new string reader from a portion of a String.
      Parameters:
      sStr - The String providing the character stream. May not be null.
      nOfs - The offset into the string. Must be ≥ 0.
      nLen - The number of chars to read. Must be ≥ 0.

  • Method Details

    • read

      @CheckForSigned public int read() throws IOException
      Reads 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

      @CheckForSigned public int read(char @NonNull [] aBuf, @Nonnegative int nOfs, @Nonnegative int nLen) throws IOException
      Reads characters into a portion of an array.
      Specified by:
      read in class Reader
      Parameters:
      aBuf - Destination buffer
      nOfs - Offset at which to start writing characters
      nLen - 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 nCharsToSkip) throws IOException
      Skips the specified number of characters in the stream. Returns the number of characters that were skipped.

      Overrides:
      skip in class Reader
      Parameters:
      nCharsToSkip - The parameter may be negative, even though the skip method of the Reader superclass throws an exception in this case. Negative values of the parameter 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.
      Returns:
      If the entire string has been read or skipped, then this method has no effect and always returns 0.
      Throws:
      IOException - If an I/O error occurs

    • ready

      public boolean ready() throws IOException
      Tells 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()
      Tells whether this stream supports the mark() operation, which it does.
      Overrides:
      markSupported in class Reader
      Returns:
      always true

    • mark

      public void mark(int nReadAheadLimit) throws IOException
      Marks the present position in the stream. Subsequent calls to reset() will reposition the stream to this point.
      Overrides:
      mark in class Reader
      Parameters:
      nReadAheadLimit - 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
      Resets 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()
      Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), or reset() invocations will throw an IOException. Closing a previously closed stream has no effect.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in class Reader