- All Implemented Interfaces:
Serializable,Iterable<Throwable>
SyncProvider mechanism. This exception
is created by a SyncProvider abstract class extension if it
encounters violations in reading from or writing to the originating data source.
If it is implemented to do so, the SyncProvider object may also create a
SyncResolver object and either initialize the SyncProviderException
object with it at construction time or set it with the SyncProvider object at
a later time.
The method acceptChanges will throw this exception after the writer
has finished checking for conflicts and has found one or more conflicts. An
application may catch a SyncProviderException object and call its
getSyncResolver method to get its SyncResolver object.
See the code fragment in the interface comment for
SyncResolver for an example.
This SyncResolver object will mirror the RowSet
object that generated the exception, except that it will contain only the values
from the data source that are in conflict. All other values in the SyncResolver
object will be null.
The SyncResolver object may be used to examine and resolve
each conflict in a row and then go to the next row with a conflict to
repeat the procedure.
A SyncProviderException object may or may not contain a description of the
condition causing the exception. The inherited method getMessage may be
called to retrieve the description if there is one.
- Since:
- 1.5
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a newSyncProviderExceptionobject without a detail message.Constructs aSyncProviderExceptionobject with the specified detail message.SyncProviderException(SyncResolver syncResolver) Constructs aSyncProviderExceptionobject with the specifiedSyncResolverinstance. -
Method Summary
Modifier and TypeMethodDescriptionRetrieves theSyncResolverobject that has been set for thisSyncProviderExceptionobject, or if none has been set, an instance of the defaultSyncResolverimplementation included in the reference implementation.voidsetSyncResolver(SyncResolver syncResolver) Sets theSyncResolverobject for thisSyncProviderExceptionobject to the one supplied.Methods declared in class java.sql.SQLException
getErrorCode, getNextException, getSQLState, iterator, setNextExceptionMethods declared in class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringMethods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods declared in interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
SyncProviderException
public SyncProviderException()Creates a newSyncProviderExceptionobject without a detail message. -
SyncProviderException
Constructs aSyncProviderExceptionobject with the specified detail message.- Parameters:
msg- the detail message
-
SyncProviderException
Constructs aSyncProviderExceptionobject with the specifiedSyncResolverinstance.- Parameters:
syncResolver- theSyncResolverinstance used to to process the synchronization conflicts- Throws:
IllegalArgumentException- if theSyncResolverobject isnull.
-
-
Method Details
-
getSyncResolver
Retrieves theSyncResolverobject that has been set for thisSyncProviderExceptionobject, or if none has been set, an instance of the defaultSyncResolverimplementation included in the reference implementation.If a
SyncProviderExceptionobject is thrown, an application may use this method to generate aSyncResolverobject with which to resolve the conflict or conflicts that caused the exception to be thrown.- Returns:
- the
SyncResolverobject set for thisSyncProviderExceptionobject or, if none has been set, an instance of the defaultSyncResolverimplementation. In addition, the defaultSyncResolverimplementation is also returned if theSyncResolver()orSyncResolver(String)constructors are used to instantiate theSyncResolverinstance.
-
setSyncResolver
Sets theSyncResolverobject for thisSyncProviderExceptionobject to the one supplied. If the argument supplied isnull, a call to the methodgetSyncResolverwill return the default reference implementation of theSyncResolverinterface.- Parameters:
syncResolver- theSyncResolverobject to be set; cannot benull- Throws:
IllegalArgumentException- if theSyncResolverobject isnull.- See Also:
-