Class ServerUtil

java.lang.Object

ServerUtil

public final class ServerUtil
extends Object

Class providing static utility methods to help in creating and testing the ServerModel.

Method Summary

Methods

Modifier and Type	Method and Description
static String	generateNamesPayload(String owner, Collection<String> nicks) Generates a correct payload for a NAMES response for some channel given the owner nick for that channel and a collection of all users on that channel, including the owner.
static boolean	isValidNickname(String nick) Determines if a given nickname is valid (contains 1 or more alphanumeric characters).
static Command	makeConnect() Convenience method to generate a CONNECT Command.
static Command	makeCreate(String channelName, boolean inviteOnly) Convenience method to generate a CREATE Command.
static Command	makeInvite(String channelName, String invitee) Convenience method to generate an INVITE Command.
static Command	makeJoin(String channelName) Convenience method to generate a JOIN Command.
static Command	makeKick(String channelName, String target, String payload) Convenience method to generate a KICK Command.
static Command	makeLeave(String channelName, String message) Convenience method to generate a LEAVE Command.
static Command	makeMesg(String channelName, String payload) Convenience method to generate a MESG Command.
static Command	makeNames(String channelName, String payload) Convenience method to generate a NAMES Command.
static Command	makeNick(String newNick) Convenience method to generate a NICK Command.
static Command	makeQuit() Convenience method to generate a QUIT Command.

Methods inherited from class java.lang.Object

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

Method Detail

makeConnect

public static Command makeConnect()

Convenience method to generate a CONNECT Command.

Returns:

a new CONNECT Command

makeNick

public static Command makeNick(String newNick)

Convenience method to generate a NICK Command.

Parameters:

newNick - the sender's new desired nickname

Returns:

a new NICK Command with the specified component

makeCreate

public static Command makeCreate(String channelName,
                 boolean inviteOnly)

Convenience method to generate a CREATE Command.

Parameters:

channelName - the name of the channel to be created

inviteOnly - true if the channel should be invite-only, and false otherwise

Returns:

a new CREATE Command with the specified components

makeJoin

public static Command makeJoin(String channelName)

Convenience method to generate a JOIN Command.

Parameters:

channelName - the name of the channel to be joined

Returns:

a new JOIN Command with the specified component

makeNames

public static Command makeNames(String channelName,
                String payload)

Convenience method to generate a NAMES Command.

Parameters:

channelName - the name of the channel whose member names were requested

payload - the payload representing the names of the channel users. This should follow the payload format specified in the assignment instructions

Returns:

a new NAMES Command with the specified components

makeLeave

public static Command makeLeave(String channelName,
                String message)

Convenience method to generate a LEAVE Command.

Parameters:

channelName - the name of the channel to leave

message - the (optional) leave message

Returns:

a new LEAVE Command with the specified components

makeMesg

public static Command makeMesg(String channelName,
               String payload)

Convenience method to generate a MESG Command.

Parameters:

channelName - the name of the channel on which to send the message

payload - the payload representing the message sent to the channel

Returns:

a new MESG Command with the specified components

makeKick

public static Command makeKick(String channelName,
               String target,
               String payload)

Convenience method to generate a KICK Command.

Parameters:

channelName - the name of the channel from which to kick the target

target - the nick of the user to kick

payload - the (optional) kick message

Returns:

a new KICK Command with the specified components

makeInvite

public static Command makeInvite(String channelName,
                 String invitee)

Convenience method to generate an INVITE Command.

Parameters:

channelName - the name of the channel to which the target is invited

invitee - the nick of the user to invite

Returns:

a new INVITE Command with the specified components

makeQuit

public static Command makeQuit()

Convenience method to generate a QUIT Command.

Returns:

a new QUIT Command

generateNamesPayload

public static String generateNamesPayload(String owner,
                          Collection<String> nicks)

Generates a correct payload for a NAMES response for some channel given the owner nick for that channel and a collection of all users on that channel, including the owner.

Parameters:

owner - the channel owner's nick

nicks - a collection of nicks for users of the channel, including the owner

Returns:

a correct NAMES payload containing the nicks specified

Throws:

IllegalArgumentException - if owner or nicks is null, or of nicks does not contain owner

isValidNickname

public static boolean isValidNickname(String nick)

Determines if a given nickname is valid (contains 1 or more alphanumeric characters).

Parameters:

nick - the string of the nickname to determine if it is valid

Returns:

true if the string is a valid nickname