org.jivesoftware.smack

Class SynchronizationPointWithSmackException<E extends java.lang.Exception,R>

java.lang.Object

org.jivesoftware.smack.SynchronizationPointWithSmackException<E,R>

public class SynchronizationPointWithSmackException<E extends java.lang.Exception,R>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SynchronizationPointWithSmackException(AbstractXMPPConnection connection, java.lang.String waitFor) Construct a new synchronization point for the given connection.

Method Summary

Modifier and Type	Method and Description
R	checkIfSuccessOrWaitOrThrow() Check if this synchronization point is successful or wait the connections reply timeout.
java.lang.Exception	getFailureException()
void	init() Initialize (or reset) this synchronization point.
void	reportFailure(E failureException) Report this synchronization point as failed because of the given exception.
void	reportFailure(SmackException smackException) Report this synchronization point as failed because of the given exception.
void	reportSuccess(R result) Report this synchronization point as successful.
boolean	requestSent() Check if this synchronization point has its request already sent.
void	resetTimeout()
boolean	wasSuccessful() Check if this synchronization point was successful.

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronizationPointWithSmackException

public SynchronizationPointWithSmackException(AbstractXMPPConnection connection,
                                              java.lang.String waitFor)

Construct a new synchronization point for the given connection.

Parameters:

connection - the connection of this synchronization point.

waitFor - a description of the event this synchronization point handles.

Method Detail

init

public void init()

Initialize (or reset) this synchronization point.

checkIfSuccessOrWaitOrThrow

public R checkIfSuccessOrWaitOrThrow()
                              throws E extends java.lang.Exception,
                                     java.lang.InterruptedException,
                                     SmackException

Check if this synchronization point is successful or wait the connections reply timeout.

Throws:

E - if there was a failure

java.lang.InterruptedException - if the connection is interrupted.

SmackException

E extends java.lang.Exception

reportSuccess

public void reportSuccess(R result)

Report this synchronization point as successful.

reportFailure

public void reportFailure(SmackException smackException)

Report this synchronization point as failed because of the given exception. The failureException must be set.

Parameters:

smackException - the exception causing this synchronization point to fail.

reportFailure

public void reportFailure(E failureException)

Report this synchronization point as failed because of the given exception. The failureException must be set.

Parameters:

failureException - the exception causing this synchronization point to fail.

wasSuccessful

public boolean wasSuccessful()

Check if this synchronization point was successful.

Returns:

true if the synchronization point was successful, false otherwise.

requestSent

public boolean requestSent()

Check if this synchronization point has its request already sent.

Returns:

true if the request was already sent, false otherwise.

getFailureException

public java.lang.Exception getFailureException()

resetTimeout

public void resetTimeout()