org.xins.client

Class AbstractCAPICallResult

java.lang.Object

org.xins.client.AbstractCAPICallResult

All Implemented Interfaces:

Serializable

public abstract class AbstractCAPICallResult
extends Object
implements Serializable

Base class for generated CAPI function result classes.

This class should not be subclassed manually. It is only intended to be subclassed by classes generated by XINS.

Since:

XINS 1.0.0

Version:

$Revision: 1.26 $ $Date: 2013/01/22 15:13:22 $

Author:

Ernst de Haan

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCAPICallResult(XINSCallResult result) Creates a new AbstractCAPICallResult object, based on the specified XINSCallResult.

Method Summary

Methods

Modifier and Type	Method and Description
long	duration() Returns the call duration, in milliseconds.
List<CallException>	exceptions() Returns the list of CallExceptions.
TargetDescriptor	succeededTarget() Returns the target for which the call succeeded.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCAPICallResult

protected AbstractCAPICallResult(XINSCallResult result)
                          throws IllegalArgumentException

Creates a new AbstractCAPICallResult object, based on the specified XINSCallResult.

Parameters:

result - the lower-level XINSCallResult, cannot be null.

Throws:

IllegalArgumentException - if result == null.

Method Detail

succeededTarget

public final TargetDescriptor succeededTarget()

Returns the target for which the call succeeded.

Returns:

the TargetDescriptor for which the call succeeded, not null.

Since:

XINS 1.1.0

duration

public final long duration()

Returns the call duration, in milliseconds.

Returns:

the duration of the succeeded call, in milliseconds, guaranteed to be a non-negative number.

Since:

XINS 1.1.0

exceptions

public final List<CallException> exceptions()

Returns the list of CallExceptions.

Returns:

the CallExceptions, collected in a CallExceptionList object, or null if the first call attempt succeeded.

Since:

XINS 1.1.0