com.bensherman.rtlsdrdjava.tcpcli

Class Message

java.lang.Object

com.bensherman.rtlsdrdjava.tcpcli.Message

public class Message
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.ResponseType This enum specifies the type of message contained in the responseMsg field.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	hasResponseBeenSet Whether or not the responseMsg field has been set.
private boolean	hasResponseTypeBeenSet Whether of not the responseType field has been set.
private java.lang.String	outboundMsg The message sent to the server
private java.lang.String	responseMsg The server's response message.
private Message.ResponseType	responseMsgType If this message's response represented an OK result or an error.

Constructor Summary

Constructors

Constructor and Description
Message(java.lang.String outboundMsg) Constructs a new Message given a message to be sent

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOutboundMsg()
java.lang.String	getResponseMsg()
Message.ResponseType	getResponseMsgType()
void	setResponseMessage(java.lang.String responseMsg) Sets the response of this message
void	setResponseType(Message.ResponseType responseMsgType) Sets the ResponseType of this message.
java.lang.String	toString() Basic toString() implementation to describe a Message

Methods inherited from class java.lang.Object

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

Field Detail

outboundMsg

private final java.lang.String outboundMsg

The message sent to the server

responseMsg

private java.lang.String responseMsg

The server's response message. Can only be set once externally.

hasResponseBeenSet

private boolean hasResponseBeenSet

Whether or not the responseMsg field has been set.

responseMsgType

private Message.ResponseType responseMsgType

If this message's response represented an OK result or an error. Can only be set once externally.

hasResponseTypeBeenSet

private boolean hasResponseTypeBeenSet

Whether of not the responseType field has been set.

Constructor Detail

Message

public Message(java.lang.String outboundMsg)

Constructs a new Message given a message to be sent

Parameters:

outboundMsg - The message to send

Method Detail

getOutboundMsg

public java.lang.String getOutboundMsg()

Returns:

The outbound/sent message

getResponseMsg

public java.lang.String getResponseMsg()

Returns:

The response message

getResponseMsgType

public Message.ResponseType getResponseMsgType()

Returns:

The response message's type

setResponseMessage

public void setResponseMessage(java.lang.String responseMsg)
                        throws java.lang.IllegalArgumentException

Sets the response of this message

Parameters:

responseMsg - The response to be set

Throws:

java.lang.IllegalArgumentException - If this method is called once responseMsg has already been set

setResponseType

public void setResponseType(Message.ResponseType responseMsgType)

Sets the ResponseType of this message.

Parameters:

responseMsgType - The new value of responseType

Throws:

IllegalArgument - If this method is called once responseType has already been set.

toString

public java.lang.String toString()

Basic toString() implementation to describe a Message

Overrides:

toString in class java.lang.Object