javax.naming.directory
Class SearchResult

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.naming.NameClassPair sample code for javax.naming.NameClassPair definition code for javax.naming.NameClassPair 
      extended by javax.naming.Binding sample code for javax.naming.Binding definition code for javax.naming.Binding 
          extended by javax.naming.directory.SearchResult
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class SearchResult
extends Binding sample code for javax.naming.Binding definition code for javax.naming.Binding

This class represents an item in the NamingEnumeration returned as a result of the DirContext.search() methods.

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

Since:
1.3
See Also:
DirContext.search(javax.naming.Name, javax.naming.directory.Attributes, java.lang.String[]) sample code for javax.naming.directory.DirContext.search(javax.naming.Name, javax.naming.directory.Attributes, java.lang.String[]) definition code for javax.naming.directory.DirContext.search(javax.naming.Name, javax.naming.directory.Attributes, java.lang.String[]) , Serialized Form

Constructor Summary
SearchResult sample code for javax.naming.directory.SearchResult.SearchResult(java.lang.String, java.lang.Object, javax.naming.directory.Attributes) definition code for javax.naming.directory.SearchResult.SearchResult(java.lang.String, java.lang.Object, javax.naming.directory.Attributes) (String sample code for java.lang.String definition code for java.lang.String  name, Object sample code for java.lang.Object definition code for java.lang.Object  obj, Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes  attrs)
          Constructs a search result using the result's name, its bound object, and its attributes.
SearchResult sample code for javax.naming.directory.SearchResult.SearchResult(java.lang.String, java.lang.Object, javax.naming.directory.Attributes, boolean) definition code for javax.naming.directory.SearchResult.SearchResult(java.lang.String, java.lang.Object, javax.naming.directory.Attributes, boolean) (String sample code for java.lang.String definition code for java.lang.String  name, Object sample code for java.lang.Object definition code for java.lang.Object  obj, Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes  attrs, boolean isRelative)
          Constructs a search result using the result's name, its bound object, and its attributes, and whether the name is relative.
SearchResult sample code for javax.naming.directory.SearchResult.SearchResult(java.lang.String, java.lang.String, java.lang.Object, javax.naming.directory.Attributes) definition code for javax.naming.directory.SearchResult.SearchResult(java.lang.String, java.lang.String, java.lang.Object, javax.naming.directory.Attributes) (String sample code for java.lang.String definition code for java.lang.String  name, String sample code for java.lang.String definition code for java.lang.String  className, Object sample code for java.lang.Object definition code for java.lang.Object  obj, Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes  attrs)
          Constructs a search result using the result's name, its class name, its bound object, and its attributes.
SearchResult sample code for javax.naming.directory.SearchResult.SearchResult(java.lang.String, java.lang.String, java.lang.Object, javax.naming.directory.Attributes, boolean) definition code for javax.naming.directory.SearchResult.SearchResult(java.lang.String, java.lang.String, java.lang.Object, javax.naming.directory.Attributes, boolean) (String sample code for java.lang.String definition code for java.lang.String  name, String sample code for java.lang.String definition code for java.lang.String  className, Object sample code for java.lang.Object definition code for java.lang.Object  obj, Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes  attrs, boolean isRelative)
          Constructs a search result using the result's name, its class name, its bound object, its attributes, and whether the name is relative.
 
Method Summary
 Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes getAttributes sample code for javax.naming.directory.SearchResult.getAttributes() definition code for javax.naming.directory.SearchResult.getAttributes() ()
          Retrieves the attributes in this search result.
 void setAttributes sample code for javax.naming.directory.SearchResult.setAttributes(javax.naming.directory.Attributes) definition code for javax.naming.directory.SearchResult.setAttributes(javax.naming.directory.Attributes) (Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes  attrs)
          Sets the attributes of this search result to attrs.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for javax.naming.directory.SearchResult.toString() definition code for javax.naming.directory.SearchResult.toString() ()
          Generates the string representation of this SearchResult.
 
Methods inherited from class javax.naming.Binding sample code for javax.naming.Binding definition code for javax.naming.Binding
getClassName sample code for javax.naming.Binding.getClassName() definition code for javax.naming.Binding.getClassName() , getObject sample code for javax.naming.Binding.getObject() definition code for javax.naming.Binding.getObject() , setObject sample code for javax.naming.Binding.setObject(java.lang.Object) definition code for javax.naming.Binding.setObject(java.lang.Object)
 
Methods inherited from class javax.naming.NameClassPair sample code for javax.naming.NameClassPair definition code for javax.naming.NameClassPair
getName sample code for javax.naming.NameClassPair.getName() definition code for javax.naming.NameClassPair.getName() , getNameInNamespace sample code for javax.naming.NameClassPair.getNameInNamespace() definition code for javax.naming.NameClassPair.getNameInNamespace() , isRelative sample code for javax.naming.NameClassPair.isRelative() definition code for javax.naming.NameClassPair.isRelative() , setClassName sample code for javax.naming.NameClassPair.setClassName(java.lang.String) definition code for javax.naming.NameClassPair.setClassName(java.lang.String) , setName sample code for javax.naming.NameClassPair.setName(java.lang.String) definition code for javax.naming.NameClassPair.setName(java.lang.String) , setNameInNamespace sample code for javax.naming.NameClassPair.setNameInNamespace(java.lang.String) definition code for javax.naming.NameClassPair.setNameInNamespace(java.lang.String) , setRelative sample code for javax.naming.NameClassPair.setRelative(boolean) definition code for javax.naming.NameClassPair.setRelative(boolean)
 
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() , 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)
 

Constructor Detail

SearchResult sample code for javax.naming.directory.SearchResult(java.lang.String, java.lang.Object, javax.naming.directory.Attributes) definition code for javax.naming.directory.SearchResult(java.lang.String, java.lang.Object, javax.naming.directory.Attributes)

public SearchResult(String sample code for java.lang.String definition code for java.lang.String  name,
                    Object sample code for java.lang.Object definition code for java.lang.Object  obj,
                    Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes  attrs)
Constructs a search result using the result's name, its bound object, and its attributes.

getClassName() will return the class name of obj (or null if obj is null) unless the class name has been explicitly set using setClassName().

Parameters:
name - The non-null name of the search item. It is relative to the target context of the search (which is named by the first parameter of the search() method)
obj - The object bound to name. Can be null.
attrs - The attributes that were requested to be returned with this search item. Cannot be null.
See Also:
NameClassPair.setClassName(java.lang.String) sample code for javax.naming.NameClassPair.setClassName(java.lang.String) definition code for javax.naming.NameClassPair.setClassName(java.lang.String) , NameClassPair.getClassName() sample code for javax.naming.NameClassPair.getClassName() definition code for javax.naming.NameClassPair.getClassName()

SearchResult sample code for javax.naming.directory.SearchResult(java.lang.String, java.lang.Object, javax.naming.directory.Attributes, boolean) definition code for javax.naming.directory.SearchResult(java.lang.String, java.lang.Object, javax.naming.directory.Attributes, boolean)

public SearchResult(String sample code for java.lang.String definition code for java.lang.String  name,
                    Object sample code for java.lang.Object definition code for java.lang.Object  obj,
                    Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes  attrs,
                    boolean isRelative)
Constructs a search result using the result's name, its bound object, and its attributes, and whether the name is relative.

getClassName() will return the class name of obj (or null if obj is null) unless the class name has been explicitly set using setClassName()

Parameters:
name - The non-null name of the search item.
obj - The object bound to name. Can be null.
attrs - The attributes that were requested to be returned with this search item. Cannot be null.
isRelative - true if name is relative to the target context of the search (which is named by the first parameter of the search() method); false if name is a URL string.
See Also:
NameClassPair.setClassName(java.lang.String) sample code for javax.naming.NameClassPair.setClassName(java.lang.String) definition code for javax.naming.NameClassPair.setClassName(java.lang.String) , NameClassPair.getClassName() sample code for javax.naming.NameClassPair.getClassName() definition code for javax.naming.NameClassPair.getClassName()

SearchResult sample code for javax.naming.directory.SearchResult(java.lang.String, java.lang.String, java.lang.Object, javax.naming.directory.Attributes) definition code for javax.naming.directory.SearchResult(java.lang.String, java.lang.String, java.lang.Object, javax.naming.directory.Attributes)

public SearchResult(String sample code for java.lang.String definition code for java.lang.String  name,
                    String sample code for java.lang.String definition code for java.lang.String  className,
                    Object sample code for java.lang.Object definition code for java.lang.Object  obj,
                    Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes  attrs)
Constructs a search result using the result's name, its class name, its bound object, and its attributes.

Parameters:
name - The non-null name of the search item. It is relative to the target context of the search (which is named by the first parameter of the search() method)
className - The possibly null class name of the object bound to name. If null, the class name of obj is returned by getClassName(). If obj is also null, getClassName() will return null.
obj - The object bound to name. Can be null.
attrs - The attributes that were requested to be returned with this search item. Cannot be null.
See Also:
NameClassPair.setClassName(java.lang.String) sample code for javax.naming.NameClassPair.setClassName(java.lang.String) definition code for javax.naming.NameClassPair.setClassName(java.lang.String) , NameClassPair.getClassName() sample code for javax.naming.NameClassPair.getClassName() definition code for javax.naming.NameClassPair.getClassName()

SearchResult sample code for javax.naming.directory.SearchResult(java.lang.String, java.lang.String, java.lang.Object, javax.naming.directory.Attributes, boolean) definition code for javax.naming.directory.SearchResult(java.lang.String, java.lang.String, java.lang.Object, javax.naming.directory.Attributes, boolean)

public SearchResult(String sample code for java.lang.String definition code for java.lang.String  name,
                    String sample code for java.lang.String definition code for java.lang.String  className,
                    Object sample code for java.lang.Object definition code for java.lang.Object  obj,
                    Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes  attrs,
                    boolean isRelative)
Constructs a search result using the result's name, its class name, its bound object, its attributes, and whether the name is relative.

Parameters:
name - The non-null name of the search item.
className - The possibly null class name of the object bound to name. If null, the class name of obj is returned by getClassName(). If obj is also null, getClassName() will return null.
obj - The object bound to name. Can be null.
attrs - The attributes that were requested to be returned with this search item. Cannot be null.
isRelative - true if name is relative to the target context of the search (which is named by the first parameter of the search() method); false if name is a URL string.
See Also:
NameClassPair.setClassName(java.lang.String) sample code for javax.naming.NameClassPair.setClassName(java.lang.String) definition code for javax.naming.NameClassPair.setClassName(java.lang.String) , NameClassPair.getClassName() sample code for javax.naming.NameClassPair.getClassName() definition code for javax.naming.NameClassPair.getClassName()
Method Detail

getAttributes sample code for javax.naming.directory.SearchResult.getAttributes() definition code for javax.naming.directory.SearchResult.getAttributes()

public Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes  getAttributes()
Retrieves the attributes in this search result.

Returns:
The non-null attributes in this search result. Can be empty.
See Also:
setAttributes(javax.naming.directory.Attributes) sample code for javax.naming.directory.SearchResult.setAttributes(javax.naming.directory.Attributes) definition code for javax.naming.directory.SearchResult.setAttributes(javax.naming.directory.Attributes)

setAttributes sample code for javax.naming.directory.SearchResult.setAttributes(javax.naming.directory.Attributes) definition code for javax.naming.directory.SearchResult.setAttributes(javax.naming.directory.Attributes)

public void setAttributes(Attributes sample code for javax.naming.directory.Attributes definition code for javax.naming.directory.Attributes  attrs)
Sets the attributes of this search result to attrs.

Parameters:
attrs - The non-null attributes to use. Can be empty.
See Also:
getAttributes() sample code for javax.naming.directory.SearchResult.getAttributes() definition code for javax.naming.directory.SearchResult.getAttributes()

toString sample code for javax.naming.directory.SearchResult.toString() definition code for javax.naming.directory.SearchResult.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Generates the string representation of this SearchResult. The string representation consists of the string representation of the binding and the string representation of this search result's attributes, separated by ':'. The contents of this string is useful for debugging and is not meant to be interpreted programmatically.

Overrides:
toString sample code for javax.naming.Binding.toString() definition code for javax.naming.Binding.toString() in class Binding sample code for javax.naming.Binding definition code for javax.naming.Binding
Returns:
The string representation of this SearchResult. Cannot be null.