org.kitteh.irc.client.library.util

Class Listener<Type>

java.lang.Object

org.kitteh.irc.client.library.util.Listener<Type>

Type Parameters:

Type - type of object listened to

public class Listener<Type>
extends Object

A listener is a receiver of items that, if given a consumer, operates a queue processing thread to send items to that consumer. Items are only queued if a consumer is present.

Constructor Summary

Constructors

Constructor and Description
Listener(@NonNull Client client, @Nullable Consumer<Type> consumer)

Method Summary

Modifier and Type	Method and Description
void	queue(Type item) Queues an item.
void	removeConsumer() Removes the consumer from the listener.
void	setConsumer(@NonNull Consumer<Type> consumer) Sets the consumer for the listener, starting a queue processing thread if none existed.
void	shutdown() Shuts down the listener.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Listener

public Listener(@NonNull Client client,
                @Nullable Consumer<Type> consumer)

Parameters:

client - the client

consumer - consumer or null for no consumer

Method Detail

queue

public void queue(Type item)

Queues an item.

Parameters:

item - item to queue

removeConsumer

public void removeConsumer()

Removes the consumer from the listener.

setConsumer

public void setConsumer(@NonNull Consumer<Type> consumer)

Sets the consumer for the listener, starting a queue processing thread if none existed.

Parameters:

consumer - new consumer

shutdown

public void shutdown()

Shuts down the listener. The listener cannot be brought back from this state, and this method should typically only be called by the Client during shutdown.

toString

public @NonNull String toString()

Overrides:

toString in class Object