OpenJDK 27 · javax.sql.rowset.spi.SyncProviderException

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.

Modifier and Type	Field and Description
pack-priv static final long	serialVersionUID Hides java.sql.SQLException.serialVersionUID.
private SyncResolver	syncResolver

Constructor Summary

Access	Constructor and Description
public	SyncProviderException() Creates a new `SyncProviderException` object without a detail message.
public	SyncProviderException(String the detail message msg) Constructs a `SyncProviderException` object with the specified detail message.
public	SyncProviderException(SyncResolver the `SyncResolver` instance used to to process the synchronization conflicts syncResolver) Constructs a `SyncProviderException` object with the specified `SyncResolver` instance.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public SyncResolver	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. 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.
public void	setSyncResolver(SyncResolver the `SyncResolver` object to be set; cannot be `null` syncResolver) Sets the `SyncResolver` object for this `SyncProviderException` object to the one supplied.

public SyncResolver

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.

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.

public void

setSyncResolver(SyncResolver

the SyncResolver object to be set; cannot be null

syncResolver)

Sets the SyncResolver object for this SyncProviderException object to the one supplied.

Inherited from java.sql.SQLException:: getErrorCode getNextException getSQLState iterator setNextException

Field Detail

serialVersionUID	back to summary
pack-priv static final long serialVersionUID Hides java.sql.SQLException.serialVersionUID.

syncResolver	back to summary
private SyncResolver syncResolver Annotations @SuppressWarnings:serial

Constructor Detail

SyncProviderException	back to summary
public SyncProviderException() Creates a new `SyncProviderException` object without a detail message.

SyncProviderException back to summary

SyncProviderException	back to summary
public SyncProviderException(String msg) Constructs a `SyncProviderException` object with the specified detail message. Parameters msg:String the detail message

public SyncProviderException(String msg)

Constructs a SyncProviderException object with the specified detail message.

Parameters

msg:String: the detail message

SyncProviderException back to summary

SyncProviderException	back to summary
public SyncProviderException(SyncResolver syncResolver) Constructs a `SyncProviderException` object with the specified `SyncResolver` instance. Parameters syncResolver:SyncResolver the `SyncResolver` instance used to to process the synchronization conflicts Exceptions IllegalArgumentException: if the `SyncResolver` object is `null`.

public SyncProviderException(SyncResolver syncResolver)

Constructs a SyncProviderException object with the specified SyncResolver instance.

Parameters

syncResolver:SyncResolver: the SyncResolver instance used to to process the synchronization conflicts

Exceptions

IllegalArgumentException:: if the SyncResolver object is null.

Method Detail

getSyncResolver back to summary

getSyncResolver	back to summary
public 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:SyncResolver 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.

public SyncResolver getSyncResolver()

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:SyncResolver: 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 back to summary

setSyncResolver	back to summary
public void setSyncResolver(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:SyncResolver the `SyncResolver` object to be set; cannot be `null` Exceptions IllegalArgumentException: if the `SyncResolver` object is `null`. See Also `getSyncResolver`

public void setSyncResolver(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:SyncResolver: the SyncResolver object to be set; cannot be null

Exceptions

IllegalArgumentException:: if the SyncResolver object is null.

See Also

getSyncResolver

public Class SyncProviderException

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail