1. /*

  2.  * @(#)SearchResult.java	1.7 01/02/09

  3.  *

  4.  * Copyright 1999-2001 Sun Microsystems, Inc. All Rights Reserved.

  5.  * 

  6.  * This software is the proprietary information of Sun Microsystems, Inc.  

  7.  * Use is subject to license terms.

  8.  * 

  9.  */

  10. 

  11. package javax.naming.directory;

  12. 

  13. import javax.naming.Binding;

  14. 

  15. /**

  16.   * This class represents an item in the NamingEnumeration returned as a

  17.   * result of the DirContext.search() methods.

  18.   *<p>

  19.   * A SearchResult instance is not synchronized against concurrent 

  20.   * multithreaded access. Multiple threads trying to access and modify

  21.   * a single SearchResult instance should lock the object.

  22.   *

  23.   * @author Rosanna Lee

  24.   * @author Scott Seligman

  25.   * @version 1.7 01/02/09

  26.   *

  27.   * @see DirContext#search

  28.   * @since 1.3

  29.   */

  30. 

  31. public class SearchResult extends Binding {

  32.     /**

  33.      * Contains the attributes returned with the object.

  34.      * @serial

  35.      */

  36.     private Attributes attrs;

  37. 

  38.     /**

  39.       * Constructs a search result using the result's name, its bound object, and

  40.       * its attributes.

  41.       *<p>

  42.       * <tt>getClassName()</tt> will return the class name of <tt>obj</tt> 

  43.       * (or null if <tt>obj</tt> is null) unless the class name has been

  44.       * explicitly set using <tt>setClassName()</tt>. 

  45.       *

  46.       * @param name The non-null name of the search item. It is relative

  47.       *             to the <em>target context</em> of the search (which is 

  48.       * named by the first parameter of the <code>search()</code> method)

  49.       *

  50.       * @param obj  The object bound to name. Can be null.

  51.       * @param attrs The attributes that were requested to be returned with 

  52.       * this search item. Cannot be null.

  53.       * @see javax.naming.NameClassPair#setClassName

  54.       * @see javax.naming.NameClassPair#getClassName

  55.       */

  56.     public SearchResult(String name, Object obj, Attributes attrs) {

  57. 	super(name, obj);

  58. 	this.attrs = attrs;

  59.     }

  60. 

  61.     /**

  62.       * Constructs a search result using the result's name, its bound object, and

  63.       * its attributes, and whether the name is relative.

  64.       *<p>

  65.       * <tt>getClassName()</tt> will return the class name of <tt>obj</tt> 

  66.       * (or null if <tt>obj</tt> is null) unless the class name has been

  67.       * explicitly set using <tt>setClassName()</tt>

  68.       *

  69.       * @param name The non-null name of the search item.

  70.       * @param obj  The object bound to name. Can be null.

  71.       * @param attrs The attributes that were requested to be returned with 

  72.       * this search item. Cannot be null.

  73.       * @param isRelative true if <code>name</code> is relative

  74.       *		to the target context of the search (which is named by

  75.       *         the first parameter of the <code>search()</code> method);

  76.       *         false if <code>name</code> is a URL string.

  77.       * @see javax.naming.NameClassPair#setClassName

  78.       * @see javax.naming.NameClassPair#getClassName

  79.       */

  80.     public SearchResult(String name, Object obj, Attributes attrs, 

  81. 	boolean isRelative) {

  82. 	super(name, obj, isRelative);

  83. 	this.attrs = attrs;

  84.     }

  85. 

  86.     /**

  87.       * Constructs a search result using the result's name, its class name, 

  88.       * its bound object, and its attributes.

  89.       *

  90.       * @param name The non-null name of the search item. It is relative

  91.       *             to the <em>target context</em> of the search (which is 

  92.       * named by the first parameter of the <code>search()</code> method)

  93.       *

  94.       * @param	className	The possibly null class name of the object 

  95.       * 	bound to <tt>name</tt>. If null, the class name of <tt>obj</tt> is

  96.       *		returned by <tt>getClassName()</tt>. If <tt>obj</tt> is also null,

  97.       *		<tt>getClassName()</tt> will return null.

  98.       * @param obj  The object bound to name. Can be null.

  99.       * @param attrs The attributes that were requested to be returned with 

  100.       * this search item. Cannot be null.

  101.       * @see javax.naming.NameClassPair#setClassName

  102.       * @see javax.naming.NameClassPair#getClassName

  103.       */

  104.     public SearchResult(String name, String className, 

  105. 	Object obj, Attributes attrs) {

  106. 	super(name, className, obj);

  107. 	this.attrs = attrs;

  108.     }

  109. 

  110.     /**

  111.       * Constructs a search result using the result's name, its class name,

  112.       * its bound object, its attributes, and whether the name is relative.

  113.       *

  114.       * @param name The non-null name of the search item.

  115.       * @param	className	The possibly null class name of the object 

  116.       * 	bound to <tt>name</tt>. If null, the class name of <tt>obj</tt> is

  117.       *		returned by <tt>getClassName()</tt>. If <tt>obj</tt> is also null,

  118.       *		<tt>getClassName()</tt> will return null.

  119.       * @param obj  The object bound to name. Can be null.

  120.       * @param attrs The attributes that were requested to be returned with 

  121.       * this search item. Cannot be null.

  122.       * @param isRelative true if <code>name</code> is relative

  123.       *		to the target context of the search (which is named by

  124.       *         the first parameter of the <code>search()</code> method);

  125.       *         false if <code>name</code> is a URL string.

  126.       * @see javax.naming.NameClassPair#setClassName

  127.       * @see javax.naming.NameClassPair#getClassName

  128.       */

  129.     public SearchResult(String name, String className, Object obj, 

  130. 	Attributes attrs, boolean isRelative) {

  131. 	super(name, className, obj, isRelative);

  132. 	this.attrs = attrs;

  133.     }

  134. 

  135.     /**

  136.      * Retrieves the attributes in this search result.

  137.      *

  138.      * @return The non-null attributes in this search result. Can be empty.

  139.      * @see #setAttributes

  140.      */

  141.     public Attributes getAttributes() {

  142. 	return attrs;

  143.     }

  144. 

  145. 

  146.     /**

  147.      * Sets the attributes of this search result to <code>attrs</code>.

  148.      * @param attrs The non-null attributes to use. Can be empty.

  149.      * @see #getAttributes

  150.      */

  151.     public void setAttributes(Attributes attrs) {

  152. 	this.attrs = attrs;

  153. 	// ??? check for null?

  154.     }

  155. 

  156. 

  157.     /**

  158.       * Generates the string representation of this SearchResult.

  159.       * The string representation consists of the string representation

  160.       * of the binding and the string representation of

  161.       * this search result's attributes, separated by ':'.

  162.       * The contents of this string is useful

  163.       * for debugging and is not meant to be interpreted programmatically.

  164.       *

  165.       * @return The string representation of this SearchResult. Cannot be null.

  166.       */

  167.     public String toString() {

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

  169.     }

  170. 

  171.     /**

  172.      * Use serialVersionUID from JNDI 1.1.1 for interoperability

  173.      */

  174.     private static final long serialVersionUID = -9158063327699723172L;

  175. }