org.kitteh.irc.client.library.element

Interface ServerMessage

All Known Subinterfaces:

ServerMessage.NumericCommandServerMessage, ServerMessage.StringCommandServerMessage

All Known Implementing Classes:

DefaultServerMessage, DefaultServerMessage.NumericCommand, DefaultServerMessage.StringCommand

public interface ServerMessage

Represents a message sent by the server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServerMessage.NumericCommandServerMessage Represents a message with a numeric command.
static interface	ServerMessage.StringCommandServerMessage Represents a message with a String command.

Method Summary

Modifier and Type	Method and Description
@NonNull String	getMessage() Gets the full content of the line sent by the server, minus linebreak characters \r and \n.
default Optional<MessageTag>	getTag(@NonNull String name) Gets the named tag if present.
default <Tag extends MessageTag> @NonNull Optional<Tag>	getTag(@NonNull String name, @NonNull Class<Tag> clazz) Gets the named message tag if present and if of the specified type.
@NonNull List<MessageTag>	getTags() Gets the processed message tags, if any, contained in the message.

Method Detail

getMessage

@NonNull String getMessage()

Gets the full content of the line sent by the server, minus linebreak characters \r and \n.

Returns:

full message content

getTags

@NonNull List<MessageTag> getTags()

Gets the processed message tags, if any, contained in the message.

Returns:

message tags or empty if none sent.

getTag

default Optional<MessageTag> getTag(@NonNull String name)

Gets the named tag if present.

Parameters:

name - tag name

Returns:

tag if present

getTag

default <Tag extends MessageTag> @NonNull Optional<Tag> getTag(@NonNull String name,
                                                               @NonNull Class<Tag> clazz)

Gets the named message tag if present and if of the specified type.

Type Parameters:

Tag - message tag type

Parameters:

name - message tag name

clazz - message tag type

Returns:

message tag if present