org.kitteh.irc.client.library.feature

Interface ServerInfo

All Known Subinterfaces:

ServerInfo.WithManagement

All Known Implementing Classes:

DefaultServerInfo

public interface ServerInfo

Provides information about the server to which the client is connected. This information is primarily acquired via ISUPPORT.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServerInfo.WithManagement A server information provider with management features.

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.
@NonNull Optional<String>	getAddress() Gets the server-stated address of the server.
default int	getAwayReasonLengthLimit() Gets the maximum length of away reasons.
default @NonNull CaseMapping	getCaseMapping() Gets the casemapping for the server.
default int	getChannelLengthLimit() Gets the maximum length of channel names.
default @NonNull Map<Character,Integer>	getChannelLimits() Gets the channel join limits.
default @NonNull Optional<ChannelMode>	getChannelMode(char character) Gets a channel mode by specified character.
@NonNull List<ChannelMode>	getChannelModes() Gets the channel modes available.
@NonNull List<Character>	getChannelPrefixes() Gets the list of accepted channel prefixes.
default @NonNull Optional<ChannelUserMode>	getChannelUserMode(char character) Gets a channel user mode by specified character.
@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.
default <ISupport extends ISupportParameter> @NonNull Optional<ISupport>	getISupportParameter(@NonNull String name, @NonNull Class<ISupport> clazz) Gets the named ISUPPORT parameter if present and if of the specified type.
@NonNull Map<String,ISupportParameter>	getISupportParameters() Gets the ISUPPORT parameters sent to the client.
default int	getKickReasonLengthLimit() Gets the maximum length of kick reasons.
@NonNull Optional<List<String>>	getMotd() Gets the server's MOTD.
default @NonNull Optional<String>	getNetworkName() Gets the name of this network.
default int	getNickLengthLimit() Gets the maximum length of nicknames.
default int	getTopicLengthLimit() Gets the maximum length of topics.
@NonNull List<UserMode>	getUserModes() Gets the user modes available.
@NonNull Optional<String>	getVersion() Gets the version of the IRCd.
default boolean	hasWhoXSupport() Gets if the server supports WHOX.
boolean	isValidChannel(@NonNull String name) Gets if a given string is a valid channel name according to the available server information.

Method Detail

addCustomChannelMode

void addCustomChannelMode(@NonNull ChannelMode mode)

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

Parameters:

mode - custom mode to support

addCustomUserMode

void addCustomUserMode(@NonNull UserMode mode)

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

Parameters:

mode - custom mode to support

getAddress

@NonNull Optional<String> getAddress()

Gets the server-stated address of the server.

Returns:

the server's address if known

getAwayReasonLengthLimit

default int getAwayReasonLengthLimit()

Gets the maximum length of away reasons.

Returns:

away reason length limit or -1 if unknown

getCaseMapping

default @NonNull CaseMapping getCaseMapping()

Gets the casemapping for the server. By default CaseMapping.RFC1459

Returns:

the casemapping

getChannelLengthLimit

default int getChannelLengthLimit()

Gets the maximum length of channel names.

Returns:

channel length limit or -1 if unknown

getChannelLimits

default @NonNull Map<Character,Integer> getChannelLimits()

Gets the channel join limits.

Returns:

a map of channel prefixes to limits

getChannelMode

default @NonNull Optional<ChannelMode> getChannelMode(char character)

Gets a channel mode by specified character.

Parameters:

character - character to match

Returns:

the found channel mode if present

getChannelModes

@NonNull List<ChannelMode> getChannelModes()

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

Returns:

available channel modes

getChannelPrefixes

@NonNull List<Character> getChannelPrefixes()

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

Returns:

available channel prefixes

getChannelUserMode

default @NonNull Optional<ChannelUserMode> getChannelUserMode(char character)

Gets a channel user mode by specified character.

Parameters:

character - character to match

Returns:

the found channel user mode if present

getChannelUserModes

@NonNull List<ChannelUserMode> getChannelUserModes()

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.

Returns:

channel modes defining user status

getISupportParameter

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

Gets the named ISUPPORT parameter if present.

Parameters:

name - parameter name, case insensitive

Returns:

parameter if present

getISupportParameter

default <ISupport extends ISupportParameter> @NonNull Optional<ISupport> getISupportParameter(@NonNull String name,
                                                                                              @NonNull Class<ISupport> clazz)

Gets the named ISUPPORT parameter if present and if of the specified type.

Type Parameters:

ISupport - parameter type

Parameters:

name - parameter name, case insensitive

clazz - parameter type

Returns:

parameter if present

getISupportParameters

@NonNull Map<String,ISupportParameter> getISupportParameters()

Gets the ISUPPORT parameters sent to the client.

Returns:

all parameters stored

getKickReasonLengthLimit

default int getKickReasonLengthLimit()

Gets the maximum length of kick reasons.

Returns:

kick reason length limit or -1 if unknown

getMotd

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

Gets the server's MOTD.

Returns:

motd if known

getNetworkName

default @NonNull Optional<String> getNetworkName()

Gets the name of this network.

Returns:

network name if known

getNickLengthLimit

default int getNickLengthLimit()

Gets the maximum length of nicknames.

Returns:

nickname length limit or -1 if unknown

getTopicLengthLimit

default int getTopicLengthLimit()

Gets the maximum length of topics.

Returns:

topic length limit or -1 if unknown

getUserModes

@NonNull List<UserMode> getUserModes()

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

Returns:

a list of user modes

getVersion

@NonNull Optional<String> getVersion()

Gets the version of the IRCd.

Returns:

server version if known

hasWhoXSupport

default boolean hasWhoXSupport()

Gets if the server supports WHOX.

Returns:

true if WHOX is supported

isValidChannel

boolean isValidChannel(@NonNull String name)

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

Parameters:

name - potentially valid name

Returns:

true if valid according to the known info