public LdapName(String name) throws InvalidNameException 
{
        unparsed = name;
        parse();
}

Constructs an LDAP name from the given distinguished name.

Parameters:

name - This is a non-null distinguished name formatted according to the rules defined in RFC 2253.

Throws:

InvalidNameException - if a syntax violation is detected.

Also see:

Rdn#escapeValue(Object value)

 public LdapName(List<Rdn> rdns) 
{
        // if (rdns instanceof ArrayList< Rdn >) {
        //      this.rdns = rdns.clone();
        // } else if (rdns instanceof List< Rdn >) {
        //      this.rdns = new ArrayList< Rdn >(rdns);
        // } else {
        //      throw IllegalArgumentException(
        //              "Invalid entries, list entries must be of type Rdn");
        //  }
        this.rdns = new ArrayList(rdns.size());
        for (int i = 0; i <  rdns.size(); i++) {
            Object obj = rdns.get(i);
            if (!(obj instanceof Rdn)) {
                throw new IllegalArgumentException("Entry:" + obj +
                        "  not a valid type;list entries must be of type Rdn");
            }
            this.rdns.add(obj);
        }
}

Constructs an LDAP name given its parsed RDN components.

The indexing of RDNs in the list follows the numbering of RDNs described in the class description.

Parameters:

rdns - The non-null list of Rdns forming this LDAP name.

 public Name add(String comp) throws InvalidNameException 
{
        return add(size(), comp);
}

Adds a single component to the end of this LDAP name.

 public Name add(Rdn comp) 
{
        return add(size(), comp);
}

Adds a single RDN to the end of this LDAP name.

 public Name add(int posn,
    String comp) throws InvalidNameException 
{
        Rdn rdn = (new Rfc2253Parser(comp)).parseRdn();
        rdns.add(posn, rdn);
        unparsed = null;        // no longer valid
        return this;
}

Adds a single component at a specified position within this LDAP name. Components of this LDAP name at or after the index (if any) of the new component are shifted up by one (away from index 0) to accommodate the new component.

 public Name add(int posn,
    Rdn comp) 
{
        if (comp == null) {
            throw new NullPointerException("Cannot set comp to null");
        }
        rdns.add(posn, comp);
        unparsed = null;        // no longer valid
        return this;
}

Adds a single RDN at a specified position within this LDAP name. RDNs of this LDAP name at or after the index (if any) of the new RDN are shifted up by one (away from index 0) to accommodate the new RDN.

 public Name addAll(Name suffix) throws InvalidNameException 
{
         return addAll(size(), suffix);
}

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

 public Name addAll(List<Rdn> suffixRdns) 
{
        return addAll(size(), suffixRdns);
}

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

 public Name addAll(int posn,
    Name suffix) throws InvalidNameException 
{
        unparsed = null;        // no longer valid
        if (suffix instanceof LdapName) {
            LdapName s = (LdapName) suffix;
            rdns.addAll(posn, s.rdns);
        } else {
            Enumeration comps = suffix.getAll();
            while (comps.hasMoreElements()) {
                rdns.add(posn++,
                    (new Rfc2253Parser((String) comps.nextElement()).
                    parseRdn()));
            }
        }
        return this;
}

Adds the components of a name -- in order -- at a specified position within this name. Components of this LDAP name at or after the index (if any) of the first new component are shifted up (away from index 0) to accomodate the new components.

 public Name addAll(int posn,
    List<Rdn> suffixRdns) 
{
        unparsed = null;
        for (int i = 0; i <  suffixRdns.size(); i++) {
            Object obj = suffixRdns.get(i);
            if (!(obj instanceof Rdn)) {
                throw new IllegalArgumentException("Entry:" + obj +
                "  not a valid type;suffix list entries must be of type Rdn");
            }
            rdns.add(i + posn, obj);
        }
        return this;
}

Adds the RDNs of a name -- in order -- at a specified position within this name. RDNs of this LDAP name at or after the index (if any) of the first new RDN are shifted up (away from index 0) to accomodate the new RDNs.

 public Object clone() 
{
        return new LdapName(unparsed, rdns, 0, rdns.size());
}

Generates a new copy of this name. Subsequent changes to the components of this name will not affect the new copy, and vice versa.

 public int compareTo(Object obj) 
{
        if (!(obj instanceof LdapName)) {
            throw new ClassCastException("The obj is not a LdapName");
        }
        // check possible shortcuts
        if (obj == this) {
            return 0;
        }
        LdapName that = (LdapName) obj;
        if (unparsed != null && unparsed.equalsIgnoreCase(
                        that.unparsed)) {
            return 0;
        }
        // Compare RDNs one by one, lexicographically.
        int minSize = Math.min(rdns.size(), that.rdns.size());
        for (int i = 0; i <  minSize; i++) {
            // Compare a single pair of RDNs.
            Rdn rdn1 = (Rdn)rdns.get(i);
            Rdn rdn2 = (Rdn)that.rdns.get(i);
            int diff = rdn1.compareTo(rdn2);
            if (diff != 0) {
                return diff;
            }
        }
        return (rdns.size() - that.rdns.size());        // longer DN wins
}

Compares this LdapName with the specified Object for order. Returns a negative integer, zero, or a positive integer as this Name is less than, equal to, or greater than the given Object.

If obj is null or not an instance of LdapName, ClassCastException is thrown.

Ordering of LDAP names follows the lexicographical rules for string comparison, with the extension that this applies to all the RDNs in the LDAP name. All the RDNs are lined up in their specified order and compared lexicographically. See Rdn.compareTo(Object obj) for RDN comparison rules.

If this LDAP name is lexicographically lesser than obj, a negative number is returned. If this LDAP name is lexicographically greater than obj, a positive number is returned.

 public boolean endsWith(Name n) 
{
        if (n == null) {
            return false;
        }
        int len1 = rdns.size();
        int len2 = n.size();
        return (len1  >= len2 &&
                matches(len1 - len2, len1, n));
}

Determines whether this LDAP name ends with a specified LDAP name suffix. A name n is a suffix if it is equal to getSuffix(size()-n.size())--in other words this LDAP name ends with 'n'. If n is null or not a RFC2253 formatted name as described in the class description, false is returned.

 public boolean endsWith(List<Rdn> rdns) 
{
        if (rdns == null) {
            return false;
        }
        int len1 = this.rdns.size();
        int len2 = rdns.size();
        return (len1  >= len2 &&
                doesListMatch(len1 - len2, len1, rdns));
}

Determines whether the specified RDN sequence forms a suffix of this LDAP name. Returns true if this LdapName is at least as long as rdns, and for every position p in the range [size() - rdns.size(), size()) the component getRdn(p) matches rdns.get(p). Returns false otherwise. If rdns is null, false is returned.

 public boolean equals(Object obj) 
{
        // check possible shortcuts
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof LdapName)) {
            return false;
        }
        LdapName that = (LdapName) obj;
        if (rdns.size() != that.rdns.size()) {
            return false;
        }
        if (unparsed != null && unparsed.equalsIgnoreCase(
                that.unparsed)) {
            return true;
        }
        // Compare RDNs one by one for equality
        for (int i = 0; i <  rdns.size(); i++) {
            // Compare a single pair of RDNs.
            Rdn rdn1 = (Rdn) rdns.get(i);
            Rdn rdn2 = (Rdn) that.rdns.get(i);
            if (!rdn1.equals(rdn2)) {
                return false;
            }
        }
        return true;
}

Determines whether two LDAP names are equal. If obj is null or not an LDAP name, false is returned.

Two LDAP names are equal if each RDN in one is equal to the corresponding RDN in the other. This implies both have the same number of RDNs, and each RDN's equals() test against the corresponding RDN in the other name returns true. See Rdn#equals(Object obj) for a definition of RDN equality.

 public String get(int posn) 
{
        return rdns.get(posn).toString();
}

Retrieves a component of this LDAP name as a string.

 public Enumeration<String> getAll() 
{
        final Iterator iter = rdns.iterator();
        return new Enumeration< String >() {
            public boolean hasMoreElements() {
                return iter.hasNext();
            }
            public String nextElement() {
                return iter.next().toString();
            }
        };
}

Retrieves the components of this name as an enumeration of strings. The effect of updates to this name on this enumeration is undefined. If the name has zero components, an empty (non-null) enumeration is returned. The order of the components returned by the enumeration is same as the order in which the components are numbered as described in the class description.

 public Name getPrefix(int posn) 
{
        try {
            return new LdapName(null, rdns, 0, posn);
        } catch (IllegalArgumentException e) {
            throw new IndexOutOfBoundsException(
                "Posn: " + posn + ", Size: "+ rdns.size());
        }
}

Creates a name whose components consist of a prefix of the components of this LDAP name. Subsequent changes to this name will not affect the name that is returned and vice versa.

 public Rdn getRdn(int posn) 
{
        return (Rdn) rdns.get(posn);
}

Retrieves an RDN of this LDAP name as an Rdn.

 public List<Rdn> getRdns() 
{
        return Collections.unmodifiableList(rdns);
}

Retrieves the list of relative distinguished names. The contents of the list are unmodifiable. The indexing of RDNs in the returned list follows the numbering of RDNs as described in the class description. If the name has zero components, an empty list is returned.

 public Name getSuffix(int posn) 
{
        try {
            return new LdapName(null, rdns, posn, rdns.size());
        } catch (IllegalArgumentException e) {
            throw new IndexOutOfBoundsException(
                "Posn: " + posn + ", Size: "+ rdns.size());
        }
}

Creates a name whose components consist of a suffix of the components in this LDAP name. Subsequent changes to this name do not affect the name that is returned and vice versa.

 public int hashCode() 
{
        // Sum up the hash codes of the components.
        int hash = 0;
        // For each RDN...
        for (int i = 0; i <  rdns.size(); i++) {
            Rdn rdn = (Rdn) rdns.get(i);
            hash += rdn.hashCode();
        }
        return hash;
}

Computes the hash code of this LDAP name. The hash code is the sum of the hash codes of individual RDNs of this name.

 public boolean isEmpty() 
{
        return rdns.isEmpty();
}

Determines whether this LDAP name is empty. An empty name is one with zero components.

 public Object remove(int posn) throws InvalidNameException 
{
        unparsed = null;        // no longer valid
        return rdns.remove(posn).toString();
}

Removes a component from this LDAP name. The component of this name at the specified position is removed. Components with indexes greater than this position (if any) are shifted down (toward index 0) by one.

 public int size() 
{
        return rdns.size();
}

Retrieves the number of components in this LDAP name.

 public boolean startsWith(Name n) 
{
        if (n == null) {
            return false;
        }
        int len1 = rdns.size();
        int len2 = n.size();
        return (len1  >= len2 &&
                matches(0, len2, n));
}

Determines whether this LDAP name starts with a specified LDAP name prefix. A name n is a prefix if it is equal to getPrefix(n.size())--in other words this LDAP name starts with 'n'. If n is null or not a RFC2253 formatted name as described in the class description, false is returned.

 public boolean startsWith(List<Rdn> rdns) 
{
        if (rdns == null) {
            return false;
        }
        int len1 = this.rdns.size();
        int len2 = rdns.size();
        return (len1  >= len2 &&
                doesListMatch(0, len2, rdns));
}

Determines whether the specified RDN sequence forms a prefix of this LDAP name. Returns true if this LdapName is at least as long as rdns, and for every position p in the range [0, rdns.size()) the component getRdn(p) matches rdns.get(p). Returns false otherwise. If rdns is null, false is returned.

 public String toString() 
{
        if (unparsed != null) {
            return unparsed;
        }
        StringBuilder builder = new StringBuilder();
        int size = rdns.size();
        if ((size - 1)  >= 0) {
            builder.append((Rdn) rdns.get(size - 1));
        }
        for (int next = size - 2; next  >= 0; next--) {
            builder.append(',');
            builder.append((Rdn) rdns.get(next));
        }
        unparsed = builder.toString();
        return unparsed;
}

Returns a string representation of this LDAP name in a format defined by RFC 2253 and described in the class description. If the name has zero components an empty string is returned.