Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Standard Ed. 5.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.naming.spi
Class ResolveResult

    java.lang.Object
      javax.naming.spi.ResolveResult

All Implemented Interfaces:
  Serializable

    public class ResolveResult

extends Object
implements 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` | `remainingName` Field containing the remaining name yet to be resolved.
`protected Object` | `resolvedObj` Field containing the Object that was resolved to successfully.

Constructor Summary
`protected` | `ResolveResult()` Constructs an instance of ResolveResult with the resolved object and remaining name both initialized to null.
`` | `ResolveResult(Object robj, Name rname)` Constructs a new instance of ResolveResult consisting of the resolved Object and the remaining name.
`` | `ResolveResult(Object robj, String rcomp)` Constructs a new instance of ResolveResult consisting of the resolved object and the remaining unresolved component.

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

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### 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.

### 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.

Constructor Detail

### ResolveResult

    protected ResolveResult()

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

### 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).

### 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.

Method Detail

### 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.
  See Also:
    `appendRemainingName(javax.naming.Name)`, `appendRemainingComponent(java.lang.String)`, `setRemainingName(javax.naming.Name)`

### getResolvedObj

    public 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)`

### 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.
  See Also:
    `getRemainingName()`, `appendRemainingName(javax.naming.Name)`, `appendRemainingComponent(java.lang.String)`

### appendRemainingName

    public void appendRemainingName(Name name)

  Adds components to the end of remaining name.

  Parameters:
    `name` - The components to add. Can be null.
  See Also:
    `getRemainingName()`, `setRemainingName(javax.naming.Name)`, `appendRemainingComponent(java.lang.String)`

### 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.
  See Also:
    `getRemainingName()`, `appendRemainingName(javax.naming.Name)`

### 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.
  See Also:
    `getResolvedObj()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Standard Ed. 5.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.