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

Class DefaultModeInfo

java.lang.Object

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

All Implemented Interfaces:

ClientLinked, ModeInfo

public class DefaultModeInfo
extends Object
implements ModeInfo

A default ModeInfo implementation.

Constructor Summary

Constructors

Constructor and Description
DefaultModeInfo(@NonNull Client client, @NonNull Channel channel, @NonNull ChannelMode mode, @NonNull String mask, @Nullable String creator, @Nullable Instant creationTime) Constructs the mode info.

Method Summary

Modifier and Type	Method and Description
@NonNull Channel	getChannel() Gets the channel for which this entry exists.
@NonNull Client	getClient() Gets the Client to which this belongs.
@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.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kitteh.irc.client.library.element.mode.ModeInfo

remove

Constructor Detail

DefaultModeInfo

public DefaultModeInfo(@NonNull Client client,
                       @NonNull Channel channel,
                       @NonNull ChannelMode mode,
                       @NonNull String mask,
                       @Nullable String creator,
                       @Nullable Instant creationTime)

Constructs the mode info.

Parameters:

client - the client

channel - channel

mode - mode

mask - mask

creator - creator, if known

creationTime - creation time, if known

Method Detail

getCreator

public @NonNull Optional<String> getCreator()

Description copied from interface: ModeInfo

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

Specified by:

getCreator in interface ModeInfo

Returns:

name, if known, of who created this entry

getChannel

public @NonNull Channel getChannel()

Description copied from interface: ModeInfo

Gets the channel for which this entry exists.

Specified by:

getChannel in interface ModeInfo

Returns:

the channel

getClient

public @NonNull Client getClient()

Description copied from interface: ClientLinked

Gets the Client to which this belongs.

Specified by:

getClient in interface ClientLinked

Returns:

the client

getMask

public @NonNull Mask getMask()

Description copied from interface: ModeInfo

Gets the mask.

Specified by:

getMask in interface ModeInfo

Returns:

the mask

getMode

public @NonNull ChannelMode getMode()

Description copied from interface: ModeInfo

Gets the mode for which this info exists.

Specified by:

getMode in interface ModeInfo

Returns:

the mode

getCreationTime

public @NonNull Optional<Instant> getCreationTime()

Description copied from interface: ModeInfo

Gets the time at which this entry was created.

Specified by:

getCreationTime in interface ModeInfo

Returns:

creation time, if known

toString

public @NonNull String toString()

Overrides:

toString in class Object