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

Interface ModeInfo

All Superinterfaces:

ClientLinked

All Known Implementing Classes:

DefaultModeInfo

public interface ModeInfo
extends ClientLinked

Represents a type A mode information entry.

Method Summary

Modifier and Type	Method and Description
@NonNull Channel	getChannel() Gets the channel for which this entry exists.
@NonNull Optional<Instant>	getCreationTime() Gets the time at which this entry was created.
@NonNull Optional<String>	getCreator() Gets the name of the party listed as creating the entry.
@NonNull Mask	getMask() Gets the mask.
@NonNull 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.