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

Class ModeStatusList<ModeType extends Mode>

java.lang.Object

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

Type Parameters:

ModeType - type of modes being listed

public class ModeStatusList<ModeType extends Mode>
extends Object

A list of mode statuses.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

fromChannel

@Nonnull
public static ModeStatusList<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

@Nonnull
public static ModeStatusList<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

@Nonnull
public static <ModeType extends Mode> ModeStatusList<ModeType> of(@Nonnull
                                                                            ModeStatus<ModeType>... statuses)

Creates a list of the given statuses.

Type Parameters:

ModeType - type of modes being listed

Parameters:

statuses - statuses

Returns:

list

of

@Nonnull
public static <ModeType extends Mode> ModeStatusList<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

containsMode

public boolean containsMode(@Nonnull
                            ModeType mode)

Gets if the given mode is present in the list.

Parameters:

mode - mode to check

Returns:

true if present at least once

getStatusByMode

@Nonnull
public List<ModeStatus<ModeType>> getStatusByMode(@Nonnull
                                                            ModeType mode)

Gets all mode statuses of a given mode.

Parameters:

mode - mode to check

Returns:

all matching modes or empty if none match

getStatuses

@Nonnull
public List<ModeStatus<ModeType>> getStatuses()

Gets the list of statuses.

Returns:

status list

getStatusString

@Nonnull
public String getStatusString()

Gets the statuses in a convenient String format.

Returns:

string of modes

toString

@Nonnull
public String toString()

Overrides:

toString in class Object