com.openmarket.directory

Interface IName

All Known Implementing Classes:

CSName, NameWrapper

public interface IName

Provides name methods for the dir tagsets.

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.
String	toString() Generates the string representation of this name.

Method Detail

add

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

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

Throws:

DirectoryException

add

IName add(ICS ics,
          String comp)
   throws DirectoryException

Adds a single component to the end of this name.

Throws:

DirectoryException

addAll

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.

Throws:

DirectoryException

addAll

IName addAll(ICS ics,
             IName suffix)
      throws DirectoryException

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

Throws:

DirectoryException

clone

Object clone()

Generates a new copy of this name.

compareTo

int compareTo(ICS ics,
              Object obj)
       throws DirectoryException

Compares this name with another name for order.

Throws:

DirectoryException

endsWith

boolean endsWith(ICS ics,
                 IName n)
          throws DirectoryException

Determines whether this name ends with a specified suffix.

Throws:

DirectoryException

get

String get(ICS ics,
           int posn)
    throws DirectoryException

Retrieves a component of this name.

Throws:

DirectoryException

getAll

Enumeration getAll(ICS ics)
            throws DirectoryException

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

Throws:

DirectoryException

getPrefix

IName getPrefix(ICS ics,
                int posn)
         throws DirectoryException

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

Throws:

DirectoryException

getSuffix

IName getSuffix(ICS ics,
                int posn)
         throws DirectoryException

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

Throws:

DirectoryException

isEmpty

boolean isEmpty(ICS ics)
         throws DirectoryException

Determines whether this name is empty.

Throws:

DirectoryException

remove

Object remove(ICS ics,
              int posn)
       throws DirectoryException

Removes a component from this name.

Throws:

DirectoryException

size

int size(ICS ics)
  throws DirectoryException

Returns the number of components in this name.

Throws:

DirectoryException

startsWith

boolean startsWith(ICS ics,
                   IName n)
            throws DirectoryException

Determines whether this name starts with a specified prefix.

Throws:

DirectoryException

toString

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.

Overrides:

toString in class Object

clean

String clean(ICS ics)
      throws DirectoryException

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

Throws:

DirectoryException