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

Class DefaultModeStatus<ModeType extends Mode>

java.lang.Object

org.kitteh.irc.client.library.defaults.element.mode.DefaultModeStatus<ModeType>

All Implemented Interfaces:

ClientLinked, ModeStatus<ModeType>

public class DefaultModeStatus<ModeType extends Mode>
extends Object
implements ModeStatus<ModeType>

A particular default status of a mode.

Nested Class Summary

Nested classes/interfaces inherited from interface org.kitteh.irc.client.library.element.mode.ModeStatus

ModeStatus.Action

Constructor Summary

Constructors

Constructor and Description
DefaultModeStatus(ModeStatus.Action action, ModeType mode) Creates a status without a parameter.
DefaultModeStatus(ModeStatus.Action action, ModeType mode, @NonNull String parameter) Creates a status.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultModeStatus

public DefaultModeStatus(ModeStatus.Action action,
                         ModeType mode)

Creates a status without a parameter.

Parameters:

action - adding or removing

mode - mode to set

DefaultModeStatus

public DefaultModeStatus(ModeStatus.Action action,
                         ModeType mode,
                         @NonNull String parameter)

Creates a status.

Parameters:

action - adding or removing

mode - mode to set

parameter - parameter

Method Detail

getAction

public @NonNull ModeStatus.Action getAction()

Description copied from interface: ModeStatus

Gets if the mode is being set or removed.

Specified by:

getAction in interface ModeStatus<ModeType extends Mode>

Returns:

the action, add or remove

getClient

public @NonNull Client getClient()

Description copied from interface: ClientLinked

Gets the Client to which this belongs.

Specified by:

getClient in interface ClientLinked

Returns:

the client

getMode

public ModeType getMode()

Description copied from interface: ModeStatus

Gets the Mode describing this mode status.

Specified by:

getMode in interface ModeStatus<ModeType extends Mode>

Returns:

the mode

getParameter

public @NonNull Optional<String> getParameter()

Description copied from interface: ModeStatus

Gets the parameter for the mode status, if applicable.

Specified by:

getParameter in interface ModeStatus<ModeType extends Mode>

Returns:

parameter if present

toString

public @NonNull String toString()

Overrides:

toString in class Object