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

Class ModeInfo.DefaultModeInfo

java.lang.Object

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

All Implemented Interfaces:

ClientLinked, ModeInfo

Enclosing interface:

ModeInfo

public static class ModeInfo.DefaultModeInfo
extends Object
implements ModeInfo

A default ModeInfo implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.kitteh.irc.client.library.element.mode.ModeInfo

ModeInfo.DefaultModeInfo

Constructor Summary

Constructors

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

Method Summary

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

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

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

@Nonnull
public Client getClient()

Description copied from interface: ClientLinked

Gets the Client to which this belongs.

Specified by:

getClient in interface ClientLinked

Returns:

the client

getMask

@Nonnull
public Mask getMask()

Description copied from interface: ModeInfo

Gets the mask.

Specified by:

getMask in interface ModeInfo

Returns:

the mask

getMode

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

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

@Nonnull
public String toString()

Overrides:

toString in class Object