javax.naming.spi
Class ResolveResult

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.naming.spi.ResolveResult
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class ResolveResult
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Serializable sample code for java.io.Serializable definition code for java.io.Serializable

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.

Since:
1.3
See Also:
Serialized Form

Field Summary
protected  Name sample code for javax.naming.Name definition code for javax.naming.Name remainingName sample code for javax.naming.spi.ResolveResult.remainingName definition code for javax.naming.spi.ResolveResult.remainingName
          Field containing the remaining name yet to be resolved.
protected  Object sample code for java.lang.Object definition code for java.lang.Object resolvedObj sample code for javax.naming.spi.ResolveResult.resolvedObj definition code for javax.naming.spi.ResolveResult.resolvedObj
          Field containing the Object that was resolved to successfully.
 
Constructor Summary
protected ResolveResult sample code for javax.naming.spi.ResolveResult.ResolveResult() definition code for javax.naming.spi.ResolveResult.ResolveResult() ()
          Constructs an instance of ResolveResult with the resolved object and remaining name both initialized to null.
  ResolveResult sample code for javax.naming.spi.ResolveResult.ResolveResult(java.lang.Object, javax.naming.Name) definition code for javax.naming.spi.ResolveResult.ResolveResult(java.lang.Object, javax.naming.Name) (Object sample code for java.lang.Object definition code for java.lang.Object  robj, Name sample code for javax.naming.Name definition code for javax.naming.Name  rname)
          Constructs a new instance of ResolveResult consisting of the resolved Object and the remaining name.
  ResolveResult sample code for javax.naming.spi.ResolveResult.ResolveResult(java.lang.Object, java.lang.String) definition code for javax.naming.spi.ResolveResult.ResolveResult(java.lang.Object, java.lang.String) (Object sample code for java.lang.Object definition code for java.lang.Object  robj, String sample code for java.lang.String definition code for java.lang.String  rcomp)
          Constructs a new instance of ResolveResult consisting of the resolved object and the remaining unresolved component.
 
Method Summary
 void appendRemainingComponent sample code for javax.naming.spi.ResolveResult.appendRemainingComponent(java.lang.String) definition code for javax.naming.spi.ResolveResult.appendRemainingComponent(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  name)
          Adds a single component to the end of remaining name.
 void appendRemainingName sample code for javax.naming.spi.ResolveResult.appendRemainingName(javax.naming.Name) definition code for javax.naming.spi.ResolveResult.appendRemainingName(javax.naming.Name) (Name sample code for javax.naming.Name definition code for javax.naming.Name  name)
          Adds components to the end of remaining name.
 Name sample code for javax.naming.Name definition code for javax.naming.Name getRemainingName sample code for javax.naming.spi.ResolveResult.getRemainingName() definition code for javax.naming.spi.ResolveResult.getRemainingName() ()
          Retrieves the remaining unresolved portion of the name.
 Object sample code for java.lang.Object definition code for java.lang.Object getResolvedObj sample code for javax.naming.spi.ResolveResult.getResolvedObj() definition code for javax.naming.spi.ResolveResult.getResolvedObj() ()
          Retrieves the Object to which resolution was successful.
 void setRemainingName sample code for javax.naming.spi.ResolveResult.setRemainingName(javax.naming.Name) definition code for javax.naming.spi.ResolveResult.setRemainingName(javax.naming.Name) (Name sample code for javax.naming.Name definition code for javax.naming.Name  name)
          Sets the remaining name field of this result to name.
 void setResolvedObj sample code for javax.naming.spi.ResolveResult.setResolvedObj(java.lang.Object) definition code for javax.naming.spi.ResolveResult.setResolvedObj(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Sets the resolved Object field of this result to obj.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

resolvedObj sample code for javax.naming.spi.ResolveResult.resolvedObj

protected Object sample code for java.lang.Object definition code for java.lang.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.


remainingName sample code for javax.naming.spi.ResolveResult.remainingName

protected Name sample code for javax.naming.Name definition code for javax.naming.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.

Constructor Detail

ResolveResult sample code for javax.naming.spi.ResolveResult() definition code for javax.naming.spi.ResolveResult()

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


ResolveResult sample code for javax.naming.spi.ResolveResult(java.lang.Object, java.lang.String) definition code for javax.naming.spi.ResolveResult(java.lang.Object, java.lang.String)

public ResolveResult(Object sample code for java.lang.Object definition code for java.lang.Object  robj,
                     String sample code for java.lang.String definition code for java.lang.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).

ResolveResult sample code for javax.naming.spi.ResolveResult(java.lang.Object, javax.naming.Name) definition code for javax.naming.spi.ResolveResult(java.lang.Object, javax.naming.Name)

public ResolveResult(Object sample code for java.lang.Object definition code for java.lang.Object  robj,
                     Name sample code for javax.naming.Name definition code for javax.naming.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.
Method Detail

getRemainingName sample code for javax.naming.spi.ResolveResult.getRemainingName() definition code for javax.naming.spi.ResolveResult.getRemainingName()

public Name sample code for javax.naming.Name definition code for javax.naming.Name  getRemainingName()
Retrieves the remaining unresolved portion of the name.

Returns:
The remaining unresolved portion of the name. Cannot be null but empty OK.
See Also:
appendRemainingName(javax.naming.Name) sample code for javax.naming.spi.ResolveResult.appendRemainingName(javax.naming.Name) definition code for javax.naming.spi.ResolveResult.appendRemainingName(javax.naming.Name) , appendRemainingComponent(java.lang.String) sample code for javax.naming.spi.ResolveResult.appendRemainingComponent(java.lang.String) definition code for javax.naming.spi.ResolveResult.appendRemainingComponent(java.lang.String) , setRemainingName(javax.naming.Name) sample code for javax.naming.spi.ResolveResult.setRemainingName(javax.naming.Name) definition code for javax.naming.spi.ResolveResult.setRemainingName(javax.naming.Name)

getResolvedObj sample code for javax.naming.spi.ResolveResult.getResolvedObj() definition code for javax.naming.spi.ResolveResult.getResolvedObj()

public Object sample code for java.lang.Object definition code for java.lang.Object  getResolvedObj()
Retrieves the Object to which resolution was successful.

Returns:
The Object to which resolution was successful. Cannot be null.
See Also:
setResolvedObj(java.lang.Object) sample code for javax.naming.spi.ResolveResult.setResolvedObj(java.lang.Object) definition code for javax.naming.spi.ResolveResult.setResolvedObj(java.lang.Object)

setRemainingName sample code for javax.naming.spi.ResolveResult.setRemainingName(javax.naming.Name) definition code for javax.naming.spi.ResolveResult.setRemainingName(javax.naming.Name)

public void setRemainingName(Name sample code for javax.naming.Name definition code for javax.naming.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.
See Also:
getRemainingName() sample code for javax.naming.spi.ResolveResult.getRemainingName() definition code for javax.naming.spi.ResolveResult.getRemainingName() , appendRemainingName(javax.naming.Name) sample code for javax.naming.spi.ResolveResult.appendRemainingName(javax.naming.Name) definition code for javax.naming.spi.ResolveResult.appendRemainingName(javax.naming.Name) , appendRemainingComponent(java.lang.String) sample code for javax.naming.spi.ResolveResult.appendRemainingComponent(java.lang.String) definition code for javax.naming.spi.ResolveResult.appendRemainingComponent(java.lang.String)

appendRemainingName sample code for javax.naming.spi.ResolveResult.appendRemainingName(javax.naming.Name) definition code for javax.naming.spi.ResolveResult.appendRemainingName(javax.naming.Name)

public void appendRemainingName(Name sample code for javax.naming.Name definition code for javax.naming.Name  name)
Adds components to the end of remaining name.

Parameters:
name - The components to add. Can be null.
See Also:
getRemainingName() sample code for javax.naming.spi.ResolveResult.getRemainingName() definition code for javax.naming.spi.ResolveResult.getRemainingName() , setRemainingName(javax.naming.Name) sample code for javax.naming.spi.ResolveResult.setRemainingName(javax.naming.Name) definition code for javax.naming.spi.ResolveResult.setRemainingName(javax.naming.Name) , appendRemainingComponent(java.lang.String) sample code for javax.naming.spi.ResolveResult.appendRemainingComponent(java.lang.String) definition code for javax.naming.spi.ResolveResult.appendRemainingComponent(java.lang.String)

appendRemainingComponent sample code for javax.naming.spi.ResolveResult.appendRemainingComponent(java.lang.String) definition code for javax.naming.spi.ResolveResult.appendRemainingComponent(java.lang.String)

public void appendRemainingComponent(String sample code for java.lang.String definition code for java.lang.String  name)
Adds a single component to the end of remaining name.

Parameters:
name - The component to add. Can be null.
See Also:
getRemainingName() sample code for javax.naming.spi.ResolveResult.getRemainingName() definition code for javax.naming.spi.ResolveResult.getRemainingName() , appendRemainingName(javax.naming.Name) sample code for javax.naming.spi.ResolveResult.appendRemainingName(javax.naming.Name) definition code for javax.naming.spi.ResolveResult.appendRemainingName(javax.naming.Name)

setResolvedObj sample code for javax.naming.spi.ResolveResult.setResolvedObj(java.lang.Object) definition code for javax.naming.spi.ResolveResult.setResolvedObj(java.lang.Object)

public void setResolvedObj(Object sample code for java.lang.Object definition code for java.lang.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.
See Also:
getResolvedObj() sample code for javax.naming.spi.ResolveResult.getResolvedObj() definition code for javax.naming.spi.ResolveResult.getResolvedObj()