ej.rcommand.impl

Class StreamRemoteConnection

java.lang.Object

ej.rcommand.impl.StreamRemoteConnection

All Implemented Interfaces:

CommandReader, CommandSender, RemoteConnection

Direct Known Subclasses:

SocketRemoteConnection

public class StreamRemoteConnection
extends Object
implements RemoteConnection

Constructor Summary

Constructors

Constructor and Description
StreamRemoteConnection(InputStream is, OutputStream os)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
void	flushCommand() Ends the command frame.
InputStream	getInputStream() Get the InputStream used by the instance.
OutputStream	getOutputStream() Get the OuputStream used by the instance.
boolean	readBoolean() Reads a boolean parameter.
byte[]	readByteArray() Reads a byte array parameter.
InputStream	readByteArrayAsInputStream() Reads a byte array using an input stream.
String	readCommand() Reads a command.
double	readDouble() Reads a double parameter.
float	readFloat() Reads a float parameter.
InputStream	readInputStream() Reads an input stream.
int	readInt() Reads an integer parameter.
long	readLong() Reads a long parameter.
Object	readObject() Reads a parameter, whatever it's type.
List<Object>	readParameters() Reads the parameters of a command.
String	readString() Reads a string parameter.
protected void	releaseLock()
void	sendBoolean(boolean b) Sends a boolean parameter.
void	sendByteArray(byte[] a) Sends a byte array parameter.
void	sendByteArray(byte[] buffer, int offset, int length) Sends a byte array parameter with offset and length.
void	sendByteArrayAsInputStream(InputStream is) Sends a byte array parameter using an input stream.
void	sendDouble(double d) Sends a double parameter.
void	sendFloat(float f) Sends a float parameter.
void	sendInputStream(InputStream is) Sends an input stream.
void	sendInt(int i) Sends an integer parameter.
void	sendLong(long l) Sends a long parameter.
void	sendParams(List<Object> params) Sends the given parameters.
void	sendString(String s) Sends a string parameter.
void	skipParameters() Skips the parameters of a command and get ready to read the following command.
void	startCommand(String command) Starts a command.
protected void	takeLock()

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamRemoteConnection

public StreamRemoteConnection(InputStream is,
                              OutputStream os)

Method Detail

close

public void close()

Description copied from interface: RemoteConnection

Closes the connection.

Specified by:

close in interface RemoteConnection

flushCommand

public void flushCommand()

Description copied from interface: CommandSender

Ends the command frame.

Specified by:

flushCommand in interface CommandSender

getInputStream

@Nullable
public InputStream getInputStream()

Description copied from interface: CommandSender

Get the InputStream used by the instance.

Specified by:

getInputStream in interface CommandSender

Returns:

the InputStream used by the instance, or null if this command sender is not ready to send a command.

getOutputStream

@Nullable
public OutputStream getOutputStream()

Description copied from interface: CommandSender

Get the OuputStream used by the instance.

Specified by:

getOutputStream in interface CommandSender

Returns:

the OuputStream used by the instance, or null if this command sender is not ready to send a command.

readBoolean

public boolean readBoolean()
                    throws IOException

Description copied from interface: CommandReader

Reads a boolean parameter.

Specified by:

readBoolean in interface CommandReader

Returns:

the read boolean.

Throws:

IOException - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readByteArray

public byte[] readByteArray()
                     throws IOException

Description copied from interface: CommandReader

Reads a byte array parameter.

Specified by:

readByteArray in interface CommandReader

Returns:

the read byte array.

Throws:

IOException - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readByteArrayAsInputStream

public InputStream readByteArrayAsInputStream()
                                       throws IOException

Description copied from interface: CommandReader

Reads a byte array using an input stream.

The returned input stream must be fully read before returning the method.

Specified by:

readByteArrayAsInputStream in interface CommandReader

Returns:

an inputStream that reads the underlying byte array.

Throws:

IOException - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readCommand

public String readCommand()
                   throws IOException

Description copied from interface: CommandReader

Reads a command.

Specified by:

readCommand in interface CommandReader

Returns:

the command name.

Throws:

IOException - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readDouble

public double readDouble()
                  throws IOException

Description copied from interface: CommandReader

Reads a double parameter.

Specified by:

readDouble in interface CommandReader

Returns:

the read double.

Throws:

IOException - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readFloat

public float readFloat()
                throws IOException

Description copied from interface: CommandReader

Reads a float parameter.

Specified by:

readFloat in interface CommandReader

Returns:

the read float.

Throws:

IOException - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readInputStream

public InputStream readInputStream()
                            throws IOException

Description copied from interface: CommandReader

Reads an input stream.

The returned input stream must be fully read before returning the method.

Specified by:

readInputStream in interface CommandReader

Returns:

an inputStream.

Throws:

IOException - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readInt

public int readInt()
            throws IOException

Description copied from interface: CommandReader

Reads an integer parameter.

Specified by:

readInt in interface CommandReader

Returns:

the read integer.

Throws:

IOException - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readLong

public long readLong()
              throws IOException

Description copied from interface: CommandReader

Reads a long parameter.

Specified by:

readLong in interface CommandReader

Returns:

the read long.

Throws:

IOException - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readObject

public Object readObject()
                  throws IOException

Description copied from interface: CommandReader

Reads a parameter, whatever it's type. Note that if the parameter is a byte array, it will be returned as an InputStream that must be completely consumed before reading the next parameter.

Specified by:

readObject in interface CommandReader

Returns:

an object reflecting the read parameter.

Throws:

IOException - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readParameters

public List<Object> readParameters()
                            throws IOException

Description copied from interface: RemoteConnection

Reads the parameters of a command.

Method CommandReader.skipParameters() must be called after to be ready to read the following command.

Specified by:

readParameters in interface RemoteConnection

Returns:

list of the parameters.

Throws:

IOException

readString

public String readString()
                  throws IOException

Description copied from interface: CommandReader

Reads a string parameter.

Specified by:

readString in interface CommandReader

Returns:

the read string.

Throws:

IOException - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

releaseLock

protected void releaseLock()

sendBoolean

public void sendBoolean(boolean b)

Description copied from interface: CommandSender

Sends a boolean parameter.

Specified by:

sendBoolean in interface CommandSender

Parameters:

b - the boolean to send.

sendByteArray

public void sendByteArray(byte[] a)

Description copied from interface: CommandSender

Sends a byte array parameter.

Specified by:

sendByteArray in interface CommandSender

Parameters:

a - the byte array to send.

sendByteArray

public void sendByteArray(byte[] buffer,
                          int offset,
                          int length)

Description copied from interface: CommandSender

Sends a byte array parameter with offset and length.

Specified by:

sendByteArray in interface CommandSender

Parameters:

buffer - the byte array to send.

offset - offset in the byte array.

length - data length to send.

sendByteArrayAsInputStream

public void sendByteArrayAsInputStream(InputStream is)

Description copied from interface: CommandSender

Sends a byte array parameter using an input stream.

The given input stream is fully read.

Specified by:

sendByteArrayAsInputStream in interface CommandSender

Parameters:

is - the input stream to send.

sendDouble

public void sendDouble(double d)

Description copied from interface: CommandSender

Sends a double parameter.

Specified by:

sendDouble in interface CommandSender

Parameters:

d - the double to send.

sendFloat

public void sendFloat(float f)

Description copied from interface: CommandSender

Sends a float parameter.

Specified by:

sendFloat in interface CommandSender

Parameters:

f - the float to send.

sendInputStream

public void sendInputStream(InputStream is)

Description copied from interface: CommandSender

Sends an input stream.

Specified by:

sendInputStream in interface CommandSender

Parameters:

is - the input stream to send.

sendInt

public void sendInt(int i)

Description copied from interface: CommandSender

Sends an integer parameter.

Specified by:

sendInt in interface CommandSender

Parameters:

i - the integer to send.

sendLong

public void sendLong(long l)

Description copied from interface: CommandSender

Sends a long parameter.

Specified by:

sendLong in interface CommandSender

Parameters:

l - the long to send.

sendParams

public void sendParams(List<Object> params)

Description copied from interface: RemoteConnection

Sends the given parameters.

Specified by:

sendParams in interface RemoteConnection

Parameters:

params - the list of parameters to send.

sendString

public void sendString(String s)

Description copied from interface: CommandSender

Sends a string parameter.

Specified by:

sendString in interface CommandSender

Parameters:

s - the string to send.

skipParameters

public void skipParameters()
                    throws IOException

Description copied from interface: CommandReader

Skips the parameters of a command and get ready to read the following command.

Specified by:

skipParameters in interface CommandReader

Throws:

IOException

startCommand

public void startCommand(String command)

Description copied from interface: CommandSender

Starts a command.

A command can be followed by arguments.

Specified by:

startCommand in interface CommandSender

Parameters:

command - the command name.

takeLock

protected void takeLock()