javax.sql.rowset.spi
Class SyncProviderException

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.lang.Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable 
      extended by java.lang.Exception sample code for java.lang.Exception definition code for java.lang.Exception 
          extended by java.sql.SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
              extended by javax.sql.rowset.spi.SyncProviderException
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class SyncProviderException
extends SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException

Indicates an error with the 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.

See Also:
SyncFactory sample code for javax.sql.rowset.spi.SyncFactory definition code for javax.sql.rowset.spi.SyncFactory , SyncResolver sample code for javax.sql.rowset.spi.SyncResolver definition code for javax.sql.rowset.spi.SyncResolver , SyncFactoryException sample code for javax.sql.rowset.spi.SyncFactoryException definition code for javax.sql.rowset.spi.SyncFactoryException , Serialized Form

Constructor Summary
SyncProviderException sample code for javax.sql.rowset.spi.SyncProviderException.SyncProviderException() definition code for javax.sql.rowset.spi.SyncProviderException.SyncProviderException() ()
          Creates a new SyncProviderException object without a detail message.
SyncProviderException sample code for javax.sql.rowset.spi.SyncProviderException.SyncProviderException(java.lang.String) definition code for javax.sql.rowset.spi.SyncProviderException.SyncProviderException(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  msg)
          Constructs a SyncProviderException object with the specified detail message.
SyncProviderException sample code for javax.sql.rowset.spi.SyncProviderException.SyncProviderException(javax.sql.rowset.spi.SyncResolver) definition code for javax.sql.rowset.spi.SyncProviderException.SyncProviderException(javax.sql.rowset.spi.SyncResolver) (SyncResolver sample code for javax.sql.rowset.spi.SyncResolver definition code for javax.sql.rowset.spi.SyncResolver  syncResolver)
          Constructs a SyncProviderException object with the specified SyncResolver instance.
 
Method Summary
 SyncResolver sample code for javax.sql.rowset.spi.SyncResolver definition code for javax.sql.rowset.spi.SyncResolver getSyncResolver sample code for javax.sql.rowset.spi.SyncProviderException.getSyncResolver() definition code for javax.sql.rowset.spi.SyncProviderException.getSyncResolver() ()
          Retrieves the SyncResolver object that has been set for this SyncProviderException object, or if none has been set, an instance of the default SyncResolver implementation included in the reference implementation.
 void setSyncResolver sample code for javax.sql.rowset.spi.SyncProviderException.setSyncResolver(javax.sql.rowset.spi.SyncResolver) definition code for javax.sql.rowset.spi.SyncProviderException.setSyncResolver(javax.sql.rowset.spi.SyncResolver) (SyncResolver sample code for javax.sql.rowset.spi.SyncResolver definition code for javax.sql.rowset.spi.SyncResolver  syncResolver)
          Sets the SyncResolver object for this SyncProviderException object to the one supplied.
 
Methods inherited from class java.sql.SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException
getErrorCode sample code for java.sql.SQLException.getErrorCode() definition code for java.sql.SQLException.getErrorCode() , getNextException sample code for java.sql.SQLException.getNextException() definition code for java.sql.SQLException.getNextException() , getSQLState sample code for java.sql.SQLException.getSQLState() definition code for java.sql.SQLException.getSQLState() , setNextException sample code for java.sql.SQLException.setNextException(java.sql.SQLException) definition code for java.sql.SQLException.setNextException(java.sql.SQLException)
 
Methods inherited from class java.lang.Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable
fillInStackTrace sample code for java.lang.Throwable.fillInStackTrace() definition code for java.lang.Throwable.fillInStackTrace() , getCause sample code for java.lang.Throwable.getCause() definition code for java.lang.Throwable.getCause() , getLocalizedMessage sample code for java.lang.Throwable.getLocalizedMessage() definition code for java.lang.Throwable.getLocalizedMessage() , getMessage sample code for java.lang.Throwable.getMessage() definition code for java.lang.Throwable.getMessage() , getStackTrace sample code for java.lang.Throwable.getStackTrace() definition code for java.lang.Throwable.getStackTrace() , initCause sample code for java.lang.Throwable.initCause(java.lang.Throwable) definition code for java.lang.Throwable.initCause(java.lang.Throwable) , printStackTrace sample code for java.lang.Throwable.printStackTrace() definition code for java.lang.Throwable.printStackTrace() , printStackTrace sample code for java.lang.Throwable.printStackTrace(java.io.PrintStream) definition code for java.lang.Throwable.printStackTrace(java.io.PrintStream) , printStackTrace sample code for java.lang.Throwable.printStackTrace(java.io.PrintWriter) definition code for java.lang.Throwable.printStackTrace(java.io.PrintWriter) , setStackTrace sample code for java.lang.Throwable.setStackTrace(java.lang.StackTraceElement[]) definition code for java.lang.Throwable.setStackTrace(java.lang.StackTraceElement[]) , toString sample code for java.lang.Throwable.toString() definition code for java.lang.Throwable.toString()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

SyncProviderException sample code for javax.sql.rowset.spi.SyncProviderException() definition code for javax.sql.rowset.spi.SyncProviderException()

public SyncProviderException()
Creates a new SyncProviderException object without a detail message.


SyncProviderException sample code for javax.sql.rowset.spi.SyncProviderException(java.lang.String) definition code for javax.sql.rowset.spi.SyncProviderException(java.lang.String)

public SyncProviderException(String sample code for java.lang.String definition code for java.lang.String  msg)
Constructs a SyncProviderException object with the specified detail message.

Parameters:
msg - the detail message

SyncProviderException sample code for javax.sql.rowset.spi.SyncProviderException(javax.sql.rowset.spi.SyncResolver) definition code for javax.sql.rowset.spi.SyncProviderException(javax.sql.rowset.spi.SyncResolver)

public SyncProviderException(SyncResolver sample code for javax.sql.rowset.spi.SyncResolver definition code for javax.sql.rowset.spi.SyncResolver  syncResolver)
Constructs a SyncProviderException object with the specified SyncResolver instance.

Parameters:
syncResolver - the SyncResolver instance used to to process the synchronization conflicts
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the SyncResolver object is null.
Method Detail

getSyncResolver sample code for javax.sql.rowset.spi.SyncProviderException.getSyncResolver() definition code for javax.sql.rowset.spi.SyncProviderException.getSyncResolver()

public SyncResolver sample code for javax.sql.rowset.spi.SyncResolver definition code for javax.sql.rowset.spi.SyncResolver  getSyncResolver()
Retrieves the SyncResolver object that has been set for this SyncProviderException object, or if none has been set, an instance of the default SyncResolver implementation included in the reference implementation.

If a SyncProviderException object is thrown, an application may use this method to generate a SyncResolver object with which to resolve the conflict or conflicts that caused the exception to be thrown.

Returns:
the SyncResolver object set for this SyncProviderException object or, if none has been set, an instance of the default SyncResolver implementation. In addition, the default SyncResolver implementation is also returned if the SyncResolver() or SyncResolver(String) constructors are used to instantiate the SyncResolver instance.

setSyncResolver sample code for javax.sql.rowset.spi.SyncProviderException.setSyncResolver(javax.sql.rowset.spi.SyncResolver) definition code for javax.sql.rowset.spi.SyncProviderException.setSyncResolver(javax.sql.rowset.spi.SyncResolver)

public void setSyncResolver(SyncResolver sample code for javax.sql.rowset.spi.SyncResolver definition code for javax.sql.rowset.spi.SyncResolver  syncResolver)
Sets the SyncResolver object for this SyncProviderException object to the one supplied. If the argument supplied is null, a call to the method getSyncResolver will return the default reference implementation of the SyncResolver interface.

Parameters:
syncResolver - the SyncResolver object to be set; cannot be null
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the SyncResolver object is null.
See Also:
getSyncResolver() sample code for javax.sql.rowset.spi.SyncProviderException.getSyncResolver() definition code for javax.sql.rowset.spi.SyncProviderException.getSyncResolver()