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

Class DefaultModeStatusList<ModeType extends Mode>

java.lang.Object

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

Type Parameters:

ModeType - type of modes being listed

All Implemented Interfaces:

ModeStatusList<ModeType>

public class DefaultModeStatusList<ModeType extends Mode>
extends Object
implements ModeStatusList<ModeType>

A default list of mode statuses.

Method Summary

Modifier and Type	Method and Description
boolean	contains(ModeType mode) Gets if the given mode is present in the list.
boolean	containsMode(char mode) Gets if the given mode character is present in the list.
static @NonNull DefaultModeStatusList<ChannelMode>	fromChannel(@NonNull Client client, @NonNull String string) Creates a list from a given string input such as "+o Kittens".
static @NonNull DefaultModeStatusList<UserMode>	fromUser(@NonNull Client client, @NonNull String string) Creates a list from a given string input such as "+iZ".
@NonNull List<ModeStatus<ModeType>>	getAll() Gets the list of statuses.
@NonNull String	getAsString() Gets the statuses in a convenient String format.
@NonNull List<ModeStatus<ModeType>>	getByMode(char mode) Gets all mode statuses of a given mode character.
@NonNull List<ModeStatus<ModeType>>	getByMode(ModeType mode) Gets all mode statuses of a given mode.
static <ModeType extends Mode> @NonNull DefaultModeStatusList<ModeType>	of(@NonNull Collection<ModeStatus<ModeType>> statuses) Creates a list of the given statuses.
static <ModeType extends Mode> @NonNull DefaultModeStatusList<ModeType>	of(ModeStatus<ModeType>... statuses) Creates a list of the given statuses.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

fromChannel

public static @NonNull DefaultModeStatusList<ChannelMode> fromChannel(@NonNull Client client,
                                                                      @NonNull String string)

Creates a list from a given string input such as "+o Kittens".

Parameters:

client - client for which this list exists

string - string to parse

Returns:

list

fromUser

public static @NonNull DefaultModeStatusList<UserMode> fromUser(@NonNull Client client,
                                                                @NonNull String string)

Creates a list from a given string input such as "+iZ".

Parameters:

client - client for which this list exists

string - string to parse

Returns:

list

of

public static <ModeType extends Mode> @NonNull DefaultModeStatusList<ModeType> of(ModeStatus<ModeType>... statuses)

Creates a list of the given statuses.

Type Parameters:

ModeType - type of modes being listed

Parameters:

statuses - statuses

Returns:

list

of

public static <ModeType extends Mode> @NonNull DefaultModeStatusList<ModeType> of(@NonNull Collection<ModeStatus<ModeType>> statuses)

Creates a list of the given statuses.

Type Parameters:

ModeType - type of modes being listed

Parameters:

statuses - statuses

Returns:

list

contains

public boolean contains(ModeType mode)

Description copied from interface: ModeStatusList

Gets if the given mode is present in the list.

Specified by:

contains in interface ModeStatusList<ModeType extends Mode>

Parameters:

mode - mode to check

Returns:

true if present at least once

containsMode

public boolean containsMode(char mode)

Description copied from interface: ModeStatusList

Gets if the given mode character is present in the list.

Specified by:

containsMode in interface ModeStatusList<ModeType extends Mode>

Parameters:

mode - mode to check

Returns:

true if present at least once

getByMode

public @NonNull List<ModeStatus<ModeType>> getByMode(ModeType mode)

Description copied from interface: ModeStatusList

Gets all mode statuses of a given mode.

Specified by:

getByMode in interface ModeStatusList<ModeType extends Mode>

Parameters:

mode - mode to check

Returns:

all matching modes or empty if none match

getByMode

public @NonNull List<ModeStatus<ModeType>> getByMode(char mode)

Description copied from interface: ModeStatusList

Gets all mode statuses of a given mode character.

Specified by:

getByMode in interface ModeStatusList<ModeType extends Mode>

Parameters:

mode - mode to check

Returns:

all matching modes or empty if none match

getAll

public @NonNull List<ModeStatus<ModeType>> getAll()

Description copied from interface: ModeStatusList

Gets the list of statuses.

Specified by:

getAll in interface ModeStatusList<ModeType extends Mode>

Returns:

status list

getAsString

public @NonNull String getAsString()

Description copied from interface: ModeStatusList

Gets the statuses in a convenient String format.

Specified by:

getAsString in interface ModeStatusList<ModeType extends Mode>

Returns:

string of modes

toString

public @NonNull String toString()

Overrides:

toString in class Object