KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > naming > Referenceable


1 /*
2  * @(#)Referenceable.java 1.7 03/12/19
3  *
4  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */

7
8 package javax.naming;
9
10 /**
11   * This interface is implemented by an object that can provide a
12   * Reference to itself.
13   *<p>
14   * A Reference represents a way of recording address information about
15   * objects which themselves are not directly bound to the naming system.
16   * Such objects can implement the Referenceable interface as a way
17   * for programs that use that object to determine what its Reference is.
18   * For example, when binding a object, if an object implements the
19   * Referenceable interface, getReference() can be invoked on the object to
20   * get its Reference to use for binding.
21   *
22   * @author Rosanna Lee
23   * @author Scott Seligman
24   * @author R. Vasudevan
25   * @version 1.7 03/12/19
26   *
27   * @see Context#bind
28   * @see javax.naming.spi.NamingManager#getObjectInstance
29   * @see Reference
30   * @since 1.3
31   */

32 public interface Referenceable {
33     /**
34       * Retrieves the Reference of this object.
35       *
36       * @return The non-null Reference of this object.
37       * @exception NamingException If a naming exception was encountered
38       * while retrieving the reference.
39       */

40     Reference JavaDoc getReference() throws NamingException JavaDoc;
41 }
42
Popular Tags