org.kitteh.irc.client.library.event.user

Class UserAwayMessageEvent

java.lang.Object

org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

org.kitteh.irc.client.library.event.abstractbase.ActorEventBase<User>

org.kitteh.irc.client.library.event.user.UserAwayMessageEvent

All Implemented Interfaces:

ClientLinked, ActorEvent<User>, ClientEvent, ServerMessageEvent

public class UserAwayMessageEvent
extends ActorEventBase<User>

A User has changed away status, informed via AWAY message. Note that two events may fire in a row while the user remains away, just with a changed message.

Constructor Summary

Constructors

Constructor and Description
UserAwayMessageEvent(Client client, List<ServerMessage> originalMessages, User user, String message) Creates the event.

Method Summary

Modifier and Type	Method and Description
Optional<String>	getAwayMessage() Gets the away message.
boolean	isAway() Gets if the user is away.
protected ToStringer	toStringer() Generates a partial ToStringer for the command.

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ActorEventBase

getActor

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

getOriginalMessages

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

getClient, 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.event.helper.ServerMessageEvent

getOriginalMessages

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

getClient

Constructor Detail

UserAwayMessageEvent

public UserAwayMessageEvent(@Nonnull
                            Client client,
                            @Nonnull
                            List<ServerMessage> originalMessages,
                            @Nonnull
                            User user,
                            @Nullable
                            String message)

Creates the event.

Parameters:

client - client for which this is occurring

originalMessages - original messages

user - user

message - message the user left

Method Detail

isAway

public boolean isAway()

Gets if the user is away. If true, getAwayMessage() is not empty.

Returns:

true if away

getAwayMessage

@Nonnull
public Optional<String> getAwayMessage()

Gets the away message.

Returns:

away message or empty if no longer away

toStringer

@Nonnull
protected ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ActorEventBase<User>

Returns:

the partial toString generator