net.jetrix.protocols
Class QueryProtocol

java.lang.Object
  net.jetrix.protocols.AbstractProtocol
      net.jetrix.protocols.QueryProtocol

All Implemented Interfaces:

Protocol

public class QueryProtocol
extends AbstractProtocol

Query Protocol. See http://jetrix.sourceforge.net/dev-guide.php#section2-4 for more information.

Version:

$Revision: 798 $, $Date: 2009-02-18 16:24:28 +0100 (Wed, 18 Feb 2009) $

Author:

Emmanuel Bourg

Field Summary

static char	EOL Line terminator
static String	OK Response terminator

Constructor Summary

QueryProtocol()

Method Summary

String	applyStyle(String text) Transform the style tags (<blue>, <u>, etc...) contained in the specified string into the style codes of this protocol.
char	getEOL() Return the end of line character used by this protocol.
Message	getMessage(String message) Parse the specified string and return the corresponding server message for this protocol.
String	getName() Return the name of this protocol.
static boolean	isQueryCommand(String command) Test if the specified string is a valid query request.
String	translate(Message m, Locale locale) Translate the specified message into a string that will be sent to a client using this protocol.
String	translate(NoConnectingMessage m, Locale locale)
String	translate(PlineMessage m, Locale locale)

Methods inherited from class net.jetrix.protocols.AbstractProtocol

equals, hashCode, readFrame, readLine, toString

Methods inherited from class java.lang.Object

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

Field Detail

EOL

public static final char EOL

Line terminator

See Also:

Constant Field Values

OK

public static final String OK

Response terminator

See Also:

Constant Field Values

Constructor Detail

QueryProtocol

public QueryProtocol()

Method Detail

getName

public String getName()

Description copied from interface: Protocol

Return the name of this protocol.

Returns:

the name of this protocol

getMessage

public Message getMessage(String message)

Description copied from interface: Protocol

Parse the specified string and return the corresponding server message for this protocol.

Parameters:

message - the client message to parse

Returns:

the Message equivalent of the specified String or null if the protocol cannot understand the message.

translate

public String translate(Message m,
                        Locale locale)

Description copied from interface: Protocol

Translate the specified message into a string that will be sent to a client using this protocol.

Parameters:

m - the message to translate

locale - the locale used for internationalized text messages

Returns:

the String equivalent in this protocol for the specified Message or null if it can't be translated.

translate

public String translate(PlineMessage m,
                        Locale locale)

translate

public String translate(NoConnectingMessage m,
                        Locale locale)

applyStyle

public String applyStyle(String text)

Description copied from interface: Protocol

Transform the style tags (<blue>, <u>, etc...) contained in the specified string into the style codes of this protocol.

Parameters:

text - the string to transform

Returns:

the stylized representation of the specified string for this protocol.

getEOL

public char getEOL()

Description copied from interface: Protocol

Return the end of line character used by this protocol.

isQueryCommand

public static boolean isQueryCommand(String command)

Test if the specified string is a valid query request.