APIdia Launch Partner
Top Description Fields Constructors Methods
javax.naming

public Class NameClassPair

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Known Direct Subclasses
com.sun.jndi.ldap.NameClassPairWithControls, javax.naming.Binding
This class represents the object name and class name pair of a binding found in a context.

A context consists of name-to-object bindings. The NameClassPair class represents the name and the class of the bound object. It consists of a name and a string representing the package-qualified class name.

Use subclassing for naming systems that generate contents of a name/class pair dynamically.

A NameClassPair instance is not synchronized against concurrent access by multiple threads. Threads that need to access a NameClassPair concurrently should synchronize amongst themselves and provide the necessary locking.

Authors
Rosanna Lee, Scott Seligman
Since
1.3
See Also
Context#list

Field Summary

Modifier and TypeField and Description
private String
className

Contains the class name contained in this NameClassPair.

private String
fullName

Contains the full name of this NameClassPair within its own namespace.

private boolean
isRel

Records whether the name of this NameClassPair is relative to the target context.

private String
name

Contains the name of this NameClassPair.

private static final long
serialVersionUID

Use serialVersionUID from JNDI 1.1.1 for interoperability

Constructor Summary

AccessConstructor and Description
public
NameClassPair(String
The non-null name of the object. It is relative to the target context (which is named by the first parameter of the list() method)
name, String
The possibly null class name of the object bound to name. It is null if the object bound is null.
className)

Constructs an instance of a NameClassPair given its name and class name.

public
NameClassPair(String
The non-null name of the object.
name, String
The possibly null class name of the object bound to name. It is null if the object bound is null.
className, boolean
true if name is a name relative to the target context (which is named by the first parameter of the list() method); false if name is a URL string.
isRelative)

Constructs an instance of a NameClassPair given its name, class name, and whether it is relative to the listing context.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The possibly null class name of object bound. It is null if the object bound is null.
getClassName()

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

public String

Returns:

The non-null name of this binding.
getName()

Retrieves the name of this binding.

public String

Returns:

The full name of this binding.
getNameInNamespace()

Retrieves the full name of this binding.

public boolean

Returns:

true if the name of this binding is relative to the target context; false if the name of this binding is a URL string.
isRelative()

Determines whether the name of this binding is relative to the target context (which is named by the first parameter of the list() method).

public void
setClassName(String
the possibly null string to use as the class name. If null, Binding.getClassName() will return the actual class name of the object in the binding. The class name will be null if the object bound is null.
name)

Sets the class name of this binding.

public void
setName(String
the non-null string to use as the name.
name)

Sets the name of this binding.

public void
setNameInNamespace(String
The full name to use.
fullName)

Sets the full name of this binding.

public void
setRelative(boolean
If true, the name of binding is relative to the target context; if false, the name of binding is a URL string.
r)

Sets whether the name of this binding is relative to the target context (which is named by the first parameter of the list() method).

public String

Returns:

The string representation of this name/class pair.
toString()

Overrides java.lang.Object.toString.

Generates the string representation of this name/class pair.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

classNameback to summary
private String className

Contains the class name contained in this NameClassPair. It is initialized by the constructor and can be updated using setClassName().

See Also
getClassName, setClassName
fullNameback to summary
private String fullName

Contains the full name of this NameClassPair within its own namespace. It is initialized using setNameInNamespace()

See Also
getNameInNamespace, setNameInNamespace
isRelback to summary
private boolean isRel

Records whether the name of this NameClassPair is relative to the target context. It is initialized by the constructor and can be updated using setRelative().

See Also
isRelative, setRelative, getName, setName
nameback to summary
private String name

Contains the name of this NameClassPair. It is initialized by the constructor and can be updated using setName().

See Also
getName, setName
serialVersionUIDback to summary
private static final long serialVersionUID

Use serialVersionUID from JNDI 1.1.1 for interoperability

Constructor Detail

NameClassPairback to summary
public NameClassPair(String name, String className)

Constructs an instance of a NameClassPair given its name and class name.

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 list() method)

className:String

The possibly null class name of the object bound to name. It is null if the object bound is null.

See Also
getClassName, setClassName, getName, setName
NameClassPairback to summary
public NameClassPair(String name, String className, boolean isRelative)

Constructs an instance of a NameClassPair given its name, class name, and whether it is relative to the listing context.

Parameters
name:String

The non-null name of the object.

className:String

The possibly null class name of the object bound to name. It is null if the object bound is null.

isRelative:boolean

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

See Also
getClassName, setClassName, getName, setName, isRelative, setRelative

Method Detail

getClassNameback to summary
public String getClassName()

Retrieves the class name of the object bound to the name of this binding. If a reference or some other indirect information is bound, retrieves the class name of the eventual object that will be returned by Binding.getObject().

Returns:String

The possibly null class name of object bound. It is null if the object bound is null.

See Also
Binding#getObject, Binding#getClassName, setClassName
getNameback to summary
public String getName()

Retrieves the name of this binding. If isRelative() is true, this name is relative to the target context (which is named by the first parameter of the list()). If isRelative() is false, this name is a URL string.

Returns:String

The non-null name of this binding.

See Also
isRelative, setName
getNameInNamespaceback to summary
public String getNameInNamespace()

Retrieves the full name of this binding. The full name is the absolute name of this binding within its own namespace. See Context#getNameInNamespace().

In naming systems for which the notion of full name does not apply to this binding an UnsupportedOperationException is thrown. This exception is also thrown when a service provider written before the introduction of the method is in use.

The string returned by this method is not a JNDI composite name and should not be passed directly to context methods.

Returns:String

The full name of this binding.

Exceptions
UnsupportedOperationException:
if the notion of full name does not apply to this binding in the naming system.
Since
1.5
See Also
setNameInNamespace, getName
isRelativeback to summary
public boolean isRelative()

Determines whether the name of this binding is relative to the target context (which is named by the first parameter of the list() method).

Returns:boolean

true if the name of this binding is relative to the target context; false if the name of this binding is a URL string.

See Also
setRelative, getName
setClassNameback to summary
public void setClassName(String name)

Sets the class name of this binding.

Parameters
name:String

the possibly null string to use as the class name. If null, Binding.getClassName() will return the actual class name of the object in the binding. The class name will be null if the object bound is null.

See Also
getClassName, Binding#getClassName
setNameback to summary
public void setName(String name)

Sets the name of this binding.

Parameters
name:String

the non-null string to use as the name.

See Also
getName, setRelative
setNameInNamespaceback to summary
public void setNameInNamespace(String fullName)

Sets the full name of this binding. This method must be called to set the full name whenever a NameClassPair is created and a full name is applicable to this binding.

Setting the full name to null, or not setting it at all, will cause getNameInNamespace() to throw an exception.

Parameters
fullName:String

The full name to use.

Since
1.5
See Also
getNameInNamespace, setName
setRelativeback to summary
public void setRelative(boolean r)

Sets whether the name of this binding is relative to the target context (which is named by the first parameter of the list() method).

Parameters
r:boolean

If true, the name of binding is relative to the target context; if false, the name of binding is a URL string.

See Also
isRelative, setName
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Generates the string representation of this name/class pair. The string representation consists of the name and class name separated by a colon (':'). The contents of this string is useful for debugging and is not meant to be interpreted programmatically.

Returns:String

The string representation of this name/class pair.