iText 7 7.1.8 API
Public Member Functions | Protected Member Functions | List of all members
iText.IO.Util.PushbackReader Class Reference

A character-stream reader that allows characters to be pushed back into the stream. More...

Inheritance diagram for iText.IO.Util.PushbackReader:
iText.IO.Util.FilterReader iText.Kernel.XMP.Impl.FixASCIIControlsReader

Public Member Functions
  PushbackReader (TextReader inp, int size)
  Creates a new pushback reader with a pushback buffer of the given size. More...
 
  PushbackReader (TextReader inp)
  Creates a new pushback reader with a one-character pushback buffer. More...
 
override int  Read ()
  Reads a single character. More...
 
override int  Read (char[] cbuf, int off, int len)
  Reads characters into a portion of an array. More...
 
virtual void  Unread (int c)
  Pushes back a single character by copying it to the front of the pushback buffer. After this method returns, the next character to be read will have the value More...
 
virtual void  Unread (char[] cbuf, int off, int len)
  Pushes back a portion of an array of characters by copying it to the front of the pushback buffer. After this method returns, the next character to be read will have the value More...
 
virtual void  Unread (char[] cbuf)
  Pushes back an array of characters by copying it to the front of the pushback buffer. After this method returns, the next character to be read will have the value More...
 
- Public Member Functions inherited from iText.IO.Util.FilterReader
override int  Read ()
  Reads a single character. More...
 
override int  Read (char[] cbuf, int off, int len)
  Reads characters into a portion of an array. More...
 

Protected Member Functions
override void  Dispose (bool disposing)
  Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), unread(), ready(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect. More...
 
- Protected Member Functions inherited from iText.IO.Util.FilterReader
  FilterReader (TextReader inp)
 
override void  Dispose (bool disposing)
 

Additional Inherited Members
- Protected Attributes inherited from iText.IO.Util.FilterReader
TextReader  inp
 

Detailed Description

A character-stream reader that allows characters to be pushed back into the stream.

Author
Mark Reinhold
Since
JDK1.1

Constructor & Destructor Documentation

◆ PushbackReader() [1/2]

iText.IO.Util.PushbackReader.PushbackReader ( TextReader  inp,
int  size 
)
inline

Creates a new pushback reader with a pushback buffer of the given size.

Parameters
in The reader from which characters will be read
size The size of the pushback buffer
Exceptions
IllegalArgumentException if size is ≤ 0

◆ PushbackReader() [2/2]

iText.IO.Util.PushbackReader.PushbackReader ( TextReader  inp )
inline

Creates a new pushback reader with a one-character pushback buffer.

Parameters
in The reader from which characters will be read

Member Function Documentation

◆ Dispose()

override void iText.IO.Util.PushbackReader.Dispose ( bool  disposing )
inlineprotected

Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), unread(), ready(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect.

Exceptions
IOException If an I/O error occurs

◆ Read() [1/2]

override int iText.IO.Util.PushbackReader.Read ( )
inline

Reads a single character.

Returns
The character read, or -1 if the end of the stream has been reached
Exceptions
IOException If an I/O error occurs

◆ Read() [2/2]

override int iText.IO.Util.PushbackReader.Read ( char[]  cbuf,
int  off,
int  len 
)
inline

Reads characters into a portion of an array.

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
Exceptions
IOException If an I/O error occurs

◆ Unread() [1/3]

virtual void iText.IO.Util.PushbackReader.Unread ( char[]  cbuf )
inlinevirtual

Pushes back an array of characters by copying it to the front of the pushback buffer. After this method returns, the next character to be read will have the value

cbuf[0], the character after that will have the value cbuf[1], and so forth.

Parameters
cbuf Character array to push back
Exceptions
IOException If there is insufficient room in the pushback buffer, or if some other I/O error occurs

◆ Unread() [2/3]

virtual void iText.IO.Util.PushbackReader.Unread ( char[]  cbuf,
int  off,
int  len 
)
inlinevirtual

Pushes back a portion of an array of characters by copying it to the front of the pushback buffer. After this method returns, the next character to be read will have the value

cbuf[off], the character after that will have the value cbuf[off+1], and so forth.

Parameters
cbuf Character array
off Offset of first character to push back
len Number of characters to push back
Exceptions
IOException If there is insufficient room in the pushback buffer, or if some other I/O error occurs

◆ Unread() [3/3]

virtual void iText.IO.Util.PushbackReader.Unread ( int  c )
inlinevirtual

Pushes back a single character by copying it to the front of the pushback buffer. After this method returns, the next character to be read will have the value

(char)c.

Parameters
c The int value representing a character to be pushed back
Exceptions
IOException If the pushback buffer is full, or if some other I/O error occurs