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

Class AbstractAccountProtocol

java.lang.Object

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

All Implemented Interfaces:

ClientLinked, AuthProtocol, AccountName

Direct Known Subclasses:

AbstractAccountPassProtocol, AbstractSaslProtocol

public abstract class AbstractAccountProtocol
extends Object
implements AccountName

Abstract general account name protocol.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAccountProtocol(Client client, String accountName) Creates an instance.

Method Summary

Modifier and Type	Method and Description
String	getAccountName() Gets the account name.
protected abstract String	getAuthentication() Gets a String for startAuthentication().
Client	getClient() Gets the Client to which this belongs.
void	setAccountName(String accountName) Sets the account name to use.
void	startAuthentication() Starts the authentication process.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAccountProtocol

protected AbstractAccountProtocol(@Nonnull
                                  Client client,
                                  @Nonnull
                                  String accountName)

Creates an instance.

Parameters:

client - client

accountName - account name

Method Detail

getClient

@Nonnull
public Client getClient()

Description copied from interface: ClientLinked

Gets the Client to which this belongs.

Specified by:

getClient in interface ClientLinked

Returns:

the client

getAccountName

@Nonnull
public String getAccountName()

Description copied from interface: AccountName

Gets the account name.

Specified by:

getAccountName in interface AccountName

Returns:

account name

setAccountName

public void setAccountName(@Nonnull
                           String accountName)

Description copied from interface: AccountName

Sets the account name to use.

Specified by:

setAccountName in interface AccountName

Parameters:

accountName - account name

startAuthentication

public final void startAuthentication()

Description copied from interface: AuthProtocol

Starts the authentication process.

Specified by:

startAuthentication in interface AuthProtocol

getAuthentication

@Nonnull
protected abstract String getAuthentication()

Gets a String for startAuthentication().

Returns:

auth string

toString

@Nonnull
public String toString()

Overrides:

toString in class Object