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

Interface ModeStatusList<ModeType extends Mode>

Type Parameters:

ModeType - type of modes being listed

All Known Implementing Classes:

DefaultModeStatusList

public interface ModeStatusList<ModeType extends Mode>

A 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.
@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.

Method Detail

contains

boolean contains(ModeType mode)

Gets if the given mode is present in the list.

Parameters:

mode - mode to check

Returns:

true if present at least once

containsMode

boolean containsMode(char mode)

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

Parameters:

mode - mode to check

Returns:

true if present at least once

getByMode

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

Gets all mode statuses of a given mode.

Parameters:

mode - mode to check

Returns:

all matching modes or empty if none match

getByMode

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

Gets all mode statuses of a given mode character.

Parameters:

mode - mode to check

Returns:

all matching modes or empty if none match

getAll

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

Gets the list of statuses.

Returns:

status list

getAsString

@NonNull String getAsString()

Gets the statuses in a convenient String format.

Returns:

string of modes