1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
/* * @(#)Binding.java 1.9 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.naming; /** * This class represents a name-to-object binding found in a context. *<p> * A context consists of name-to-object bindings. * The Binding class represents such a binding. It consists * of a name and an object. The <code>Context.listBindings()</code> * method returns an enumeration of Binding. *<p> * Use subclassing for naming systems that generate contents of * a binding dynamically. *<p> * A Binding instance is not synchronized against concurrent access by multiple * threads. Threads that need to access a Binding concurrently should * synchronize amongst themselves and provide the necessary locking. * * @author Rosanna Lee * @author Scott Seligman * @version 1.9 05/11/17 * @since 1.3 */ public class Binding extends NameClassPair { /** * Contains this binding's object. * It is initialized by the constuctor and can be updated using * <tt>setObject</tt>. * @serial * @see #getObject * @see #setObject */ private Object boundObj; /** * Constructs an instance of a Binding given its name and object. *<p> * <tt>getClassName()</tt> will return * the class name of <tt>obj</tt> (or null if <tt>obj</tt> is null) * unless the class name has been explicitly set using <tt>setClassName()</tt> * * @param name The non-null name of the object. It is relative * to the <em>target context</em> (which is * named by the first parameter of the <code>listBindings()</code> method) * @param obj The possibly null object bound to name. * @see NameClassPair#setClassName */ public Binding(String name, Object obj) { super(name, null); this.boundObj = obj; } /** * Constructs an instance of a Binding given its name, object, and whether * the name is relative. *<p> * <tt>getClassName()</tt> will return the class name of <tt>obj</tt> * (or null if <tt>obj</tt> is null) unless the class name has been * explicitly set using <tt>setClassName()</tt> * * @param name The non-null string name of the object. * @param obj The possibly null object bound to name. * @param isRelative true if <code>name</code> is a name relative * to the target context (which is named by * the first parameter of the <code>listBindings()</code> method); * false if <code>name</code> is a URL string. * @see NameClassPair#isRelative * @see NameClassPair#setRelative * @see NameClassPair#setClassName */ public Binding(String name, Object obj, boolean isRelative) { super(name, null, isRelative); this.boundObj = obj; } /** * Constructs an instance of a Binding given its name, class name, and object. * * @param name The non-null name of the object. It is relative * to the <em>target context</em> (which is * named by the first parameter of the <code>listBindings()</code> method) * @param className The possibly null class name of the object * bound to <tt>name</tt>. If null, the class name of <tt>obj</tt> is * returned by <tt>getClassName()</tt>. If <tt>obj</tt> is also * null, <tt>getClassName()</tt> will return null. * @param obj The possibly null object bound to name. * @see NameClassPair#setClassName */ public Binding(String name, String className, Object obj) { super(name, className); this.boundObj = obj; } /** * Constructs an instance of a Binding given its * name, class name, object, and whether the name is relative. * * @param name The non-null string name of the object. * @param className The possibly null class name of the object * bound to <tt>name</tt>. If null, the class name of <tt>obj</tt> is * returned by <tt>getClassName()</tt>. If <tt>obj</tt> is also * null, <tt>getClassName()</tt> will return null. * @param obj The possibly null object bound to name. * @param isRelative true if <code>name</code> is a name relative * to the target context (which is named by * the first parameter of the <code>listBindings()</code> method); * false if <code>name</code> is a URL string. * @see NameClassPair#isRelative * @see NameClassPair#setRelative * @see NameClassPair#setClassName */ public Binding(String name, String className, Object obj, boolean isRelative) { super(name, className, isRelative); this.boundObj = obj; } /** * Retrieves the class name of the object bound to the name of this binding. * If the class name has been set explicitly, return it. * Otherwise, if this binding contains a non-null object, * that object's class name is used. Otherwise, null is returned. * * @return A possibly null string containing class name of object bound. */ public String getClassName() { String cname = super.getClassName(); if (cname != null) { return cname; } if (boundObj != null) return boundObj.getClass().getName(); else return null; } /** * Retrieves the object bound to the name of this binding. * * @return The object bound; null if this binding does not contain an object. * @see #setObject */ public Object getObject() { return boundObj; } /** * Sets the object associated with this binding. * @param obj The possibly null object to use. * @see #getObject */ public void setObject(Object obj) { boundObj = obj; } /** * Generates the string representation of this binding. * The string representation consists of the string representation * of the name/class pair and the string representation of * this binding's object, separated by ':'. * The contents of this string is useful * for debugging and is not meant to be interpreted programmatically. * * @return The non-null string representation of this binding. */ public String toString() { return super.toString() + ":" + getObject(); } /** * Use serialVersionUID from JNDI 1.1.1 for interoperability */ private static final long serialVersionUID = 8839217842691845890L; };