org.kitteh.irc.client.library

Interface Client.Builder

All Known Implementing Classes:

DefaultBuilder

Enclosing interface:

Client

public static interface Client.Builder

Builds Clients. Create a builder with Client.builder().

The default built client connects securely via port 6697. See Client.Builder.Server.secure(boolean) to disable, or the other secure-prefixed methods in this builder to fully utilize the feature. Note that the default TrustManagerFactory relies on your local trust store. The default Oracle trust store does not accept self-signed certificates.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Client.Builder.Bind Bind builder methods.
static interface	Client.Builder.Listeners Listener builder methods.
static interface	Client.Builder.Management Management-related builder methods.
static interface	Client.Builder.Proxy Information about a proxy host for the connection.
static interface	Client.Builder.Server Server builder methods.
static interface	Client.Builder.WebIrc WebIRC builder.

Method Summary

Modifier and Type	Method and Description
@NonNull Client.Builder.Bind	bind() Returns bind builder methods.
@NonNull Client	build() Clientmaker, clientmaker, make me a client!
@NonNull Client	buildAndConnect() Clientmaker, clientmaker, make me a client, build me the client, begin connection!
@NonNull Client.Builder.Listeners	listeners() Returns listener builder methods.
@NonNull Client.Builder.Management	management() Returns the management-related builder methods.
@NonNull Client.Builder	name(@NonNull String name) Names the client, for internal labeling.
@NonNull Client.Builder	nick(@NonNull String nick) Sets the client's nick.
@NonNull Client.Builder.Proxy	proxy() Returns proxy builder methods.
@NonNull Client.Builder	realName(@NonNull String name) Sets the realname the client uses.
@NonNull Client.Builder.Server	server() Returns server builder methods.
@NonNull Client.Builder	user(@NonNull String user) Sets the user the client connects as.
Client.Builder.WebIrc.Password	webIrc() Returns webirc builder methods.

Method Detail

name

@NonNull Client.Builder name(@NonNull String name)

Names the client, for internal labeling.

Parameters:

name - a name to label the client internally

Returns:

this builder

Throws:

IllegalArgumentException - if name is null

nick

@NonNull Client.Builder nick(@NonNull String nick)

Sets the client's nick.

By default, the nick is Kitteh.

Parameters:

nick - nick for the client to use

Returns:

this builder

Throws:

IllegalArgumentException - if nick is null

user

@NonNull Client.Builder user(@NonNull String user)

Sets the user the client connects as.

By default, the user is Kitteh.

Parameters:

user - user to connect as

Returns:

this builder

Throws:

IllegalArgumentException - for null user

realName

@NonNull Client.Builder realName(@NonNull String name)

Sets the realname the client uses.

By default, the realname is Kitteh.

Parameters:

name - realname to use

Returns:

this builder

Throws:

IllegalArgumentException - for null realname

bind

@NonNull Client.Builder.Bind bind()

Returns bind builder methods.

Returns:

bind builder

server

@NonNull Client.Builder.Server server()

Returns server builder methods.

Returns:

server builder

listeners

@NonNull Client.Builder.Listeners listeners()

Returns listener builder methods.

Returns:

listener builder

proxy

@NonNull Client.Builder.Proxy proxy()

Returns proxy builder methods.

Returns:

proxy builder

webIrc

Client.Builder.WebIrc.Password webIrc()

Returns webirc builder methods.

Returns:

webirc builder

management

@NonNull Client.Builder.Management management()

Returns the management-related builder methods.

Returns:

management builder

build

@NonNull Client build()

Clientmaker, clientmaker, make me a client!

Returns:

a client designed to your liking

buildAndConnect

@NonNull Client buildAndConnect()

Clientmaker, clientmaker, make me a client, build me the client, begin connection!

Returns:

a client designed to your liking