Apache Mina SSHD 2.15.0 · org.apache.sshd.common.util.closeable.AutoCloseableDelegateInvocationHandler

Modifier and Type	Field and Description
private final Object[]	closers
private final AutoCloseable	delegate
private final Object	proxyTarget

Access	Constructor and Description
public	AutoCloseableDelegateInvocationHandler(Object proxyTarget, AutoCloseable delegate)

Method Summary

Modifier and Type	Method and Description
public AutoCloseable	getAutoCloseableDelegate()
public Object	getProxyTarget()
public Object	invoke(Object the proxy instance that the method was invoked on proxy, Method the `Method` instance corresponding to the interface method invoked on the proxy instance. The declaring class of the `Method` object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through. method, Object[] an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or `null` if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as `java.lang.Integer` or `java.lang.Boolean`. args) Implements java.lang.reflect.InvocationHandler.invoke. Processes a method invocation on a proxy instance and returns the result.
public static boolean	isCloseMethod(Method m)
public static boolean	isCloseMethodInvocation(Method m, Object[] args)
public static < The generic `AutoCloseable` wrapping interface T extends AutoCloseable> T	Returns: The wrapping proxy wrapDelegateCloseable(Object The (never `null`) target instance - if not `AutoCloseable` then it's `close()` method will not be invoked (i.e., only the delegate) proxyTarget, Class<T> The target wrapping interface type, AutoCloseable The (never `null`) delegate to close Note the delegate is closed after the target instance. delegate) Wraps a target instance and an `AutoCloseable` delegate into a proxy instance that closes both when wrapper `close` method called.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

closers	back to summary
private final Object[] closers

delegate	back to summary
private final AutoCloseable delegate

proxyTarget	back to summary
private final Object proxyTarget

AutoCloseableDelegateInvocationHandler	back to summary
public AutoCloseableDelegateInvocationHandler(Object proxyTarget, AutoCloseable delegate)

Method Detail

getAutoCloseableDelegate	back to summary
public AutoCloseable getAutoCloseableDelegate()

getProxyTarget	back to summary
public Object getProxyTarget()

invoke back to summary

invoke	back to summary
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable Implements java.lang.reflect.InvocationHandler.invoke. Doc from java.lang.reflect.InvocationHandler.invoke. Processes a method invocation on a proxy instance and returns the result. This method will be invoked on an invocation handler when a method is invoked on a proxy instance that it is associated with. Parameters proxy:Object the proxy instance that the method was invoked on method:Method the `Method` instance corresponding to the interface method invoked on the proxy instance. The declaring class of the `Method` object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through. args:Object[] an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or `null` if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as `java.lang.Integer` or `java.lang.Boolean`. Returns:Object the value to return from the method invocation on the proxy instance. If the declared return type of the interface method is a primitive type, then the value returned by this method must be an instance of the corresponding primitive wrapper class; otherwise, it must be a type assignable to the declared return type. If the value returned by this method is `null` and the interface method's return type is primitive, then a `NullPointerException` will be thrown by the method invocation on the proxy instance. If the value returned by this method is otherwise not compatible with the interface method's declared return type as described above, a `ClassCastException` will be thrown by the method invocation on the proxy instance. Annotations @Override Exceptions Throwable: the exception to throw from the method invocation on the proxy instance. The exception's type must be assignable either to any of the exception types declared in the `throws` clause of the interface method or to the unchecked exception types `java.lang.RuntimeException` or `java.lang.Error`. If a checked exception is thrown by this method that is not assignable to any of the exception types declared in the `throws` clause of the interface method, then an `UndeclaredThrowableException` containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable

Implements java.lang.reflect.InvocationHandler.invoke.

Doc from java.lang.reflect.InvocationHandler.invoke.

Processes a method invocation on a proxy instance and returns the result. This method will be invoked on an invocation handler when a method is invoked on a proxy instance that it is associated with.

Parameters

proxy:Object: the proxy instance that the method was invoked on
method:Method: the Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.
args:Object[]: an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.

Returns:Object

the value to return from the method invocation on the proxy instance. If the declared return type of the interface method is a primitive type, then the value returned by this method must be an instance of the corresponding primitive wrapper class; otherwise, it must be a type assignable to the declared return type. If the value returned by this method is null and the interface method's return type is primitive, then a NullPointerException will be thrown by the method invocation on the proxy instance. If the value returned by this method is otherwise not compatible with the interface method's declared return type as described above, a ClassCastException will be thrown by the method invocation on the proxy instance.

Annotations

@Override

Exceptions

Throwable:: the exception to throw from the method invocation on the proxy instance. The exception's type must be assignable either to any of the exception types declared in the throws clause of the interface method or to the unchecked exception types java.lang.RuntimeException or java.lang.Error. If a checked exception is thrown by this method that is not assignable to any of the exception types declared in the throws clause of the interface method, then an UndeclaredThrowableException containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.

isCloseMethod	back to summary
public static boolean isCloseMethod(Method m)

isCloseMethodInvocation	back to summary
public static boolean isCloseMethodInvocation(Method m, Object[] args)

wrapDelegateCloseable back to summary

wrapDelegateCloseable	back to summary
public static <T extends AutoCloseable> T wrapDelegateCloseable(Object proxyTarget, Class<T> type, AutoCloseable delegate) Wraps a target instance and an `AutoCloseable` delegate into a proxy instance that closes both when wrapper `close` method called. Parameters <T> The generic `AutoCloseable` wrapping interface proxyTarget:Object The (never `null`) target instance - if not `AutoCloseable` then it's `close()` method will not be invoked (i.e., only the delegate) type:Class<T> The target wrapping interface delegate:AutoCloseable The (never `null`) delegate to close Note the delegate is closed after the target instance. Returns:T The wrapping proxy

public static <T extends AutoCloseable> T wrapDelegateCloseable(Object proxyTarget, Class<T> type, AutoCloseable delegate)

Wraps a target instance and an AutoCloseable delegate into a proxy instance that closes both when wrapper close method called.

Parameters

<T>: The generic AutoCloseable wrapping interface
proxyTarget:Object: The (never null) target instance - if not AutoCloseable then it's close() method will not be invoked (i.e., only the delegate)
type:Class<T>: The target wrapping interface
delegate:AutoCloseable: The (never null) delegate to close
Note
the delegate is closed after the target instance.

Returns:T

The wrapping proxy

public Class AutoCloseableDelegateInvocationHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail