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

Class AbstractAuthProtocol

java.lang.Object

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

All Implemented Interfaces:

ClientLinked, AuthProtocol

Direct Known Subclasses:

AbstractAccountPassProtocol, AbstractSaslProtocol

public abstract class AbstractAuthProtocol
extends Object
implements AuthProtocol

Abstract auth protocol.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAuthProtocol(@NonNull Client client) Creates an instance.

Method Summary

Modifier and Type	Method and Description
protected abstract @NonNull String	getAuthentication() Gets a String for startAuthentication().
@NonNull Client	getClient() Gets the Client to which this belongs.
void	startAuthentication() Starts the authentication process.
@NonNull String	toString()
protected abstract void	toString(ToStringer stringer) Adds data to toString.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAuthProtocol

protected AbstractAuthProtocol(@NonNull Client client)

Creates an instance.

Parameters:

client - client

Method Detail

getClient

public final @NonNull Client getClient()

Description copied from interface: ClientLinked

Gets the Client to which this belongs.

Specified by:

getClient in interface ClientLinked

Returns:

the client

startAuthentication

public final void startAuthentication()

Description copied from interface: AuthProtocol

Starts the authentication process.

Specified by:

startAuthentication in interface AuthProtocol

getAuthentication

protected abstract @NonNull String getAuthentication()

Gets a String for startAuthentication().

Returns:

auth string

toString

public final @NonNull String toString()

Overrides:

toString in class Object

toString

protected abstract void toString(ToStringer stringer)

Adds data to toString.

Parameters:

stringer - stringer