public class NamingException extends Exception
A NamingException instance is not synchronized against concurrent multithreaded access. Multiple threads trying to access and modify a single NamingException instance should lock the object.
This exception has been retrofitted to conform to
the general purpose exception-chaining mechanism. The
root exception (or root cause) is the same object as the
cause returned by the Throwable.getCause()
method.
Modifier and Type | Field and Description |
---|---|
protected Name |
remainingName
Contains the remaining name that has not been resolved yet.
|
protected Name |
resolvedName
Contains the part of the name that has been successfully resolved.
|
protected Object |
resolvedObj
Contains the object to which resolution of the part of the name was
successful.
|
protected Throwable |
rootException
Contains the original exception that caused this NamingException to
be thrown.
|
Constructor and Description |
---|
NamingException()
Constructs a new NamingException.
|
NamingException(String explanation)
Constructs a new NamingException with an explanation.
|
Modifier and Type | Method and Description |
---|---|
void |
appendRemainingComponent(String name)
Add name as the last component in remaining name.
|
void |
appendRemainingName(Name name)
Add components from 'name' as the last components in
remaining name.
|
Throwable |
getCause()
Returns the cause of this exception.
|
String |
getExplanation()
Retrieves the explanation associated with this exception.
|
Name |
getRemainingName()
Retrieves the remaining unresolved portion of the name.
|
Name |
getResolvedName()
Retrieves the leading portion of the name that was resolved
successfully.
|
Object |
getResolvedObj()
Retrieves the object to which resolution was successful.
|
Throwable |
getRootCause()
Retrieves the root cause of this NamingException, if any.
|
Throwable |
initCause(Throwable cause)
Initializes the cause of this exception to the specified value.
|
void |
setRemainingName(Name name)
Sets the remaining name field of this exception.
|
void |
setResolvedName(Name name)
Sets the resolved name field of this exception.
|
void |
setResolvedObj(Object obj)
Sets the resolved object field of this exception.
|
void |
setRootCause(Throwable e)
Records the root cause of this NamingException.
|
String |
toString()
Generates the string representation of this exception.
|
String |
toString(boolean detail)
Generates the string representation in more detail.
|
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace
protected Name resolvedName
protected Object resolvedObj
protected Name remainingName
protected Throwable rootException
This field predates the general-purpose exception chaining facility.
The initCause(Throwable)
and getCause()
methods
are now the preferred means of accessing this information.
public NamingException(String explanation)
explanation
- A possibly null string containing
additional detail about this exception.Throwable.getMessage()
public NamingException()
public Name getResolvedName()
getResolvedObj()
,
setResolvedName(javax.naming.Name)
public Name getRemainingName()
setRemainingName(javax.naming.Name)
,
appendRemainingName(javax.naming.Name)
,
appendRemainingComponent(java.lang.String)
public Object getResolvedObj()
getResolvedName()
,
setResolvedObj(java.lang.Object)
public String getExplanation()
Throwable.getMessage()
public void setResolvedName(Name name)
name is a composite name. If the intent is to set this field using a compound name or string, you must "stringify" the compound name, and create a composite name with a single component using the string. You can then invoke this method using the resulting composite name.
A copy of name
is made and stored.
Subsequent changes to name
does not
affect the copy in this NamingException and vice versa.
name
- The possibly null name to set resolved name to.
If null, it sets the resolved name field to null.getResolvedName()
public void setRemainingName(Name name)
name is a composite name. If the intent is to set this field using a compound name or string, you must "stringify" the compound name, and create a composite name with a single component using the string. You can then invoke this method using the resulting composite name.
A copy of name
is made and stored.
Subsequent changes to name
does not
affect the copy in this NamingException and vice versa.
name
- The possibly null name to set remaining name to.
If null, it sets the remaining name field to null.getRemainingName()
,
appendRemainingName(javax.naming.Name)
,
appendRemainingComponent(java.lang.String)
public void setResolvedObj(Object obj)
obj
- The possibly null object to set resolved object to.
If null, the resolved object field is set to null.getResolvedObj()
public void appendRemainingComponent(String name)
name
- The component to add.
If name is null, this method does not do anything.setRemainingName(javax.naming.Name)
,
getRemainingName()
,
appendRemainingName(javax.naming.Name)
public void appendRemainingName(Name name)
name is a composite name. If the intent is to append a compound name, you should "stringify" the compound name then invoke the overloaded form that accepts a String parameter.
Subsequent changes to name
does not
affect the remaining name field in this NamingException and vice versa.
name
- The possibly null name containing ordered components to add.
If name is null, this method does not do anything.setRemainingName(javax.naming.Name)
,
getRemainingName()
,
appendRemainingComponent(java.lang.String)
public Throwable getRootCause()
This method predates the general-purpose exception chaining facility.
The getCause()
method is now the preferred means of obtaining
this information.
setRootCause(java.lang.Throwable)
,
rootException
,
getCause()
public void setRootCause(Throwable e)
This method predates the general-purpose exception chaining facility.
The initCause(Throwable)
method is now the preferred means
of recording this information.
e
- The possibly null exception that caused the naming
operation to fail. If null, it means this naming
exception has no root cause.getRootCause()
,
rootException
,
initCause(java.lang.Throwable)
public Throwable getCause()
null
if the cause is nonexistent or
unknown.getCause
in class Throwable
null
if the
cause is nonexistent or unknown.initCause(Throwable)
public Throwable initCause(Throwable cause)
This method may be called at most once.
initCause
in class Throwable
cause
- the cause, which is saved for later retrieval by
the getCause()
method. A null value
indicates that the cause is nonexistent or unknown.NamingException
instance.IllegalArgumentException
- if cause
is this
exception. (A throwable cannot be its own cause.)IllegalStateException
- if this method has already
been called on this exception.getCause()
public String toString()
public String toString(boolean detail)
detail
- If true, include details about the resolved object
in addition to the other information. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.