io.github.spair.byond.message

Class ByondMessage

java.lang.Object

io.github.spair.byond.message.ByondMessage

public class ByondMessage
extends Object

Container for message, which will be sent to BYOND server.

Has server address as ServerAddress (used by ByondClient to know, where message should be send), message as String and type of expected response as ResponseType.

Message must contain question mark in the beginning of string, but it could be omitted, because it will be added on send process automatically if missing. So "ping" and "?ping" will do the same. Also, message itself is like a parameters for HTTP request, so multiple messages in one send is possible. To do it all params should be divided with ";" or "&". For example: "ping&data=123&status".

Expected response type checked on response validation process. If real response doesn't match, exception UnexpectedResponseTypeException will be thrown. Default expected response is ResponseType.ANY.

Constructor Summary

Constructors

Constructor and Description
ByondMessage()
ByondMessage(ServerAddress serverAddress, String message)
ByondMessage(ServerAddress serverAddress, String message, ResponseType expectedResponse)
ByondMessage(String serverName, int serverPort, String message)
ByondMessage(String serverName, int serverPort, String message, ResponseType expectedResponse)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ResponseType	getExpectedResponse()
String	getMessage()
String	getMessageAsTopic() Checks if message has question mark in the beginning, and, if it isn't, adds it and return new string, so message in 'this' instance doesn't touched.
ServerAddress	getServerAddress()
int	hashCode()
void	setExpectedResponse(ResponseType expectedResponse)
void	setMessage(String message)
void	setServerAddress(ServerAddress serverAddress)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ByondMessage

public ByondMessage()

ByondMessage

public ByondMessage(ServerAddress serverAddress,
                    String message)

ByondMessage

public ByondMessage(ServerAddress serverAddress,
                    String message,
                    ResponseType expectedResponse)

ByondMessage

public ByondMessage(String serverName,
                    int serverPort,
                    String message)

ByondMessage

public ByondMessage(String serverName,
                    int serverPort,
                    String message,
                    ResponseType expectedResponse)

Method Detail

getMessageAsTopic

public String getMessageAsTopic()

Checks if message has question mark in the beginning, and, if it isn't, adds it and return new string, so message in 'this' instance doesn't touched. Otherwise already exist message will be returned.

Returns:

Message string with question mark in the beginning.

getServerAddress

public ServerAddress getServerAddress()

setServerAddress

public void setServerAddress(ServerAddress serverAddress)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getExpectedResponse

public ResponseType getExpectedResponse()

setExpectedResponse

public void setExpectedResponse(ResponseType expectedResponse)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object