All Packages Class Hierarchy This Package Previous Next Index
Class javax.naming.directory.SearchResult
java.lang.Object
|
+----javax.naming.NameClassPair
|
+----javax.naming.Binding
|
+----javax.naming.directory.SearchResult
- public class SearchResult
- extends Binding
A SearchResult is 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.
The serialized form of a SearchResult object consists of the same
fields as the serialized form of a Binding object, followed by the
Attributes of the search result.
- See Also:
- search
-
SearchResult(String, Object, Attributes)
- Constructs a search result using the result's name, its bound object, and
its attributes.
-
SearchResult(String, Object, Attributes, boolean)
- Constructs a search result using the result's name, its bound object, and
its attributes, and whether the name is relative.
-
getAttributes()
- Retrieves the attributes in this search result.
-
setAttributes(Attributes)
- Sets the attributes of this search result to
attrs
.
-
toString()
- Generates the string representation of this binding.
SearchResult
public SearchResult(String name,
Object obj,
Attributes attrs)
- Constructs a search result using the result's 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)
- 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.
SearchResult
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.
- 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.
getAttributes
public Attributes getAttributes()
- Retrieves the attributes in this search result.
- Returns:
- The non-null attributes in this search result. Can be empty.
setAttributes
public void setAttributes(Attributes attrs)
- Sets the attributes of this search result to
attrs
.
- Parameters:
- attrs - The non-null attributes to use. Can be empty
toString
public String toString()
- Generates the string representation of this binding.
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.
- Returns:
- The string representation of this binding. Cannot be null.
- Overrides:
- toString in class Binding
All Packages Class Hierarchy This Package Previous Next Index