org.kitteh.irc.client.library.element.mode

Interface ModeStatus<ModeType extends Mode>

All Superinterfaces:

ClientLinked

All Known Implementing Classes:

DefaultModeStatus

public interface ModeStatus<ModeType extends Mode>
extends ClientLinked

A particular status of a mode.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ModeStatus.Action Describes the mode status.

Method Summary

Modifier and Type	Method and Description
@NonNull ModeStatus.Action	getAction() Gets if the mode is being set or removed.
ModeType	getMode() Gets the Mode describing this mode status.
@NonNull Optional<String>	getParameter() Gets the parameter for the mode status, if applicable.

Methods inherited from interface org.kitteh.irc.client.library.element.ClientLinked

getClient

Method Detail

getAction

@NonNull ModeStatus.Action getAction()

Gets if the mode is being set or removed.

Returns:

the action, add or remove

getMode

ModeType getMode()

Gets the Mode describing this mode status.

Returns:

the mode

getParameter

@NonNull Optional<String> getParameter()

Gets the parameter for the mode status, if applicable.

Returns:

parameter if present