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

Class DefaultServerInfo

java.lang.Object

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

All Implemented Interfaces:

ServerInfo, ServerInfo.WithManagement

public class DefaultServerInfo
extends Object
implements ServerInfo.WithManagement

Default implementation for tracking server information.

Nested Class Summary

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

ServerInfo.WithManagement

Constructor Summary

Constructors

Constructor and Description
DefaultServerInfo(@NonNull Client client) Constructs the server info.

Method Summary

Modifier and Type	Method and Description
void	addCustomChannelMode(@NonNull ChannelMode mode) Adds a custom channel mode, for a server that doesn't correctly list modes.
void	addCustomUserMode(@NonNull UserMode mode) Adds a custom user mode, for a server that doesn't correctly list modes.
void	addISupportParameter(@NonNull ISupportParameter parameter) Adds an ISUPPORT parameter to the list of supported parameters.
@NonNull Optional<String>	getAddress() Gets the server-stated address of the server.
@NonNull List<ChannelMode>	getChannelModes() Gets the channel modes available.
@NonNull List<Character>	getChannelPrefixes() Gets the list of accepted channel prefixes.
@NonNull List<ChannelUserMode>	getChannelUserModes() Gets the list of accepted channel user modes, such as op.
@NonNull Optional<ISupportParameter>	getISupportParameter(@NonNull String name) Gets the named ISUPPORT parameter if present.
@NonNull Map<String,ISupportParameter>	getISupportParameters() Gets the ISUPPORT parameters sent to the client.
@NonNull Optional<List<String>>	getMotd() Gets the server's MOTD.
@NonNull Optional<ChannelUserMode>	getTargetedChannelInfo(@NonNull String name) Gets the channel user mode for a targeted channel name, such as +#channel targeting voiced users.
@NonNull List<UserMode>	getUserModes() Gets the user modes available.
@NonNull Optional<String>	getVersion() Gets the version of the IRCd.
boolean	isValidChannel(@NonNull String name) Gets if a given string is a valid channel name according to the available server information.
void	setAddress(@NonNull String serverAddress) Sets the server address.
void	setMotd(@NonNull List<String> motd) Sets the MOTD.
void	setUserModes(@NonNull List<UserMode> userModes) Sets the user modes.
void	setVersion(@NonNull String version) Sets the version.
@NonNull String	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.feature.ServerInfo

getAwayReasonLengthLimit, getCaseMapping, getChannelLengthLimit, getChannelLimits, getChannelMode, getChannelUserMode, getISupportParameter, getKickReasonLengthLimit, getNetworkName, getNickLengthLimit, getTopicLengthLimit, hasWhoXSupport

Constructor Detail

DefaultServerInfo

public DefaultServerInfo(@NonNull Client client)

Constructs the server info.

Parameters:

client - client for which this manager will operate

Method Detail

addCustomChannelMode

public void addCustomChannelMode(@NonNull ChannelMode mode)

Description copied from interface: ServerInfo

Adds a custom channel mode, for a server that doesn't correctly list modes.

Specified by:

addCustomChannelMode in interface ServerInfo

Parameters:

mode - custom mode to support

addCustomUserMode

public void addCustomUserMode(@NonNull UserMode mode)

Description copied from interface: ServerInfo

Adds a custom user mode, for a server that doesn't correctly list modes.

Specified by:

addCustomUserMode in interface ServerInfo

Parameters:

mode - custom mode to support

getAddress

public @NonNull Optional<String> getAddress()

Description copied from interface: ServerInfo

Gets the server-stated address of the server.

Specified by:

getAddress in interface ServerInfo

Returns:

the server's address if known

setAddress

public void setAddress(@NonNull String serverAddress)

Description copied from interface: ServerInfo.WithManagement

Sets the server address.

Specified by:

setAddress in interface ServerInfo.WithManagement

Parameters:

serverAddress - server address

getChannelModes

public @NonNull List<ChannelMode> getChannelModes()

Description copied from interface: ServerInfo

Gets the channel modes available. If the server has not provided information on channel modes, defaults are used and returned here.

Specified by:

getChannelModes in interface ServerInfo

Returns:

available channel modes

getChannelPrefixes

public @NonNull List<Character> getChannelPrefixes()

Description copied from interface: ServerInfo

Gets the list of accepted channel prefixes. If the server has not provided this information all four listed in the IRC spec are returned (#&!+).

Specified by:

getChannelPrefixes in interface ServerInfo

Returns:

available channel prefixes

getChannelUserModes

public @NonNull List<ChannelUserMode> getChannelUserModes()

Description copied from interface: ServerInfo

Gets the list of accepted channel user modes, such as op. Modes are listed from most powerful to least powerful. If the server has not provided this information a default list of op (mode o for prefix @) and voice (mode v for prefix +) are returned.

Specified by:

getChannelUserModes in interface ServerInfo

Returns:

channel modes defining user status

getISupportParameter

public @NonNull Optional<ISupportParameter> getISupportParameter(@NonNull String name)

Description copied from interface: ServerInfo

Gets the named ISUPPORT parameter if present.

Specified by:

getISupportParameter in interface ServerInfo

Parameters:

name - parameter name, case insensitive

Returns:

parameter if present

getISupportParameters

public @NonNull Map<String,ISupportParameter> getISupportParameters()

Description copied from interface: ServerInfo

Gets the ISUPPORT parameters sent to the client.

Specified by:

getISupportParameters in interface ServerInfo

Returns:

all parameters stored

addISupportParameter

public void addISupportParameter(@NonNull ISupportParameter parameter)

Description copied from interface: ServerInfo.WithManagement

Adds an ISUPPORT parameter to the list of supported parameters.

Specified by:

addISupportParameter in interface ServerInfo.WithManagement

Parameters:

parameter - parameter to add

getMotd

public @NonNull Optional<List<String>> getMotd()

Description copied from interface: ServerInfo

Gets the server's MOTD.

Specified by:

getMotd in interface ServerInfo

Returns:

motd if known

setMotd

public void setMotd(@NonNull List<String> motd)

Description copied from interface: ServerInfo.WithManagement

Sets the MOTD.

Specified by:

setMotd in interface ServerInfo.WithManagement

Parameters:

motd - motd

getVersion

public @NonNull Optional<String> getVersion()

Description copied from interface: ServerInfo

Gets the version of the IRCd.

Specified by:

getVersion in interface ServerInfo

Returns:

server version if known

setVersion

public void setVersion(@NonNull String version)

Description copied from interface: ServerInfo.WithManagement

Sets the version.

Specified by:

setVersion in interface ServerInfo.WithManagement

Parameters:

version - version

isValidChannel

public boolean isValidChannel(@NonNull String name)

Description copied from interface: ServerInfo

Gets if a given string is a valid channel name according to the available server information.

Specified by:

isValidChannel in interface ServerInfo

Parameters:

name - potentially valid name

Returns:

true if valid according to the known info

getTargetedChannelInfo

public @NonNull Optional<ChannelUserMode> getTargetedChannelInfo(@NonNull String name)

Description copied from interface: ServerInfo.WithManagement

Gets the channel user mode for a targeted channel name, such as +#channel targeting voiced users.

Specified by:

getTargetedChannelInfo in interface ServerInfo.WithManagement

Parameters:

name - channel name with mode tag

Returns:

user mode if a match is found

getUserModes

public @NonNull List<UserMode> getUserModes()

Description copied from interface: ServerInfo

Gets the user modes available. If the server has not provided information on user modes, defaults are used and returned here.

Specified by:

getUserModes in interface ServerInfo

Returns:

a list of user modes

setUserModes

public void setUserModes(@NonNull List<UserMode> userModes)

Description copied from interface: ServerInfo.WithManagement

Sets the user modes.

Specified by:

setUserModes in interface ServerInfo.WithManagement

Parameters:

userModes - user modes

toString

public @NonNull String toString()

Overrides:

toString in class Object