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

Method Detail

getAddress

@Nonnull
Optional<String> getAddress()

Gets the server-stated address of the server.

Returns:

the server's address if known

getCaseMapping

@Nonnull
default 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

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

Gets the channel join limits.

Returns:

a map of channel prefixes to limits

getChannelMode

@Nonnull
default 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

@Nonnull
default 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

@Nonnull
default <ISupport extends ISupportParameter> 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

getMotd

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

Gets the server's MOTD.

Returns:

motd if known

getNetworkName

@Nonnull
default 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

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