oracle.javatools.db

Class NameInUseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

oracle.javatools.db.DBException

oracle.javatools.db.validators.ValidationException

oracle.javatools.db.NameInUseException

All Implemented Interfaces:

java.io.Serializable

public class NameInUseException
extends ValidationException

ValidationException thrown when a name is already in use by an existing object in the DBObjectProvider. When available the existing object(s) that are already using the name are available via getRelatedObjects()

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NameInUseException(java.util.Collection<? extends DBObject> objs) Constructs a NameInUseException to indicate that all the given objects cannot be created because objects already exists with the same names.
NameInUseException(DBObject obj) Constructs a NameInUseException to indicate that the given object is invalid because its name is already in use.
NameInUseException(DBObject object, DBObject existing) Constructs a NameInUseException for a name clash with a known existing object in the DBObjectProvider.
NameInUseException(DBObject object, java.lang.String existingName, java.lang.String existingType) Constructs a NameInUseException for the given object that clashes with an existing object in the DBObjectProvider.
NameInUseException(java.lang.String name) Deprecated. - use a constructor that takes the object that is invalid.
NameInUseException(java.lang.String name, java.lang.String existingName, java.lang.String existingType) Deprecated. - use a constructor that takes the object that is invalid.
NameInUseException(java.lang.String name, java.lang.String userName, java.lang.String userType, java.lang.String subUserType) Deprecated. - use a constructor that takes the object that is invalid.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getExistingName() Gets the name of the existing object that clashes with getName().
java.lang.String	getExistingType() Gets the type of the existing object that is using the name.
java.lang.String	getMessage() Gets the message for this exception.
java.lang.String	getName() Gets the name that is invalid because it clashes with an existinb object name.
java.lang.String	getSubUserType() Deprecated.
java.lang.String	getUserName() Deprecated. replaced with getExistingName()
java.lang.String	getUserType() Deprecated. replaced with getExistingType()

Methods inherited from class oracle.javatools.db.validators.ValidationException

getPropertyName, getTitle, setPropertyName

Methods inherited from class oracle.javatools.db.DBException

append, getAllMessages, getNextException, getObject, getRelatedObjects, setNextException, setRelatedObjects

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NameInUseException

public NameInUseException(DBObject obj)

Constructs a NameInUseException to indicate that the given object is invalid because its name is already in use.

Parameters:

obj - the invalid object whose name is in use (cannot be null).

NameInUseException

public NameInUseException(java.util.Collection<? extends DBObject> objs)

Constructs a NameInUseException to indicate that all the given objects cannot be created because objects already exists with the same names.

Parameters:

objs - the objects that all have invalid names

NameInUseException

@Deprecated
public NameInUseException(java.lang.String name)

Deprecated. - use a constructor that takes the object that is invalid.

NameInUseException

@Deprecated
public NameInUseException(java.lang.String name,
                                      java.lang.String existingName,
                                      java.lang.String existingType)

Deprecated. - use a constructor that takes the object that is invalid.

NameInUseException

public NameInUseException(DBObject object,
                          java.lang.String existingName,
                          java.lang.String existingType)

Constructs a NameInUseException for the given object that clashes with an existing object in the DBObjectProvider.

Parameters:

object - the object whose name clashes with that of an existing object.

existingName - the name of the existing object that the name clash has occured with.

existingType - the type of the existing object that the name clash has occured with.

NameInUseException

public NameInUseException(DBObject object,
                          DBObject existing)

Constructs a NameInUseException for a name clash with a known existing object in the DBObjectProvider.

Parameters:

object - the object whose name clashes with that of an existing object.

existing - the existing object that the name clashes with (cannot be null).

NameInUseException

@Deprecated
public NameInUseException(java.lang.String name,
                                      java.lang.String userName,
                                      java.lang.String userType,
                                      java.lang.String subUserType)

Deprecated. - use a constructor that takes the object that is invalid.

Method Detail

getName

public java.lang.String getName()

Gets the name that is invalid because it clashes with an existinb object name.

getExistingName

public java.lang.String getExistingName()

Gets the name of the existing object that clashes with getName(). Depending on the naming conventions of the database the "name" and "existing name" might not be identical.

getExistingType

public java.lang.String getExistingType()

Gets the type of the existing object that is using the name.

getUserName

@Deprecated
public java.lang.String getUserName()

Deprecated. replaced with getExistingName()

getUserType

@Deprecated
public java.lang.String getUserType()

Deprecated. replaced with getExistingType()

getSubUserType

@Deprecated
public java.lang.String getSubUserType()

Deprecated.

getMessage

public java.lang.String getMessage()

Description copied from class: DBException

Gets the message for this exception. This does not include messages for any chained exceptions. For a complete message use getAllMessages()

Overrides:

getMessage in class DBException

Returns:

the message for this exception

See Also:

DBException.getAllMessages()