management.cli

Class EventedInputStream

java.lang.Object

java.io.InputStream

management.cli.EventedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, ShellEvent

public class EventedInputStream
extends InputStream
implements ShellEvent

Input stream class for simulating shell events

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SIZE

Fields inherited from interface management.cli.ShellEvent

COMMAND_SEP, EOF, NEW_LINE, TAB

Constructor Summary

Constructors

Constructor and Description
EventedInputStream()
EventedInputStream(int size)

Method Summary

Modifier and Type	Method and Description
ShellEvent	addChars(String seq)
ShellEvent	addCtrlD()
ShellEvent	addCtrlZ()
int	available() Returns the number of remaining bytes that can be read (or skipped over) from this input stream.
void	clearEvents()
void	close() Closing a ByteArrayInputStream has no effect.
ShellEvent	end()
void	eof()
StringBuilder	getBufferFormdAfterReading()
void	mark(int readAheadLimit) Set the current marked position in the stream.
boolean	markSupported() Tests if this InputStream supports mark/reset.
ShellEvent	newline()
int	read() Reads the next byte of data from this input stream.
int	read(byte[] b, int off, int len) Reads up to len bytes of data into an array of bytes from this input stream.
void	reset() Resets the buffer to the marked position.
long	skip(long n) Skips n bytes of input from this input stream.
ShellEvent	tab()
void	terminate()
void	waitForOutput()

Methods inherited from class java.io.InputStream

read

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

Constant Field Values

Constructor Detail

EventedInputStream

public EventedInputStream(int size)

EventedInputStream

public EventedInputStream()

Method Detail

read

public int read()

Reads the next byte of data from this input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned.

This read method cannot block.

Specified by:

read in class InputStream

Returns:

the next byte of data, or -1 if the end of the stream has been reached.

read

public int read(byte[] b,
                int off,
                int len)

Reads up to len bytes of data into an array of bytes from this input stream. If pos equals count, then -1 is returned to indicate end of file. Otherwise, the number k of bytes read is equal to the smaller of len and count-pos. If k is positive, then bytes buf[pos] through buf[pos+k-1] are copied into b[off] through b[off+k-1] in the manner performed by System.arraycopy. The value k is added into pos and k is returned.

This read method cannot block.

Overrides:

read in class InputStream

Parameters:

b - the buffer into which the data is read.

off - the start offset in the destination array b

len - the maximum number of bytes read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

NullPointerException - If b is null.

IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off

skip

public long skip(long n)

Skips n bytes of input from this input stream. Fewer bytes might be skipped if the end of the input stream is reached. The actual number k of bytes to be skipped is equal to the smaller of n and count-pos. The value k is added into pos and k is returned.

Overrides:

skip in class InputStream

Parameters:

n - the number of bytes to be skipped.

Returns:

the actual number of bytes skipped.

available

public int available()

Returns the number of remaining bytes that can be read (or skipped over) from this input stream.

The value returned is count - pos, which is the number of bytes remaining to be read from the input buffer.

Overrides:

available in class InputStream

Returns:

the number of remaining bytes that can be read (or skipped over) from this input stream without blocking.

markSupported

public boolean markSupported()

Tests if this InputStream supports mark/reset. The markSupported method of ByteArrayInputStream always returns true.

Overrides:

markSupported in class InputStream

Since:

JDK1.1

mark

public void mark(int readAheadLimit)

Set the current marked position in the stream. ByteArrayInputStream objects are marked at position zero by default when constructed. They may be marked at another position within the buffer by this method.

If no mark has been set, then the value of the mark is the offset passed to the constructor (or 0 if the offset was not supplied).

Note: The readAheadLimit for this class has no meaning.

Overrides:

mark in class InputStream

Since:

JDK1.1

reset

public void reset()

Resets the buffer to the marked position. The marked position is 0 unless another position was marked or an offset was specified in the constructor.

Overrides:

reset in class InputStream

close

public void close()
           throws IOException

Closing a ByteArrayInputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

tab

public ShellEvent tab()
               throws IOException

Specified by:

tab in interface ShellEvent

Throws:

IOException

addChars

public ShellEvent addChars(String seq)
                    throws IOException

Specified by:

addChars in interface ShellEvent

Throws:

IOException

addCtrlZ

public ShellEvent addCtrlZ()
                    throws IOException

Specified by:

addCtrlZ in interface ShellEvent

Throws:

IOException

addCtrlD

public ShellEvent addCtrlD()
                    throws IOException

Specified by:

addCtrlD in interface ShellEvent

Throws:

IOException

newline

public ShellEvent newline()
                   throws IOException

Specified by:

newline in interface ShellEvent

Throws:

IOException

end

public ShellEvent end()

Specified by:

end in interface ShellEvent

clearEvents

public void clearEvents()

Specified by:

clearEvents in interface ShellEvent

getBufferFormdAfterReading

public StringBuilder getBufferFormdAfterReading()

waitForOutput

public void waitForOutput()

Specified by:

waitForOutput in interface ShellEvent

terminate

public void terminate()

Specified by:

terminate in interface ShellEvent

eof

public void eof()

Specified by:

eof in interface ShellEvent