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

Class ModeStatus<ModeType extends Mode>

java.lang.Object

org.kitteh.irc.client.library.element.mode.ModeStatus<ModeType>

All Implemented Interfaces:

ClientLinked

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

A particular status of a mode.

Constructor Summary

Constructors

Constructor and Description
ModeStatus(boolean setting, ModeType mode) Creates a status without a parameter.
ModeStatus(boolean setting, ModeType mode, String parameter) Creates a status.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ModeStatus

public ModeStatus(boolean setting,
                  @Nonnull
                  ModeType mode)

Creates a status without a parameter.

Parameters:

setting - true for setting mode, false for removing

mode - mode to set

ModeStatus

public ModeStatus(boolean setting,
                  @Nonnull
                  ModeType mode,
                  @Nonnull
                  String parameter)

Creates a status.

Parameters:

setting - true for setting mode, false for removing

mode - mode to set

parameter - parameter

Method Detail

getClient

@Nonnull
public Client getClient()

Description copied from interface: ClientLinked

Gets the Client to which this belongs.

Specified by:

getClient in interface ClientLinked

Returns:

the client

getMode

@Nonnull
public ModeType getMode()

Gets the Mode describing this mode status.

Returns:

the mode

getParameter

@Nonnull
public Optional<String> getParameter()

Gets the parameter for the mode status, if applicable.

Returns:

parameter if present

isSetting

public boolean isSetting()

Gets if this mode is being set.

Returns:

true for setting, false for removing

toString

@Nonnull
public String toString()

Overrides:

toString in class Object