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

Class DefaultWhoisData

java.lang.Object

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

All Implemented Interfaces:

Actor, ClientLinked, MessageReceiver, Snapshot, Staleable, User, WhoisData

public class DefaultWhoisData
extends Object
implements WhoisData

Default implementation of WhoisData.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultWhoisData.Builder A builder to assist in building DefaultWhoisData.

Constructor Summary

Constructors

Constructor and Description
DefaultWhoisData(Client client, String account, Set<String> channels, String nick, String userString, String host, String realName, String server, String serverDescription, boolean secureConnection, String operatorInformation, Long idleTime, Long signOnTime, String awayMessage) Creates the default WHOIS data object.

Method Summary

Modifier and Type	Method and Description
Optional<String>	getAccount() Gets the Services account this user is signed into.
Optional<String>	getAwayMessage() Gets, if one is set and known, the away message for the user.
Set<String>	getChannels() Gets the user's channels.
Client	getClient() Gets the Client to which this belongs.
long	getCreationTime() Gets the time this snapshot was created.
String	getHost() Gets the user's host.
Optional<Long>	getIdleTime() Gets how long the user has been idle.
String	getMessagingName() Gets the name used when sending messages.
String	getName() Gets the Actor's name.
String	getNick() Gets the user's nick.
Optional<String>	getOperatorInformation() Gets a user's operator information, if they have any privileges, noting that this information may not imply actual IRC Operator status but some other IRC network status as well.
Optional<String>	getRealName() Gets the user's real name
Optional<String>	getServer() Gets the name of the server the user is on.
Optional<String>	getServerDescription() Gets the description of the server the user is on.
Optional<Long>	getSignOnTime() Gets the time at which this user signed on to the server.
String	getUserString() Gets the user's user string.
boolean	isAway() Gets if the user is away.
boolean	isSecureConnection() Gets if the user is connected securely.
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.WhoisData

isStale

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

getLowerCaseMessagingName, sendCtcpMessage, sendMessage, sendMultiLineMessage, sendMultiLineMessage, sendMultiLineNotice, sendMultiLineNotice, sendNotice

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

getLowerCaseName

Constructor Detail

DefaultWhoisData

public DefaultWhoisData(@Nonnull
                        Client client,
                        @Nullable
                        String account,
                        @Nonnull
                        Set<String> channels,
                        @Nonnull
                        String nick,
                        @Nonnull
                        String userString,
                        @Nonnull
                        String host,
                        @Nullable
                        String realName,
                        @Nullable
                        String server,
                        @Nullable
                        String serverDescription,
                        boolean secureConnection,
                        @Nullable
                        String operatorInformation,
                        @Nullable
                        Long idleTime,
                        @Nullable
                        Long signOnTime,
                        @Nullable
                        String awayMessage)

Creates the default WHOIS data object.

Parameters:

client - client

account - account, if known

channels - channels the user known to be in

nick - nickname

userString - user string

host - host

realName - real name, if known

server - server, if known

serverDescription - server description, if known

secureConnection - if the connection is known to be secure

operatorInformation - any operator information, if known

idleTime - how long the user has been idle, if known

signOnTime - when the user signed on, if known

awayMessage - user away message, if known

Method Detail

getAccount

@Nonnull
public Optional<String> getAccount()

Description copied from interface: User

Gets the Services account this user is signed into. Only fully functional if the server supports the capabilities account-notify, extended-join, and WHOX and the user and client share a channel.

Specified by:

getAccount in interface User

Returns:

the account name if known

See Also:

CapabilityManager.getCapabilities(), ServerInfo.hasWhoXSupport()

getAwayMessage

@Nonnull
public Optional<String> getAwayMessage()

Description copied from interface: User

Gets, if one is set and known, the away message for the user.

Specified by:

getAwayMessage in interface User

Returns:

away message if known

getChannels

@Nonnull
public Set<String> getChannels()

Description copied from interface: User

Gets the user's channels.

Specified by:

getChannels in interface User

Returns:

channel names the user is in

getHost

@Nonnull
public String getHost()

Description copied from interface: User

Gets the user's host.

Specified by:

getHost in interface User

Returns:

user host

getNick

@Nonnull
public String getNick()

Description copied from interface: User

Gets the user's nick.

Specified by:

getNick in interface User

Returns:

user nick

getRealName

@Nonnull
public Optional<String> getRealName()

Description copied from interface: User

Gets the user's real name

Specified by:

getRealName in interface User

Returns:

real name if known

getServer

@Nonnull
public Optional<String> getServer()

Description copied from interface: User

Gets the name of the server the user is on.

Specified by:

getServer in interface User

Returns:

user's server if known

getUserString

@Nonnull
public String getUserString()

Description copied from interface: User

Gets the user's user string.

Specified by:

getUserString in interface User

Returns:

user

isAway

public boolean isAway()

Description copied from interface: User

Gets if the user is away.

Specified by:

isAway in interface User

Returns:

true if away

getMessagingName

@Nonnull
public String getMessagingName()

Description copied from interface: MessageReceiver

Gets the name used when sending messages.

Specified by:

getMessagingName in interface MessageReceiver

Returns:

the name by which you can message this receiver

getName

@Nonnull
public String getName()

Description copied from interface: Actor

Gets the Actor's name.

Specified by:

getName in interface Actor

Returns:

the Actor's name

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

getCreationTime

public long getCreationTime()

Description copied from interface: Snapshot

Gets the time this snapshot was created.

Specified by:

getCreationTime in interface Snapshot

Returns:

creation time via System.currentTimeMillis()

getIdleTime

@Nonnull
public Optional<Long> getIdleTime()

Description copied from interface: WhoisData

Gets how long the user has been idle.

Specified by:

getIdleTime in interface WhoisData

Returns:

idle time, in seconds

getOperatorInformation

@Nonnull
public Optional<String> getOperatorInformation()

Description copied from interface: User

Gets a user's operator information, if they have any privileges, noting that this information may not imply actual IRC Operator status but some other IRC network status as well.

Example: "is an Operator".

Specified by:

getOperatorInformation in interface User

Returns:

operator info, or empty if none known

getServerDescription

@Nonnull
public Optional<String> getServerDescription()

Description copied from interface: WhoisData

Gets the description of the server the user is on.

Specified by:

getServerDescription in interface WhoisData

Returns:

description or empty if none present

getSignOnTime

@Nonnull
public Optional<Long> getSignOnTime()

Description copied from interface: WhoisData

Gets the time at which this user signed on to the server.

Specified by:

getSignOnTime in interface WhoisData

Returns:

time of arrival

isSecureConnection

public boolean isSecureConnection()

Description copied from interface: WhoisData

Gets if the user is connected securely.

Specified by:

isSecureConnection in interface WhoisData

Returns:

true if secure connection

toString

@Nonnull
public String toString()

Overrides:

toString in class Object