javax.naming: public class: Binding

javax.naming
public class: Binding [javadoc | source]

java.lang.Object
   javax.naming.NameClassPair
      javax.naming.Binding

All Implemented Interfaces:
Serializable

Direct Known Subclasses:
SearchResult

This class represents a name-to-object binding found in a context.

A context consists of name-to-object bindings. The Binding class represents such a binding. It consists of a name and an object. The Context.listBindings() method returns an enumeration of Binding.

Use subclassing for naming systems that generate contents of a binding dynamically.

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

since: 1.3 -

Constructor:

Constructor:
public Binding(String name, Object obj) { super(name, null); this.boundObj = obj; } Constructs an instance of a Binding given its name and object. `getClassName()` will return the class name of `obj` (or null if `obj` is null) unless the class name has been explicitly set using `setClassName()` Parameters: `name` - The non-null name of the object. It is relative to the target context (which is named by the first parameter of the `listBindings()` method) `obj` - The possibly null object bound to name. Also 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, object, and whether the name is relative. `getClassName()` will return the class name of `obj` (or null if `obj` is null) unless the class name has been explicitly set using `setClassName()` Parameters: `name` - The non-null string name of the object. `obj` - The possibly null object bound to name. `isRelative` - true if `name` is a name relative to the target context (which is named by the first parameter of the `listBindings()` method); false if `name` is a URL string. Also see: NameClassPair#isRelative NameClassPair#setRelative 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, and object. Parameters: `name` - The non-null name of the object. It is relative to the target context (which is named by the first parameter of the `listBindings()` method) `className` - The possibly null class name of the object bound to `name`. If null, the class name of `obj` is returned by `getClassName()`. If `obj` is also null, `getClassName()` will return null. `obj` - The possibly null object bound to name. Also see: NameClassPair#setClassName
public Binding(String name, String className, Object obj, boolean isRelative) { super(name, className, isRelative); this.boundObj = obj; } Constructs an instance of a Binding given its name, class name, object, and whether the name is relative. Parameters: `name` - The non-null string name of the object. `className` - The possibly null class name of the object bound to `name`. If null, the class name of `obj` is returned by `getClassName()`. If `obj` is also null, `getClassName()` will return null. `obj` - The possibly null object bound to name. `isRelative` - true if `name` is a name relative to the target context (which is named by the first parameter of the `listBindings()` method); false if `name` is a URL string. Also see: NameClassPair#isRelative NameClassPair#setRelative NameClassPair#setClassName

 public Binding(String name,
    Object obj) {
        super(name, null);
        this.boundObj = obj;
}

getClassName() will return the class name of obj (or null if obj is null) unless the class name has been explicitly set using setClassName()

Parameters:

name - The non-null name of the object. It is relative to the target context (which is named by the first parameter of the listBindings() method)

obj - The possibly null object bound to name.

Also see:

NameClassPair#setClassName

 public Binding(String name,
    Object obj,
    boolean isRelative) {
        super(name, null, isRelative);
        this.boundObj = obj;
}

getClassName() will return the class name of obj (or null if obj is null) unless the class name has been explicitly set using setClassName()

Parameters:

name - The non-null string name of the object.

obj - The possibly null object bound to name.

isRelative - true if name is a name relative to the target context (which is named by the first parameter of the listBindings() method); false if name is a URL string.

Also see:

NameClassPair#isRelative

NameClassPair#setRelative

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, and object.

Parameters:

name - The non-null name of the object. It is relative to the target context (which is named by the first parameter of the listBindings() method)

className - The possibly null class name of the object bound to name. If null, the class name of obj is returned by getClassName(). If obj is also null, getClassName() will return null.

obj - The possibly null object bound to name.

Also see:

NameClassPair#setClassName

 public Binding(String name,
    String className,
    Object obj,
    boolean isRelative) {
        super(name, className, isRelative);
        this.boundObj = obj;
}

Constructs an instance of a Binding given its name, class name, object, and whether the name is relative.

Parameters:

name - The non-null string name of the object.

className - The possibly null class name of the object bound to name. If null, the class name of obj is returned by getClassName(). If obj is also null, getClassName() will return null.

obj - The possibly null object bound to name.

isRelative - true if name is a name relative to the target context (which is named by the first parameter of the listBindings() method); false if name is a URL string.

Also see:

NameClassPair#isRelative

NameClassPair#setRelative

NameClassPair#setClassName

Method from javax.naming.Binding Summary:
getClassName, getObject, setObject, toString

Methods from javax.naming.NameClassPair:
getClassName, getName, getNameInNamespace, isRelative, setClassName, setName, setNameInNamespace, setRelative, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.naming.Binding Detail:
public String getClassName() { String cname = super.getClassName(); if (cname != null) { return cname; } if (boundObj != null) return boundObj.getClass().getName(); else return null; } 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.
public Object getObject() { return boundObj; } Retrieves the object bound to the name of this binding.
public void setObject(Object obj) { boundObj = obj; } Sets the object associated with this binding.
public String toString() { return super.toString() + ":" + getObject(); } 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.

Method from javax.naming.Binding Detail:

 public String getClassName() {
        String cname = super.getClassName();
        if (cname != null) {
            return cname;
        }
        if (boundObj != null)
            return boundObj.getClass().getName();
        else
            return null;
}

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.

 public Object getObject() {
        return boundObj;
}

Retrieves the object bound to the name of this binding.

 public  void setObject(Object obj) {
        boundObj = obj;
}

Sets the object associated with this binding.

 public String toString() {
        return super.toString() + ":" + getObject();
}

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.