APIdia Launch Partner
Top Description Fields Constructors Methods
javax.naming

public Class Binding

extends NameClassPair
Class Inheritance
Known Direct Subclasses
javax.naming.directory.SearchResult, com.sun.jndi.ldap.BindingWithControls
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.

Authors
Rosanna Lee, Scott Seligman
Since
1.3

Field Summary

Modifier and TypeField and Description
private Object
boundObj

Contains this binding's object.

private static final long
serialVersionUID

Hides javax.naming.NameClassPair.serialVersionUID.

Use serialVersionUID from JNDI 1.1.1 for interoperability

Constructor Summary

AccessConstructor and Description
public
Binding(String
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)
name, Object
The possibly null object bound to name.
obj)

Constructs an instance of a Binding given its name and object.

public
Binding(String
The non-null string name of the object.
name, Object
The possibly null object bound to name.
obj, boolean
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.
isRelative)

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

public
Binding(String
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)
name, String
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.
className, Object
The possibly null object bound to name.
obj)

Constructs an instance of a Binding given its name, class name, and object.

public
Binding(String
The non-null string name of the object.
name, String
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.
className, Object
The possibly null object bound to name.
obj, boolean
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.
isRelative)

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

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

A possibly null string containing class name of object bound.
getClassName()

Overrides javax.naming.NameClassPair.getClassName.

Retrieves the class name of the object bound to the name of this binding.

public Object

Returns:

The object bound; null if this binding does not contain an object.
getObject()

Retrieves the object bound to the name of this binding.

public void
setObject(Object
The possibly null object to use.
obj)

Sets the object associated with this binding.

public String

Returns:

The non-null string representation of this binding.
toString()

Overrides javax.naming.NameClassPair.toString.

Generates the string representation of this binding.

Inherited from javax.naming.NameClassPair:
getNamegetNameInNamespaceisRelativesetClassNamesetNamesetNameInNamespacesetRelative

Field Detail

boundObjback to summary
private Object boundObj

Contains this binding's object. It is initialized by the constructor and can be updated using setObject.

Annotations
@SuppressWarnings:serial
See Also
getObject, setObject
serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.naming.NameClassPair.serialVersionUID.

Use serialVersionUID from JNDI 1.1.1 for interoperability

Constructor Detail

Bindingback to summary
public Binding(String name, 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:String

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:Object

The possibly null object bound to name.

See Also
NameClassPair#setClassName
Bindingback to summary
public Binding(String name, 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:String

The non-null string name of the object.

obj:Object

The possibly null object bound to name.

isRelative:boolean

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, NameClassPair#setRelative, NameClassPair#setClassName
Bindingback to summary
public Binding(String name, String className, Object obj)

Constructs an instance of a Binding given its name, class name, and object.

Parameters
name:String

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:String

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:Object

The possibly null object bound to name.

See Also
NameClassPair#setClassName
Bindingback to summary
public Binding(String name, String className, Object obj, boolean isRelative)

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

Parameters
name:String

The non-null string name of the object.

className:String

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:Object

The possibly null object bound to name.

isRelative:boolean

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, NameClassPair#setRelative, NameClassPair#setClassName

Method Detail

getClassNameback to summary
public String getClassName()

Overrides javax.naming.NameClassPair.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.

Returns:String

A possibly null string containing class name of object bound.

getObjectback to summary
public Object getObject()

Retrieves the object bound to the name of this binding.

Returns:Object

The object bound; null if this binding does not contain an object.

See Also
setObject
setObjectback to summary
public void setObject(Object obj)

Sets the object associated with this binding.

Parameters
obj:Object

The possibly null object to use.

See Also
getObject
toStringback to summary
public String toString()

Overrides javax.naming.NameClassPair.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.

Returns:String

The non-null string representation of this binding.