| |
|
| java.lang.Object javax.naming.NameClassPair
All known Subclasses: javax.naming.Binding,
NameClassPair | public class NameClassPair implements java.io.Serializable(Code) | | 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.
author: Rosanna Lee author: Scott Seligman version: 1.17 07/05/05 See Also: Context.list since: 1.3 |
Constructor Summary | |
public | NameClassPair(String name, String className) Constructs an instance of a NameClassPair given its
name and class name.
Parameters: name - The non-null name of the object. | 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 - The non-null name of the object. Parameters: className - The possibly null class name of the objectbound to name. |
Method Summary | |
public String | getClassName() Retrieves the class name of the object bound to the name of this binding. | public String | getName() Retrieves the name of this binding. | public String | getNameInNamespace() Retrieves the full name of this binding.
The full name is the absolute name of this binding within
its own namespace. | 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). | public void | setClassName(String name) Sets the class name of this binding. | public void | setName(String name) Sets the name of this binding. | public void | setNameInNamespace(String fullName) Sets the full name of this binding. | 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). | public String | toString() Generates the string representation of this name/class pair. |
getClassName | public String getClassName()(Code) | | 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().
The possibly null class name of object bound.It is null if the object bound is null. See Also: Binding.getObject See Also: Binding.getClassName See Also: NameClassPair.setClassName |
getName | public String getName()(Code) | | 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.
The non-null name of this binding. See Also: NameClassPair.isRelative See Also: NameClassPair.setName |
getNameInNamespace | public String getNameInNamespace()(Code) | | 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.
The full name of this binding. throws: UnsupportedOperationException - if the notion of full namedoes not apply to this binding in the naming system. since: 1.5 See Also: NameClassPair.setNameInNamespace See Also: NameClassPair.getName |
isRelative | public boolean isRelative()(Code) | | Determines whether the name of this binding is
relative to the target context (which is named by
the first parameter of the list() method).
true if the name of this binding is relative to thetarget context;false if the name of this binding is a URL string. See Also: NameClassPair.setRelative See Also: NameClassPair.getName |
setClassName | public void setClassName(String name)(Code) | | Sets the class name of this binding.
Parameters: name - the possibly null string to use as the class name.If null, Binding.getClassName() will returnthe actual class name of the object in the binding.The class name will be null if the object bound is null. See Also: NameClassPair.getClassName See Also: Binding.getClassName |
setNameInNamespace | public void setNameInNamespace(String fullName)(Code) | | 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 - The full name to use. since: 1.5 See Also: NameClassPair.getNameInNamespace See Also: NameClassPair.setName |
setRelative | public void setRelative(boolean r)(Code) | | 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 - If true, the name of binding is relative to the target context;if false, the name of binding is a URL string. See Also: NameClassPair.isRelative See Also: NameClassPair.setName |
toString | public String toString()(Code) | | 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.
The string representation of this name/class pair. |
|
|
|