org.apache.sshd.common.util

Class EventListenerUtils

java.lang.Object

org.apache.sshd.common.util.EventListenerUtils

public final class EventListenerUtils
extends Object

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
static <T extends EventListener> T	proxyWrapper(Class<T> listenerType, ClassLoader loader, Iterable<? extends T> listeners) Provides proxy wrapper around an Iterable container of listener interface implementation.
static <T extends EventListener> T	proxyWrapper(Class<T> listenerType, Iterable<? extends T> listeners) Provides proxy wrapper around an Iterable container of listener interface implementation.

Methods inherited from class java.lang.Object

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

Method Detail

proxyWrapper

public static <T extends EventListener> T proxyWrapper(Class<T> listenerType,
                                                       Iterable<? extends T> listeners)

Provides proxy wrapper around an Iterable container of listener interface implementation. Note: a listener interface is one whose invoked methods return only void.

Type Parameters:

T - Generic listener type

Parameters:

listenerType - The expected listener interface

listeners - An Iterable container of listeners to be invoked.

Note(s):

• The invocation order is same as the Iterable container

• If any of the invoked listener methods throws an exception, the rest of the listener are not invoked and the exception is propagated to the caller

• It is up to the caller to ensure that the container does not change while the proxy is invoked

Returns:

A proxy wrapper implementing the same interface, but delegating the calls to the container

See Also:

proxyWrapper(Class, ClassLoader, Iterable)

proxyWrapper

public static <T extends EventListener> T proxyWrapper(Class<T> listenerType,
                                                       ClassLoader loader,
                                                       Iterable<? extends T> listeners)

Provides proxy wrapper around an Iterable container of listener interface implementation. Note: a listener interface is one whose invoked methods return only void.

Type Parameters:

T - Generic listener type

Parameters:

listenerType - The expected listener interface

loader - The ClassLoader to use for the proxy

listeners - An Iterable container of listeners to be invoked.

Note(s):

• The invocation order is same as the Iterable container

• If any of the invoked listener methods throws an exception, the rest of the listener are not invoked and the exception is propagated to the caller

• It is up to the caller to ensure that the container does not change while the proxy is invoked

Returns:

A proxy wrapper implementing the same interface, but delegating the calls to the container

Throws:

IllegalArgumentException - if listenerType is not an interface or a null container has been provided

See Also:

proxyWrapper(Class, ClassLoader, Iterable)