javax.naming
Class Binding

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.naming.NameClassPair sample code for javax.naming.NameClassPair definition code for javax.naming.NameClassPair 
      extended by javax.naming.Binding
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable
Direct Known Subclasses:
SearchResult sample code for javax.naming.directory.SearchResult definition code for javax.naming.directory.SearchResult

public class Binding
extends NameClassPair sample code for javax.naming.NameClassPair definition code for javax.naming.NameClassPair

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.

Since:
1.3
See Also:
Serialized Form

Constructor Summary
Binding sample code for javax.naming.Binding.Binding(java.lang.String, java.lang.Object) definition code for javax.naming.Binding.Binding(java.lang.String, java.lang.Object) (String sample code for java.lang.String definition code for java.lang.String  name, Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Constructs an instance of a Binding given its name and object.
Binding sample code for javax.naming.Binding.Binding(java.lang.String, java.lang.Object, boolean) definition code for javax.naming.Binding.Binding(java.lang.String, java.lang.Object, boolean) (String sample code for java.lang.String definition code for java.lang.String  name, Object sample code for java.lang.Object definition code for java.lang.Object  obj, boolean isRelative)
          Constructs an instance of a Binding given its name, object, and whether the name is relative.
Binding sample code for javax.naming.Binding.Binding(java.lang.String, java.lang.String, java.lang.Object) definition code for javax.naming.Binding.Binding(java.lang.String, java.lang.String, java.lang.Object) (String sample code for java.lang.String definition code for java.lang.String  name, String sample code for java.lang.String definition code for java.lang.String  className, Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Constructs an instance of a Binding given its name, class name, and object.
Binding sample code for javax.naming.Binding.Binding(java.lang.String, java.lang.String, java.lang.Object, boolean) definition code for javax.naming.Binding.Binding(java.lang.String, java.lang.String, java.lang.Object, boolean) (String sample code for java.lang.String definition code for java.lang.String  name, String sample code for java.lang.String definition code for java.lang.String  className, Object sample code for java.lang.Object definition code for java.lang.Object  obj, boolean isRelative)
          Constructs an instance of a Binding given its name, class name, object, and whether the name is relative.
 
Method Summary
 String sample code for java.lang.String definition code for java.lang.String getClassName sample code for javax.naming.Binding.getClassName() definition code for javax.naming.Binding.getClassName() ()
          Retrieves the class name of the object bound to the name of this binding.
 Object sample code for java.lang.Object definition code for java.lang.Object getObject sample code for javax.naming.Binding.getObject() definition code for javax.naming.Binding.getObject() ()
          Retrieves the object bound to the name of this binding.
 void setObject sample code for javax.naming.Binding.setObject(java.lang.Object) definition code for javax.naming.Binding.setObject(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Sets the object associated with this binding.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for javax.naming.Binding.toString() definition code for javax.naming.Binding.toString() ()
          Generates the string representation of this binding.
 
Methods inherited from class javax.naming.NameClassPair sample code for javax.naming.NameClassPair definition code for javax.naming.NameClassPair
getName sample code for javax.naming.NameClassPair.getName() definition code for javax.naming.NameClassPair.getName() , getNameInNamespace sample code for javax.naming.NameClassPair.getNameInNamespace() definition code for javax.naming.NameClassPair.getNameInNamespace() , isRelative sample code for javax.naming.NameClassPair.isRelative() definition code for javax.naming.NameClassPair.isRelative() , setClassName sample code for javax.naming.NameClassPair.setClassName(java.lang.String) definition code for javax.naming.NameClassPair.setClassName(java.lang.String) , setName sample code for javax.naming.NameClassPair.setName(java.lang.String) definition code for javax.naming.NameClassPair.setName(java.lang.String) , setNameInNamespace sample code for javax.naming.NameClassPair.setNameInNamespace(java.lang.String) definition code for javax.naming.NameClassPair.setNameInNamespace(java.lang.String) , setRelative sample code for javax.naming.NameClassPair.setRelative(boolean) definition code for javax.naming.NameClassPair.setRelative(boolean)
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

Binding sample code for javax.naming.Binding(java.lang.String, java.lang.Object) definition code for javax.naming.Binding(java.lang.String, java.lang.Object)

public Binding(String sample code for java.lang.String definition code for java.lang.String  name,
               Object sample code for java.lang.Object definition code for java.lang.Object  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.
See Also:
NameClassPair.setClassName(java.lang.String) sample code for javax.naming.NameClassPair.setClassName(java.lang.String) definition code for javax.naming.NameClassPair.setClassName(java.lang.String)

Binding sample code for javax.naming.Binding(java.lang.String, java.lang.Object, boolean) definition code for javax.naming.Binding(java.lang.String, java.lang.Object, boolean)

public Binding(String sample code for java.lang.String definition code for java.lang.String  name,
               Object sample code for java.lang.Object definition code for java.lang.Object  obj,
               boolean isRelative)
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.
See Also:
NameClassPair.isRelative() sample code for javax.naming.NameClassPair.isRelative() definition code for javax.naming.NameClassPair.isRelative() , NameClassPair.setRelative(boolean) sample code for javax.naming.NameClassPair.setRelative(boolean) definition code for javax.naming.NameClassPair.setRelative(boolean) , NameClassPair.setClassName(java.lang.String) sample code for javax.naming.NameClassPair.setClassName(java.lang.String) definition code for javax.naming.NameClassPair.setClassName(java.lang.String)

Binding sample code for javax.naming.Binding(java.lang.String, java.lang.String, java.lang.Object) definition code for javax.naming.Binding(java.lang.String, java.lang.String, java.lang.Object)

public Binding(String sample code for java.lang.String definition code for java.lang.String  name,
               String sample code for java.lang.String definition code for java.lang.String  className,
               Object sample code for java.lang.Object definition code for java.lang.Object  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.
See Also:
NameClassPair.setClassName(java.lang.String) sample code for javax.naming.NameClassPair.setClassName(java.lang.String) definition code for javax.naming.NameClassPair.setClassName(java.lang.String)

Binding sample code for javax.naming.Binding(java.lang.String, java.lang.String, java.lang.Object, boolean) definition code for javax.naming.Binding(java.lang.String, java.lang.String, java.lang.Object, boolean)

public Binding(String sample code for java.lang.String definition code for java.lang.String  name,
               String sample code for java.lang.String definition code for java.lang.String  className,
               Object sample code for java.lang.Object definition code for java.lang.Object  obj,
               boolean isRelative)
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.
See Also:
NameClassPair.isRelative() sample code for javax.naming.NameClassPair.isRelative() definition code for javax.naming.NameClassPair.isRelative() , NameClassPair.setRelative(boolean) sample code for javax.naming.NameClassPair.setRelative(boolean) definition code for javax.naming.NameClassPair.setRelative(boolean) , NameClassPair.setClassName(java.lang.String) sample code for javax.naming.NameClassPair.setClassName(java.lang.String) definition code for javax.naming.NameClassPair.setClassName(java.lang.String)
Method Detail

getClassName sample code for javax.naming.Binding.getClassName() definition code for javax.naming.Binding.getClassName()

public String sample code for java.lang.String definition code for java.lang.String  getClassName()
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.

Overrides:
getClassName sample code for javax.naming.NameClassPair.getClassName() definition code for javax.naming.NameClassPair.getClassName() in class NameClassPair sample code for javax.naming.NameClassPair definition code for javax.naming.NameClassPair
Returns:
A possibly null string containing class name of object bound.
See Also:
getObject() sample code for javax.naming.Binding.getObject() definition code for javax.naming.Binding.getObject() , getClassName() sample code for javax.naming.Binding.getClassName() definition code for javax.naming.Binding.getClassName() , NameClassPair.setClassName(java.lang.String) sample code for javax.naming.NameClassPair.setClassName(java.lang.String) definition code for javax.naming.NameClassPair.setClassName(java.lang.String)

getObject sample code for javax.naming.Binding.getObject() definition code for javax.naming.Binding.getObject()

public Object sample code for java.lang.Object definition code for java.lang.Object  getObject()
Retrieves the object bound to the name of this binding.

Returns:
The object bound; null if this binding does not contain an object.
See Also:
setObject(java.lang.Object) sample code for javax.naming.Binding.setObject(java.lang.Object) definition code for javax.naming.Binding.setObject(java.lang.Object)

setObject sample code for javax.naming.Binding.setObject(java.lang.Object) definition code for javax.naming.Binding.setObject(java.lang.Object)

public void setObject(Object sample code for java.lang.Object definition code for java.lang.Object  obj)
Sets the object associated with this binding.

Parameters:
obj - The possibly null object to use.
See Also:
getObject() sample code for javax.naming.Binding.getObject() definition code for javax.naming.Binding.getObject()

toString sample code for javax.naming.Binding.toString() definition code for javax.naming.Binding.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
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.

Overrides:
toString sample code for javax.naming.NameClassPair.toString() definition code for javax.naming.NameClassPair.toString() in class NameClassPair sample code for javax.naming.NameClassPair definition code for javax.naming.NameClassPair
Returns:
The non-null string representation of this binding.