aria.apache.commons.net.io

类 FromNetASCIIInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

java.io.PushbackInputStream

aria.apache.commons.net.io.FromNetASCIIInputStream

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable

public final class FromNetASCIIInputStream
extends java.io.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.

字段概要

从类继承的字段 java.io.PushbackInputStream

buf, pos

从类继承的字段 java.io.FilterInputStream

in

构造器概要

构造器

构造器和说明
FromNetASCIIInputStream(java.io.InputStream input) Creates a FromNetASCIIInputStream instance that wraps an existing InputStream.

方法概要

限定符和类型	方法和说明
int	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.
static boolean	isConversionRequired() Returns true if the NetASCII line separator differs from the system line separator, false if they are the same.
int	read() Reads and returns the next byte in the stream.
int	read(byte[] buffer) Reads the next number of bytes from the stream into an array and returns the number of bytes read.
int	read(byte[] buffer, int offset, int length) Reads the next number of bytes from the stream into an array and returns the number of bytes read.

从类继承的方法 java.io.PushbackInputStream

close, mark, markSupported, reset, skip, unread, unread, unread

从类继承的方法 java.lang.Object

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

构造器详细资料

FromNetASCIIInputStream

public FromNetASCIIInputStream(java.io.InputStream input)

Creates a FromNetASCIIInputStream instance that wraps an existing InputStream.

参数:

input - the stream to wrap

方法详细资料

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.

返回:

True if the NETASCII line separator differs from the local system line separator, false if they are the same.

read

public int read()
         throws java.io.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.

覆盖:

read 在类中 java.io.PushbackInputStream

返回:

The next character in the stream. Returns -1 if the end of the stream has been reached.

抛出:

java.io.IOException - If an error occurs while reading the underlying stream.

read

public int read(byte[] buffer)
         throws java.io.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.

覆盖:

read 在类中 java.io.FilterInputStream

参数:

buffer - The byte array in which to store the data.

返回:

The number of bytes read. Returns -1 if the end of the message has been reached.

抛出:

java.io.IOException - If an error occurs in reading the underlying stream.

read

public int read(byte[] buffer,
                int offset,
                int length)
         throws java.io.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.

覆盖:

read 在类中 java.io.PushbackInputStream

参数:

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.

返回:

The number of bytes read. Returns -1 if the end of the stream has been reached.

抛出:

java.io.IOException - If an error occurs while reading the underlying stream.

available

public int available()
              throws java.io.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.

覆盖:

available 在类中 java.io.PushbackInputStream

抛出:

java.io.IOException