Top Description Fields Constructors Methods
org.apache.sshd.common.util.io.output

public abstract Class LineOutputStream

extends OutputStream
Class Inheritance
Known Direct Subclasses
org.apache.sshd.common.util.io.output.LineLevelAppenderStream
Imports
java.io.IOException, .OutputStream
Calls the actual writing method only when LF detected in the written stream

Note

it strips CR if found before the LF

Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
protected byte[]
lineBuf

protected final byte[]
oneByte

protected int
usedLen

Constructor Summary

AccessConstructor and Description
protected
LineOutputStream()

Method Summary

Modifier and TypeMethod and Description
protected void
accumulateLineData(byte[] b, int off, int len)

public void
close()

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with this stream.

protected abstract void
handleLine(byte[] buf, int offset, int len)

public void
write(int
the byte.
b)

Implements abstract java.io.OutputStream.write.

Writes the specified byte to this output stream.

public void
write(byte[]
the data.
b)

Overrides java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream.

public void
write(byte[]
the data.
b, int
the start offset in the data.
off, int
the number of bytes to write.
len)

Overrides java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.

Inherited from java.io.OutputStream:
flushnullOutputStream

Field Detail

lineBufback to summary
protected byte[] lineBuf
oneByteback to summary
protected final byte[] oneByte
usedLenback to summary
protected int usedLen

Constructor Detail

LineOutputStreamback to summary
protected LineOutputStream()

Method Detail

accumulateLineDataback to summary
protected void accumulateLineData(byte[] b, int off, int len) throws IOException
closeback to summary
public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
handleLineback to summary
protected abstract void handleLine(byte[] buf, int offset, int len) throws IOException
writeback to summary
public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters
b:int

the byte.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
writeback to summary
public void write(byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters
b:byte[]

the data.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(byte[] b, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters
b:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.