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

Class DefaultUser

java.lang.Object

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

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

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

All Implemented Interfaces:

Actor, ClientLinked, MessageReceiver, Snapshot, Staleable, User

public class DefaultUser
extends DefaultStaleable
implements User

Default implementation of User.

Constructor Summary

Constructors

Constructor and Description
DefaultUser(Client.WithManagement client, @NonNull String name, @Nullable String account, @Nullable String awayMessage, @NonNull String nick, @NonNull String user, @NonNull String host, boolean isAway, @Nullable String operString, @Nullable String realName, @Nullable String server, @NonNull Set<String> channels) Constructs the object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
@NonNull Optional<String>	getAccount() Gets the Services account this user is signed into.
@NonNull Optional<String>	getAwayMessage() Gets, if one is set and known, the away message for the user.
@NonNull Set<String>	getChannels() Gets the user's channels.
@NonNull String	getHost() Gets the user's host.
@NonNull String	getMessagingName() Gets the name used when sending messages.
@NonNull String	getNick() Gets the user's nick.
@NonNull 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.
@NonNull Optional<String>	getRealName() Gets the user's real name
@NonNull Optional<String>	getServer() Gets the name of the server the user is on.
@NonNull String	getUserString() Gets the user's user string.
int	hashCode()
boolean	isAway() Gets if the user is away.
@NonNull String	toString()

Methods inherited from class org.kitteh.irc.client.library.defaults.element.DefaultStaleable

isStale

Methods inherited from class org.kitteh.irc.client.library.defaults.element.DefaultActor

getClient, getCreationTime, getName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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, getName

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

getCreationTime

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

getClient

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

isStale

Constructor Detail

DefaultUser

public DefaultUser(Client.WithManagement client,
                   @NonNull String name,
                   @Nullable String account,
                   @Nullable String awayMessage,
                   @NonNull String nick,
                   @NonNull String user,
                   @NonNull String host,
                   boolean isAway,
                   @Nullable String operString,
                   @Nullable String realName,
                   @Nullable String server,
                   @NonNull Set<String> channels)

Constructs the object.

Parameters:

client - client from which this came

name - full mask name

account - account, if known

awayMessage - away message, if known

nick - nick

user - user string (ident)

host - host

isAway - true if away

operString - oper info, if known

realName - real name, if known

server - server info, if known

channels - channels they are in

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getAccount

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

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

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

public @NonNull String getHost()

Description copied from interface: User

Gets the user's host.

Specified by:

getHost in interface User

Returns:

user host

getMessagingName

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

getNick

public @NonNull String getNick()

Description copied from interface: User

Gets the user's nick.

Specified by:

getNick in interface User

Returns:

user nick

getOperatorInformation

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

getRealName

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

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

public @NonNull String getUserString()

Description copied from interface: User

Gets the user's user string.

Specified by:

getUserString in interface User

Returns:

user

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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

toString

public @NonNull String toString()

Overrides:

toString in class DefaultActor