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

Interface ModeInfo

All Superinterfaces:

ClientLinked

All Known Implementing Classes:

ModeInfo.DefaultModeInfo

public interface ModeInfo
extends ClientLinked

Represents a type A mode information entry.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ModeInfo.DefaultModeInfo A default ModeInfo implementation.

Method Summary

Modifier and Type	Method and Description
Channel	getChannel() Gets the channel for which this entry exists.
Optional<Instant>	getCreationTime() Gets the time at which this entry was created.
Optional<String>	getCreator() Gets the name of the party listed as creating the entry.
Mask	getMask() Gets the mask.
ChannelMode	getMode() Gets the mode for which this info exists.
default void	remove() Attempts to remove this item from the channel.

Methods inherited from interface org.kitteh.irc.client.library.element.ClientLinked

getClient

Method Detail

getCreator

@Nonnull
Optional<String> getCreator()

Gets the name of the party listed as creating the entry. This may be a nickname, a service name, a server name, etc.

Returns:

name, if known, of who created this entry

getChannel

@Nonnull
Channel getChannel()

Gets the channel for which this entry exists.

Returns:

the channel

getMask

@Nonnull
Mask getMask()

Gets the mask.

Returns:

the mask

getMode

@Nonnull
ChannelMode getMode()

Gets the mode for which this info exists.

Returns:

the mode

getCreationTime

@Nonnull
Optional<Instant> getCreationTime()

Gets the time at which this entry was created.

Returns:

creation time, if known

remove

default void remove()

Attempts to remove this item from the channel.