oracle.javatools.db

Class DBObjectProviderID

java.lang.Object

oracle.javatools.db.DBObjectProviderID

public class DBObjectProviderID
extends java.lang.Object

Immutable class that encapsulates the identifier and type for a DBObjectProvider. Can be used with the DBObjectProviderFactory to find or create a given provider.

Since:

12

See Also:

DBObjectProviderFactory, DBObjectProvider

Constructor Summary

Constructors

Constructor and Description
DBObjectProviderID(DBObjectProvider pro) Creates an ID for the given provider.
DBObjectProviderID(java.lang.String type, java.lang.Object identifier) Creates an ID for the given provider type and identifier.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other) Equals implementation compares the type and identifier and returns true if they are the same.
java.lang.Object	getIdentifier() Gets the identifier of the DBObjectProvider.
java.lang.String	getType() Gets the type of the DBObjectProvider.
int	hashCode()
boolean	isValid() Tests whether this DBObjectProviderID is valid - i.e.
DBObjectProvider	resolveID() Convinience method to find or create the DBObjectProvider described by this ID.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DBObjectProviderID

public DBObjectProviderID(java.lang.String type,
                  java.lang.Object identifier)

Creates an ID for the given provider type and identifier.

DBObjectProviderID

public DBObjectProviderID(DBObjectProvider pro)

Creates an ID for the given provider. The provider cannot be null.

Method Detail

getType

public java.lang.String getType()

Gets the type of the DBObjectProvider.

Returns:

a provider type

getIdentifier

public java.lang.Object getIdentifier()

Gets the identifier of the DBObjectProvider.

Returns:

a provider identifier

isValid

public boolean isValid()

Tests whether this DBObjectProviderID is valid - i.e. it is possible that it could resolve to a DBObjectProvider. This does not guarentee that the provider exists, or could even be created, just that the type is valid and the identifier is not null.

resolveID

public DBObjectProvider resolveID()
                           throws DBException

Convinience method to find or create the DBObjectProvider described by this ID.

Returns:

null if the type or identifier are null, or if the provider is not found

Throws:

DBException - if the provider exists but cannot be created (e.g. invalid connection details.

See Also:

DBObjectProviderFactory.findOrCreateProvider(DBObjectProviderID)

equals

public boolean equals(java.lang.Object other)

Equals implementation compares the type and identifier and returns true if they are the same.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object