matlabcontrol

Interface MatlabProxyFactory.Request

Enclosing class:

MatlabProxyFactory

public static interface MatlabProxyFactory.Request

A request for a proxy. Because requests have no timeout, a Request has no concept of failure.

Implementations of this class are unconditionally thread-safe.

WARNING: This interface is not intended to be implemented by users of matlabcontrol. Methods may be added to this interface, and these additions will not be considered breaking binary compatibility.

Since:

4.0.0

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Attempts to cancel the request.
MatlabProxy.Identifier	getProxyIdentifer() The identifier of the proxy associated with this request.
boolean	isCancelled() If the request has been successfully cancelled.
boolean	isCompleted() Returns true if the proxy has been created.

Method Detail

getProxyIdentifer

MatlabProxy.Identifier getProxyIdentifer()

The identifier of the proxy associated with this request. If the proxy is created, then its identifier accessible via MatlabProxy.getIdentifier() will return true when tested for equivalence with the identifier returned by this method using MatlabProxy.Identifier.equals(java.lang.Object).

Returns:

proxy's identifier

cancel

boolean cancel()

Attempts to cancel the request. If the request has already been completed or cannot successfully be canceled then false will be returned, otherwise true will be returned. If the request has already been successfully canceled then this method will have no effect and true will be returned.

Returns:

if successfully cancelled

isCancelled

boolean isCancelled()

If the request has been successfully cancelled.

Returns:

if successfully cancelled

isCompleted

boolean isCompleted()

Returns true if the proxy has been created.

Returns:

if the proxy has been created