All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class javax.naming.spi.ResolveResult

java.lang.Object
   |
   +----javax.naming.spi.ResolveResult

public class ResolveResult
extends Object
This class represents the result of resolution of a name. It contains the object to which name was resolved, and the portion of the name that has not been resolved.

A ResolveResult instance is not synchronized against concurrent multithreaded access. Multiple threads trying to access and modify a single ResolveResult instance should lock the object.


Variable Index

 o remainingName
Field containing the remaining name yet to be resolved.
 o resolvedObj
Field containing the Object that was resolved to successfully.

Constructor Index

 o ResolveResult()
Constructs an instance of ResolvedResult with the resolved object and remaining name both initialized to null.
 o ResolveResult(Object, Name)
Constructs a new instance of ResolveResult consisting of the resolved Object and the remaining name.
 o ResolveResult(Object, String)
Constructs a new instance of ResolveResult consisting of the resolved object and the remaining unresolved component.

Method Index

 o appendRemainingComponent(String)
Adds a single component to the end of remaining name.
 o appendRemainingName(Name)
Adds components to the end of remaining name.
 o getRemainingName()
Retrieves the remaining unresolved portion of the name.
 o getResolvedObj()
Retrieves the Object to which resolution was successful.
 o setRemainingName(Name)
Sets the remaining name field of this result to name.
 o setResolvedObj(Object)
Sets the resolved Object field of this result to obj.

Variables

 o resolvedObj
 protected Object resolvedObj
Field containing the Object that was resolved to successfully. It can be null only when constructed using a subclass. Constructors should always initialize this.

 o remainingName
 protected Name remainingName
Field containing the remaining name yet to be resolved. It can be null only when constructed using a subclass. Constructors should always initialize this.

Constructors

 o ResolveResult
 protected ResolveResult()
Constructs an instance of ResolvedResult with the resolved object and remaining name both initialized to null.

 o ResolveResult
 public ResolveResult(Object robj,
                      String rcomp)
Constructs a new instance of ResolveResult consisting of the resolved object and the remaining unresolved component.

Parameters:
robj - The non-null object resolved to.
rcomp - The single remaining name component that has yet to be resolved. Cannot be null (but can be empty).
 o ResolveResult
 public ResolveResult(Object robj,
                      Name rname)
Constructs a new instance of ResolveResult consisting of the resolved Object and the remaining name.

Parameters:
robj - The non-null Object resolved to.
rname - The non-null remaining name that has yet to be resolved.

Methods

 o getRemainingName
 public Name getRemainingName()
Retrieves the remaining unresolved portion of the name.

Returns:
The remaining unresolved portion of the name. Cannot be null but empty OK.
 o getResolvedObj
 public Object getResolvedObj()
Retrieves the Object to which resolution was successful.

Returns:
The Object to which resolution was successful. Cannot be null.
 o setRemainingName
 public void setRemainingName(Name name)
Sets the remaining name field of this result to name. A copy of name is made so that modifying the copy within this ResolveResult does not affect name and vice versa.

Parameters:
name - The name to set remaining name to. Cannot be null.
 o appendRemainingName
 public void appendRemainingName(Name name)
Adds components to the end of remaining name.

Parameters:
name - The components to add. Can be null.
 o appendRemainingComponent
 public void appendRemainingComponent(String name)
Adds a single component to the end of remaining name.

Parameters:
name - The component to add. Can be null.
 o setResolvedObj
 public void setResolvedObj(Object obj)
Sets the resolved Object field of this result to obj.

Parameters:
obj - The object to use for setting the resolved obj field. Cannot be null.

All Packages  Class Hierarchy  This Package  Previous  Next  Index