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

Class CapabilityNegotiationResponseEventBase

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.CapabilityNegotiationResponseEventBase

All Implemented Interfaces:

ClientLinked, CapabilityNegotiationResponseEvent, ClientEvent, ServerMessageEvent

Direct Known Subclasses:

CapabilitiesAcknowledgedEvent, CapabilitiesDeletedSupportedEvent, CapabilitiesRejectedEvent, CapabilityNegotiationResponseEventWithRequestBase

public abstract class CapabilityNegotiationResponseEventBase
extends ServerMessageEventBase
implements CapabilityNegotiationResponseEvent

Abstract base class for events involving capability negotiation (CAP) that can have a response.

See Also:

CapabilityNegotiationResponseEvent, CapabilitiesListEvent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CapabilityNegotiationResponseEventBase(@NonNull Client client, @NonNull ServerMessage sourceMessage, boolean negotiating) Constructs the event.

Method Summary

Modifier and Type	Method and Description
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.ServerMessageEventBase

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

Methods inherited from interface org.kitteh.irc.client.library.event.helper.ServerMessageEvent

getTag, getTag, getTags

Constructor Detail

CapabilityNegotiationResponseEventBase

protected CapabilityNegotiationResponseEventBase(@NonNull Client client,
                                                 @NonNull ServerMessage sourceMessage,
                                                 boolean negotiating)

Constructs the event.

Parameters:

client - the client

sourceMessage - source message

negotiating - if we are negotiating right now

Method Detail

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 ServerMessageEventBase

Returns:

the partial toString generator