All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.naming.LinkException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.naming.NamingException
                           |
                           +----java.naming.LinkException

public class LinkException
extends NamingException
LinkException is used to describe problems encounter resolving links. Addition information is added to the base NamingException for pinpointing the problem with the link.


Variable Index

 o linkExplanation
 o linkRemainingName
 o linkResolvedName
 o linkResolvedObj

Constructor Index

 o LinkException()
Constructs a new instance of LinkException.
 o LinkException(Name, Object, Name, String)
Constructs a new instance of LinkException using the non-link information specified.
 o LinkException(Name, Object, Name, String, Name, Object, Name, String)
Constructs a new instance of LinkException using the both non-link and link information specified.

Method Index

 o getLinkExplanation()
Retrieves the explanation associated with this problem encounter when resolving a link.
 o getLinkRemainingName()
Retrieves the remaining unresolved portion of the link name.
 o getLinkResolvedName()
Retrieves the leading portion of the link name that was resolved successfully.
 o getLinkResolvedObj()
Retrieves the object to which resolution was successful.
 o setLinkRemainingName(Name)
Sets the remaining link name field of this exception.
 o setLinkResolvedName(Name)
Sets the resolved link name field of this exception.
 o setLinkResolvedObj(Object)
Sets the link resolved object field of this exception.
 o toString()
Generates the string representation of this exception.
 o toString(boolean)
Generates the string representation of this exception.

Variables

 o linkResolvedName
 protected Name linkResolvedName
 o linkResolvedObj
 protected Object linkResolvedObj
 o linkRemainingName
 protected Name linkRemainingName
 o linkExplanation
 protected String linkExplanation

Constructors

 o LinkException
 public LinkException(Name resolvedName,
                      Object resolvedObj,
                      Name remainingName,
                      String explanation)
Constructs a new instance of LinkException using the non-link information specified.

Parameters:
resolvedName - The part of the name that has been successfully resolved.
resolvedObj - The object to which resolution was successful.
remainingName - The remaining unresolved portion of the name.
explanation - Additional detail about this exception.
 o LinkException
 public LinkException(Name resolvedName,
                      Object resolvedObj,
                      Name remainingName,
                      String explanation,
                      Name linkResolvedName,
                      Object linkResolvedObj,
                      Name linkRemainingName,
                      String linkExplanation)
Constructs a new instance of LinkException using the both non-link and link information specified.

Parameters:
resolvedName - The part of the name that has been successfully resolved.
resolvedObj - The object to which resolution was successful.
remainingName - The remaining unresolved portion of the name.
explanation - Additional detail about this exception.
linkResolvedName - The part of the link that has been successfully resolved.
linkResolvedObj - The object to which resolution of the part of the link was successful.
linkRemainingName - The remaining unresolved portion of the link.
linkExplanation - Additional detail about attempting to resolving the link.
 o LinkException
 public LinkException()
Constructs a new instance of LinkException.

Methods

 o getLinkResolvedName
 public Name getLinkResolvedName()
Retrieves the leading portion of the link name that was resolved successfully.

Returns:
The part of the link name that was resolved successfully.
See Also:
getLinkResolvedObj, setLinkResolvedName
 o getLinkRemainingName
 public Name getLinkRemainingName()
Retrieves the remaining unresolved portion of the link name.

Returns:
The part of the link name that has not been resolved.
See Also:
setLinkRemainingName
 o getLinkResolvedObj
 public Object getLinkResolvedObj()
Retrieves the object to which resolution was successful. This is the object to which the resolved link name is bound.

Returns:
The object that was resolved so far.
See Also:
getLinkResolvedName, setLinkResolvedObj
 o getLinkExplanation
 public String getLinkExplanation()
Retrieves the explanation associated with this problem encounter when resolving a link.

Returns:
The detail string explaining more about the problem with resolving a link.
 o setLinkResolvedName
 public void setLinkResolvedName(Name name)
Sets the resolved link name field of this exception.

Parameters:
name - The name to set resolved link name to.
See Also:
getLinkResolvedName
 o setLinkRemainingName
 public void setLinkRemainingName(Name name)
Sets the remaining link name field of this exception.

Parameters:
name - The name to set remaining link name to.
See Also:
getLinkRemainingName
 o setLinkResolvedObj
 public void setLinkResolvedObj(Object obj)
Sets the link resolved object field of this exception. This indicates the last successfully resolved object of link name.

Parameters:
obj - The object to set link resolved object to.
See Also:
getLinkResolvedObj
 o toString
 public String toString()
Generates the string representation of this exception. This string consists of the NamingException information plus the additional information of resolving the link.

Returns:
The string representation of this link exception.
Overrides:
toString in class NamingException
 o toString
 public String toString(boolean detail)
Generates the string representation of this exception. This string consists of the NamingException information plus the additional information of resolving the link. If 'detail' is true, the string also contains information on the link resolved object.

Parameters:
detail - If true, add information about the link resolved object.
Returns:
The string representation of this link exception.
Overrides:
toString in class NamingException

All Packages  Class Hierarchy  This Package  Previous  Next  Index