ORO, Inc. Logo  All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.oroinc.io.FromNetASCIIInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FilterInputStream
                   |
                   +----java.io.PushbackInputStream
                           |
                           +----com.oroinc.io.FromNetASCIIInputStream

public final class FromNetASCIIInputStream
extends PushbackInputStream
This class wraps an input stream, replacing all occurrences of <CR><LF> (carriage return followed by a linefeed), which is the NETASCII standard for representing a newline, with the local line separator representation. You would use this class to implement ASCII file transfers requiring conversion from NETASCII.

Copyright © 1997 Original Reusable Objects, Inc. All rights reserved.


Constructor Index

 o FromNetASCIIInputStream(InputStream)
Creates a FromNetASCIIInputStream instance that wraps an existing InputStream.

Method Index

 o available()
Returns the number of bytes that can be read without blocking EXCEPT when newline conversions have to be made somewhere within the available block of bytes.
 o isConversionRequired()
Returns true if the NetASCII line separator differs from the system line separator, false if they are the same.
 o read()
Reads and returns the next byte in the stream.
 o read(byte[])
Reads the next number of bytes from the stream into an array and returns the number of bytes read.
 o read(byte[], int, int)
Reads the next number of bytes from the stream into an array and returns the number of bytes read.

Constructors

 o FromNetASCIIInputStream
 public FromNetASCIIInputStream(InputStream input)
Creates a FromNetASCIIInputStream instance that wraps an existing InputStream.

Methods

 o isConversionRequired
 public static final boolean isConversionRequired()
Returns true if the NetASCII line separator differs from the system line separator, false if they are the same. This method is useful to determine whether or not you need to instantiate a FromNetASCIIInputStream object.

Returns:
True if the NETASCII line separator differs from the local system line separator, false if they are the same.
 o read
 public int read() throws IOException
Reads and returns the next byte in the stream. If the end of the message has been reached, returns -1. Note that a call to this method may result in multiple reads from the underlying input stream in order to convert NETASCII line separators to the local line separator format. This is transparent to the programmer and is only mentioned for completeness.

Returns:
The next character in the stream. Returns -1 if the end of the stream has been reached.
Throws: IOException
If an error occurs while reading the underlying stream.
Overrides:
read in class PushbackInputStream
 o read
 public int read(byte buffer[]) throws IOException
Reads the next number of bytes from the stream into an array and returns the number of bytes read. Returns -1 if the end of the stream has been reached.

Parameters:
buffer - The byte array in which to store the data.
Returns:
The number of bytes read. Returns -1 if the end of the message has been reached.
Throws: IOException
If an error occurs in reading the underlying stream.
Overrides:
read in class FilterInputStream
 o read
 public int read(byte buffer[],
                 int offset,
                 int length) throws IOException
Reads the next number of bytes from the stream into an array and returns the number of bytes read. Returns -1 if the end of the message has been reached. The characters are stored in the array starting from the given offset and up to the length specified.

Parameters:
buffer - The byte array in which to store the data.
offset - The offset into the array at which to start storing data.
length - The number of bytes to read.
Returns:
The number of bytes read. Returns -1 if the end of the stream has been reached.
Throws: IOException
If an error occurs while reading the underlying stream.
Overrides:
read in class PushbackInputStream
 o available
 public int available() throws IOException
Returns the number of bytes that can be read without blocking EXCEPT when newline conversions have to be made somewhere within the available block of bytes. In other words, you really should not rely on the value returned by this method if you are trying to avoid blocking.

Overrides:
available in class PushbackInputStream

ORO, Inc. Logo  All Packages  Class Hierarchy  This Package  Previous  Next  Index