naming/ldap/Rdn.java

55  * The Rdn class represents an RDN as attribute type/value mappings,
59  * of type and value when the Rdn consist of a single type/value pair,
67  * <code>Rdn</code> will properly parse all valid RDNs, but
76  * The following code example shows how to construct an Rdn using the
79  *      Rdn rdn = new Rdn("cn", "Juicy, Fruit");
91  *      Rdn rdn = new Rdn("cn=Juicy\\, Fruit");
97  * {@code Rdn} need not be synchronized.
106 public class Rdn implements Serializable, Comparable<Object> {
116      * Constructs an Rdn from the given attribute set. See
129     public Rdn(Attributes attrSet) throws InvalidNameException {
153      * Constructs an Rdn from the given string.
163     public Rdn(String rdnString) throws InvalidNameException {
169      * Constructs an Rdn from the given {@code rdn}.
171      * created Rdn.
172      * @param rdn The non-null Rdn to be copied.
174     public Rdn(Rdn rdn) {
180      * Constructs an Rdn from the given attribute type and
193     public Rdn(String type, Object value) throws InvalidNameException {
212     Rdn() {
217      * Adds the given attribute type and value to this Rdn.
225      * @return The updated Rdn, not a new one. Cannot be null.
228     Rdn put(String type, Object value) {
249      * Retrieves one of this Rdn's value.
264      * Retrieves one of this Rdn's type.
282      * Returns this Rdn as a string represented in a format defined by
286      * @return The string representation of the Rdn.
302      * Compares this Rdn with the specified Object for order.
304      * Rdn is less than, equal to, or greater than the given Object.
306      * If obj is null or not an instance of Rdn, ClassCastException
315      * @return  A negative integer, zero, or a positive integer as this Rdn
317      * @exception ClassCastException if obj is null or not a Rdn.
320         if (!(obj instanceof Rdn)) {
321             throw new ClassCastException("The obj is not a Rdn");
326         Rdn that = (Rdn) obj;
340      * Compares the specified Object with this Rdn for equality.
341      * Returns true if the given object is also a Rdn and the two Rdns
354      * If obj is null or not an instance of Rdn, false is returned.
356      * @param obj object to be compared for equality with this Rdn.
357      * @return true if the specified object is equal to this Rdn.
364         if (!(obj instanceof Rdn)) {
367         Rdn that = (Rdn) obj;
384      * @return An int representing the hash code of this Rdn.
401      * view of the type/value mappings contained in this Rdn.
404      *          mappings of this Rdn.
488      * Retrieves the number of attribute type/value pairs in this Rdn.
489      * @return The non-negative number of type/value pairs in this Rdn.