FileDocCategorySizeDatePackage
SearchResult.javaAPI DocJava SE 6 API6540Tue Jun 10 00:26:20 BST 2008javax.naming.directory

SearchResult

public class SearchResult extends 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.

author
Rosanna Lee
author
Scott Seligman
version
1.10 05/11/17
see
DirContext#search
since
1.3

Fields Summary
private Attributes
attrs
Contains the attributes returned with the object.
private static final long
serialVersionUID
Use serialVersionUID from JNDI 1.1.1 for interoperability
Constructors Summary
public SearchResult(String name, Object obj, 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().

param
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)
param
obj The object bound to name. Can be null.
param
attrs The attributes that were requested to be returned with this search item. Cannot be null.
see
javax.naming.NameClassPair#setClassName
see
javax.naming.NameClassPair#getClassName

	super(name, obj);
	this.attrs = attrs;
    
public SearchResult(String name, Object obj, 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()

param
name The non-null name of the search item.
param
obj The object bound to name. Can be null.
param
attrs The attributes that were requested to be returned with this search item. Cannot be null.
param
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
javax.naming.NameClassPair#setClassName
see
javax.naming.NameClassPair#getClassName

	super(name, obj, isRelative);
	this.attrs = attrs;
    
public SearchResult(String name, String className, Object obj, Attributes attrs)
Constructs a search result using the result's name, its class name, its bound object, and its attributes.

param
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)
param
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.
param
obj The object bound to name. Can be null.
param
attrs The attributes that were requested to be returned with this search item. Cannot be null.
see
javax.naming.NameClassPair#setClassName
see
javax.naming.NameClassPair#getClassName

	super(name, className, obj);
	this.attrs = attrs;
    
public SearchResult(String name, String className, Object obj, 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.

param
name The non-null name of the search item.
param
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.
param
obj The object bound to name. Can be null.
param
attrs The attributes that were requested to be returned with this search item. Cannot be null.
param
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
javax.naming.NameClassPair#setClassName
see
javax.naming.NameClassPair#getClassName

	super(name, className, obj, isRelative);
	this.attrs = attrs;
    
Methods Summary
public javax.naming.directory.AttributesgetAttributes()
Retrieves the attributes in this search result.

return
The non-null attributes in this search result. Can be empty.
see
#setAttributes

	return attrs;
    
public voidsetAttributes(javax.naming.directory.Attributes attrs)
Sets the attributes of this search result to attrs.

param
attrs The non-null attributes to use. Can be empty.
see
#getAttributes

	this.attrs = attrs;
	// ??? check for null?
    
public java.lang.StringtoString()
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.

return
The string representation of this SearchResult. Cannot be null.

	return super.toString() + ":" + getAttributes();