org.kitteh.irc.client.library.defaults.feature

Class DefaultCapabilityManager

java.lang.Object

org.kitteh.irc.client.library.defaults.feature.DefaultCapabilityManager

All Implemented Interfaces:

CapabilityManager, CapabilityManager.WithManagement, Resettable

public class DefaultCapabilityManager
extends Object
implements CapabilityManager.WithManagement

Default implementation of CapabilityManager.

Nested Class Summary

Nested classes/interfaces inherited from interface org.kitteh.irc.client.library.feature.CapabilityManager

CapabilityManager.Defaults, CapabilityManager.WithManagement

Constructor Summary

Constructors

Constructor and Description
DefaultCapabilityManager(Client client) Constructs the capability manager.

Method Summary

Modifier and Type	Method and Description
void	endNegotiation() Ends negotiation status, making CapabilityManager.WithManagement.isNegotiating() false.
@NonNull List<CapabilityState>	getCapabilities() Gets capabilities currently enabled.
@NonNull List<CapabilityState>	getSupportedCapabilities() Gets capabilities supported by the server.
boolean	isNegotiating() Gets if we are still in negotiation.
void	reset() Resets.
void	setCapabilities(@NonNull List<CapabilityState> capabilityStates) Wipes the previously known active capabilities, setting only those in the provided list.
void	setSupportedCapabilities(@NonNull List<CapabilityState> capabilityStates) Sets the supported capabilities as reported by the server.
@NonNull String	toString()
void	updateCapabilities(@NonNull List<CapabilityState> capabilityStates) Updates the current active capabilities, adding new and removing any labeled with CapabilityState.isDisabled().

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.feature.CapabilityManager

getCapability, getSupportedCapability

Constructor Detail

DefaultCapabilityManager

public DefaultCapabilityManager(Client client)

Constructs the capability manager.

Parameters:

client - client for which this manager will operate

Method Detail

reset

public void reset()

Description copied from interface: Resettable

Resets.

Specified by:

reset in interface Resettable

getCapabilities

public @NonNull List<CapabilityState> getCapabilities()

Description copied from interface: CapabilityManager

Gets capabilities currently enabled.

Specified by:

getCapabilities in interface CapabilityManager

Returns:

the capabilities currently enabled

See Also:

CapabilityRequestCommand

getSupportedCapabilities

public @NonNull List<CapabilityState> getSupportedCapabilities()

Description copied from interface: CapabilityManager

Gets capabilities supported by the server.

Specified by:

getSupportedCapabilities in interface CapabilityManager

Returns:

the capabilities supported

See Also:

CapabilityRequestCommand

isNegotiating

public boolean isNegotiating()

Description copied from interface: CapabilityManager.WithManagement

Gets if we are still in negotiation. True on construction and after a Resettable.reset().

Specified by:

isNegotiating in interface CapabilityManager.WithManagement

Returns:

true if still negotiating

endNegotiation

public void endNegotiation()

Description copied from interface: CapabilityManager.WithManagement

Ends negotiation status, making CapabilityManager.WithManagement.isNegotiating() false.

Specified by:

endNegotiation in interface CapabilityManager.WithManagement

updateCapabilities

public void updateCapabilities(@NonNull List<CapabilityState> capabilityStates)

Description copied from interface: CapabilityManager.WithManagement

Updates the current active capabilities, adding new and removing any labeled with CapabilityState.isDisabled().

Specified by:

updateCapabilities in interface CapabilityManager.WithManagement

Parameters:

capabilityStates - capability states

setCapabilities

public void setCapabilities(@NonNull List<CapabilityState> capabilityStates)

Description copied from interface: CapabilityManager.WithManagement

Wipes the previously known active capabilities, setting only those in the provided list.

Specified by:

setCapabilities in interface CapabilityManager.WithManagement

Parameters:

capabilityStates - fresh set of capability states

setSupportedCapabilities

public void setSupportedCapabilities(@NonNull List<CapabilityState> capabilityStates)

Description copied from interface: CapabilityManager.WithManagement

Sets the supported capabilities as reported by the server.

Specified by:

setSupportedCapabilities in interface CapabilityManager.WithManagement

Parameters:

capabilityStates - supported capabilities

toString

public @NonNull String toString()

Overrides:

toString in class Object