org.kitteh.irc.client.library.event.capabilities

Class CapabilitiesSupportedListEvent

java.lang.Object

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

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

org.kitteh.irc.client.library.event.capabilities.CapabilitiesSupportedListEvent

All Implemented Interfaces:

ClientLinked, CapabilityNegotiationRequestEvent, CapabilityNegotiationResponseEvent, ClientEvent, ServerMultipleMessageEvent

public class CapabilitiesSupportedListEvent
extends ServerMultipleMessageEventBase
implements CapabilityNegotiationRequestEvent

Fired when a CAP LS is received.

See Also:

CapabilityManager, CapabilityRequestCommand

Constructor Summary

Constructors

Constructor and Description
CapabilitiesSupportedListEvent(@NonNull Client client, @NonNull List<ServerMessage> sourceMessages, boolean negotiating, @NonNull List<CapabilityState> supportedCapabilities) Constructs the event.

Method Summary

Modifier and Type	Method and Description
void	addRequest(@NonNull String capability) Add a capability to be requested following this event.
@NonNull List<String>	getRequests() Gets the capabilities to be requested.
@NonNull List<CapabilityState>	getSupportedCapabilities() Gets a list of capabilities the server supports.
boolean	isEndingNegotiation() Gets if negotiation should end after this event fires, which can be changed via this event.
boolean	isNegotiating() Gets if this event is fired during capability negotiation.
void	setEndingNegotiation(boolean endNegotiation) Sets if negotiation should end after this event fires.
protected @NonNull ToStringer	toStringer() Generates a partial ToStringer for the command.

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

getSource

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.element.ClientLinked

getClient

Constructor Detail

CapabilitiesSupportedListEvent

public CapabilitiesSupportedListEvent(@NonNull Client client,
                                      @NonNull List<ServerMessage> sourceMessages,
                                      boolean negotiating,
                                      @NonNull List<CapabilityState> supportedCapabilities)

Constructs the event.

Parameters:

client - the client

sourceMessages - source messages

negotiating - if we are negotiating right now

supportedCapabilities - supported capabilities

Method Detail

addRequest

public void addRequest(@NonNull String capability)

Description copied from interface: CapabilityNegotiationRequestEvent

Add a capability to be requested following this event.

Specified by:

addRequest in interface CapabilityNegotiationRequestEvent

Parameters:

capability - capability to be requested

getRequests

public @NonNull List<String> getRequests()

Description copied from interface: CapabilityNegotiationRequestEvent

Gets the capabilities to be requested.

Specified by:

getRequests in interface CapabilityNegotiationRequestEvent

Returns:

capabilities

getSupportedCapabilities

public @NonNull List<CapabilityState> getSupportedCapabilities()

Gets a list of capabilities the server supports.

Returns:

supported capabilities

isEndingNegotiation

public final boolean isEndingNegotiation()

Description copied from interface: CapabilityNegotiationResponseEvent

Gets if negotiation should end after this event fires, which can be changed via this event.

Specified by:

isEndingNegotiation in interface CapabilityNegotiationResponseEvent

Returns:

true if negotiation will end after this event

See Also:

CapabilityNegotiationResponseEvent.setEndingNegotiation(boolean)

isNegotiating

public final boolean isNegotiating()

Description copied from interface: CapabilityNegotiationResponseEvent

Gets if this event is fired during capability negotiation.

Specified by:

isNegotiating in interface CapabilityNegotiationResponseEvent

Returns:

true if negotiating capabilities

setEndingNegotiation

public final void setEndingNegotiation(boolean endNegotiation)

Description copied from interface: CapabilityNegotiationResponseEvent

Sets if negotiation should end after this event fires. Note that if negotiation is not set to end, and CapabilityNegotiationResponseEvent.isNegotiating() is true, the connection will not complete.

Specified by:

setEndingNegotiation in interface CapabilityNegotiationResponseEvent

Parameters:

endNegotiation - true if negotiation should end, false if not

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ServerMultipleMessageEventBase

Returns:

the partial toString generator