org.kitteh.irc.client.library.feature.auth

Class NickServ

java.lang.Object

org.kitteh.irc.client.library.feature.auth.AbstractAuthProtocol

org.kitteh.irc.client.library.feature.auth.AbstractAccountPassProtocol

org.kitteh.irc.client.library.feature.auth.NickServ

All Implemented Interfaces:

ClientLinked, AuthProtocol, EventListening

public class NickServ
extends AbstractAccountPassProtocol
implements EventListening

NickServ protocol. Automatically attempts to identify upon connection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NickServ.Builder NickServ builder.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NickServ(@NonNull Client client, @NonNull String serviceName, @Nullable String accountName, @NonNull String password) Creates a NickServ authentication protocol instance.

Method Summary

Modifier and Type	Method and Description
static @NonNull NickServ.Builder	builder(@NonNull Client client) Creates a new NickServ builder.
protected @NonNull String	getAuthentication() Gets a String for AbstractAuthProtocol.startAuthentication().
@NonNull Object	getEventListener() Gets the object for listening.
void	listenSuccess(PrivateNoticeEvent event)
void	listenVersion(ClientReceiveNumericEvent event)

Methods inherited from class org.kitteh.irc.client.library.feature.auth.AbstractAccountPassProtocol

getAccountName, getPassword, toString

Methods inherited from class org.kitteh.irc.client.library.feature.auth.AbstractAuthProtocol

getClient, startAuthentication, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NickServ

protected NickServ(@NonNull Client client,
                   @NonNull String serviceName,
                   @Nullable String accountName,
                   @NonNull String password)

Creates a NickServ authentication protocol instance.

Parameters:

client - client for which this will be used

serviceName - service name

accountName - account name

password - password

Method Detail

builder

public static @NonNull NickServ.Builder builder(@NonNull Client client)

Creates a new NickServ builder.

Parameters:

client - client for whom this is to be built

Returns:

new builder

getAuthentication

protected @NonNull String getAuthentication()

Description copied from class: AbstractAuthProtocol

Gets a String for AbstractAuthProtocol.startAuthentication().

Specified by:

getAuthentication in class AbstractAuthProtocol

Returns:

auth string

getEventListener

public @NonNull Object getEventListener()

Description copied from interface: EventListening

Gets the object for listening.

Specified by:

getEventListener in interface EventListening

Returns:

listener

listenVersion

public void listenVersion(ClientReceiveNumericEvent event)

listenSuccess

public void listenSuccess(PrivateNoticeEvent event)