org.netbeans.api.db.explorer

Class JDBCDriverManager

java.lang.Object

org.netbeans.api.db.explorer.JDBCDriverManager

public final class JDBCDriverManager
extends Object

This class manages the list of JDBC drivers registered in the Database Explorer.

Method Summary

Modifier and Type	Method and Description
void	addDriver(JDBCDriver driver) Adds a new JDBC driver.
void	addDriverListener(JDBCDriverListener listener) Registers a JDBCDriverListener.
static JDBCDriverManager	getDefault() Gets the JDBCDriverManager singleton instance.
JDBCDriver[]	getDrivers() Gets the registered JDBC drivers.
JDBCDriver[]	getDrivers(String drvClass) Gets the registered JDBC drivers with the specified class name.
void	removeDriver(JDBCDriver driver) Removes a JDBC driver.
void	removeDriverListener(JDBCDriverListener listener) Unregisters the specified JDBCDriverListener.
void	showAddDriverDialog() Shows the Add Driver dialog, allowing the user to add a new JDBC driver.
JDBCDriver	showAddDriverDialogFromEventThread() Shows the Add Driver dialog synchronously.

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static JDBCDriverManager getDefault()

Gets the JDBCDriverManager singleton instance.

Returns:

the JDBCDriverManager singleton instance.

getDrivers

public JDBCDriver[] getDrivers()

Gets the registered JDBC drivers.

Returns:

a non-null array of JDBCDriver instances.

getDrivers

public JDBCDriver[] getDrivers(String drvClass)

Gets the registered JDBC drivers with the specified class name.

Parameters:

drvClass - driver class name; must not be null.

Returns:

a non-null array of JDBCDriver instances with the specified class name.

Throws:

NullPointerException - if the specified class name is null.

addDriver

public void addDriver(JDBCDriver driver)
               throws DatabaseException

Adds a new JDBC driver.

Parameters:

driver - the JDBCDriver instance describing the driver to be added; must not be null.

Throws:

NullPointerException - if the specified driver is null. DatabaseException if an error occurred while adding the driver.

DatabaseException

removeDriver

public void removeDriver(JDBCDriver driver)
                  throws DatabaseException

Removes a JDBC driver.

Parameters:

driver - the JDBCDriver instance to be removed.

Throws:

DatabaseException - if an error occurred while adding the driver.

showAddDriverDialog

public void showAddDriverDialog()

Shows the Add Driver dialog, allowing the user to add a new JDBC driver.

showAddDriverDialogFromEventThread

public JDBCDriver showAddDriverDialogFromEventThread()

Shows the Add Driver dialog synchronously. Must be run from the AWT event thread; an IllegalStateException will be thrown if this method is called from any other thread.

Returns:

the new driver that was added, or null if the driver was not successfully created.

Throws:

IllegalStateException - if the calling thread is not the event dispatching thread.

Since:

1.27

addDriverListener

public void addDriverListener(JDBCDriverListener listener)

Registers a JDBCDriverListener.

removeDriverListener

public void removeDriverListener(JDBCDriverListener listener)

Unregisters the specified JDBCDriverListener.