src/java.naming/share/classes/javax/naming/Referenceable.java
author erikj
Tue, 12 Sep 2017 19:03:39 +0200
changeset 47216 71c04702a3d5
parent 25859 jdk/src/java.naming/share/classes/javax/naming/Referenceable.java@3317bb8137f4
permissions -rw-r--r--
8187443: Forest Consolidation: Move files to unified layout Reviewed-by: darcy, ihse
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1999, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.naming;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
  * This interface is implemented by an object that can provide a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
  * Reference to itself.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
  *<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
  * A Reference represents a way of recording address information about
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
  * objects which themselves are not directly bound to the naming system.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
  * Such objects can implement the Referenceable interface as a way
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
  * for programs that use that object to determine what its Reference is.
22974
4bf6c0d73bb8 4682009: Typo in javadocs in javax/naming
igerasim
parents: 5506
diff changeset
    36
  * For example, when binding an object, if an object implements the
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
  * Referenceable interface, getReference() can be invoked on the object to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
  * get its Reference to use for binding.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
  *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
  * @author Rosanna Lee
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
  * @author Scott Seligman
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
  * @author R. Vasudevan
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
  *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
  * @see Context#bind
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
  * @see javax.naming.spi.NamingManager#getObjectInstance
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
  * @see Reference
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
  * @since 1.3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
  */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
public interface Referenceable {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
      * Retrieves the Reference of this object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
      *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
      * @return The non-null Reference of this object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
      * @exception NamingException If a naming exception was encountered
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
      *         while retrieving the reference.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
      */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
    Reference getReference() throws NamingException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
}