com.openmarket.directory.jndi

Class NameWrapper

java.lang.Object

com.openmarket.directory.jndi.NameWrapper

All Implemented Interfaces:

IName, Serializable, Cloneable

Direct Known Subclasses:

CSName

public class NameWrapper
extends Object
implements Cloneable, Serializable, IName

This is essentially a wrapper around the JNDI Name class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Name	m_impl

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NameWrapper(ICS ics, Class[] argTypes, Object[] args) Ultimately, all constructors call this class to instantiate the Name implementation class from the classname specified in the property file.
	NameWrapper(ICS ics, String name) Constructs a new instance of a name.
	NameWrapper(ICS ics, String name, Properties syntax) Constructs a new instance of a name.
protected	NameWrapper(Name name)

Method Summary

Modifier and Type	Method and Description
IName	add(ICS ics, int posn, String comp) Adds a single component at a specified position within this name.
IName	add(ICS ics, String comp) Adds a single component to the end of this name.
IName	addAll(ICS ics, IName suffix) Adds the components of a name -- in order -- to the end of this name.
IName	addAll(ICS ics, int posn, IName n) Adds the components of a name -- in order -- at a specified position within this name.
String	clean(ICS ics) Return a "clean" string representation for this IName with all whitespace trimmed between components.
Object	clone() Generates a new copy of this name.
int	compareTo(ICS ics, Object obj) Compares this name with another name for order.
boolean	endsWith(ICS ics, IName n) Determines whether this name ends with a specified suffix.
String	get(ICS ics, int posn) Retrieves a component of this name.
Enumeration	getAll(ICS ics) Retrieves the components of this name as an enumeration of strings.
IName	getPrefix(ICS ics, int posn) Creates a name whose components consist of a prefix of the components of this name.
IName	getSuffix(ICS ics, int posn) Creates a name whose components consist of a suffix of the components in this name.
boolean	isEmpty(ICS ics) Determines whether this name is empty.
Object	remove(ICS ics, int posn) Removes a component from this name.
int	size(ICS ics) Returns the number of components in this name.
boolean	startsWith(ICS ics, IName n) Determines whether this name starts with a specified prefix.
protected static Name	toJNDIName(ICS ics, IName name) Convert the specified class.
String	toString() Generates the string representation of this name.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_impl

protected Name m_impl

Constructor Detail

NameWrapper

protected NameWrapper(Name name)

NameWrapper

protected NameWrapper(ICS ics,
                      Class[] argTypes,
                      Object[] args)
               throws DirectoryException

Ultimately, all constructors call this class to instantiate the Name implementation class from the classname specified in the property file.

Throws:

DirectoryException

NameWrapper

public NameWrapper(ICS ics,
                   String name,
                   Properties syntax)
            throws DirectoryException

Constructs a new instance of a name.

Parameters:

name - The fully qualified name, following the syntax put forth in the dir.ini file. It cannot be null.

Throws:

DirectoryException

NameWrapper

public NameWrapper(ICS ics,
                   String name)
            throws DirectoryException

Constructs a new instance of a name. Syntax is read from the dir.ini file.

Parameters:

name - The fully qualified name, following the syntax put forth in the dir.ini file. It cannot be null.

Throws:

DirectoryException

Method Detail

toJNDIName

protected static Name toJNDIName(ICS ics,
                                 IName name)
                          throws DirectoryException

Convert the specified class.

Throws:

DirectoryException

add

public IName add(ICS ics,
                 int posn,
                 String comp)
          throws DirectoryException

Adds a single component at a specified position within this name.

Specified by:

add in interface IName

Throws:

DirectoryException

add

public IName add(ICS ics,
                 String comp)
          throws DirectoryException

Adds a single component to the end of this name.

Specified by:

add in interface IName

Throws:

DirectoryException

addAll

public IName addAll(ICS ics,
                    int posn,
                    IName n)
             throws DirectoryException

Adds the components of a name -- in order -- at a specified position within this name.

Specified by:

addAll in interface IName

Throws:

DirectoryException

addAll

public IName addAll(ICS ics,
                    IName suffix)
             throws DirectoryException

Adds the components of a name -- in order -- to the end of this name.

Specified by:

addAll in interface IName

Throws:

DirectoryException

clone

public Object clone()

Generates a new copy of this name.

Specified by:

clone in interface IName

Overrides:

clone in class Object

compareTo

public int compareTo(ICS ics,
                     Object obj)
              throws DirectoryException

Compares this name with another name for order.

Specified by:

compareTo in interface IName

Throws:

DirectoryException

endsWith

public boolean endsWith(ICS ics,
                        IName n)
                 throws DirectoryException

Determines whether this name ends with a specified suffix.

Specified by:

endsWith in interface IName

Throws:

DirectoryException

get

public String get(ICS ics,
                  int posn)
           throws DirectoryException

Retrieves a component of this name.

Specified by:

get in interface IName

Throws:

DirectoryException

getAll

public Enumeration getAll(ICS ics)
                   throws DirectoryException

Retrieves the components of this name as an enumeration of strings.

Specified by:

getAll in interface IName

Throws:

DirectoryException

getPrefix

public IName getPrefix(ICS ics,
                       int posn)
                throws DirectoryException

Creates a name whose components consist of a prefix of the components of this name.

Specified by:

getPrefix in interface IName

Throws:

DirectoryException

getSuffix

public IName getSuffix(ICS ics,
                       int posn)
                throws DirectoryException

Creates a name whose components consist of a suffix of the components in this name.

Specified by:

getSuffix in interface IName

Throws:

DirectoryException

isEmpty

public boolean isEmpty(ICS ics)
                throws DirectoryException

Determines whether this name is empty.

Specified by:

isEmpty in interface IName

Throws:

DirectoryException

remove

public Object remove(ICS ics,
                     int posn)
              throws DirectoryException

Removes a component from this name.

Specified by:

remove in interface IName

Throws:

DirectoryException

size

public int size(ICS ics)
         throws DirectoryException

Returns the number of components in this name.

Specified by:

size in interface IName

Throws:

DirectoryException

startsWith

public boolean startsWith(ICS ics,
                          IName n)
                   throws DirectoryException

Determines whether this name starts with a specified prefix.

Specified by:

startsWith in interface IName

Throws:

DirectoryException

toString

public String toString()

Generates the string representation of this name. The string representation consists of enumerating in order each element of the name and composing a string based upon the syntax rules. Quoting and escape characters are applied where necessary according to the syntax of the implementing class, which should be described in the class description. An empty component is represented by an empty string.

Specified by:

toString in interface IName

Overrides:

toString in class Object

clean

public String clean(ICS ics)
             throws DirectoryException

Return a "clean" string representation for this IName with all whitespace trimmed between components.

Specified by:

clean in interface IName

Throws:

DirectoryException