Class LDAPAttributeSet

  • All Implemented Interfaces:
    java.io.Serializable

    @NotExtensible
    @Mutable
    @ThreadSafety(level=NOT_THREADSAFE)
    public class LDAPAttributeSet
    extends java.lang.Object
    implements java.io.Serializable
    This class provides a data structure that contains a set of LDAP attribute objects.

    This class is primarily intended to be used in the process of updating applications which use the Netscape Directory SDK for Java to switch to or coexist with the UnboundID LDAP SDK for Java. For applications not written using the Netscape Directory SDK for Java, arrays or collections of Attribute objects should be used instead.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      LDAPAttributeSet()
      Creates a new LDAP attribute set with no attributes.
      LDAPAttributeSet​(LDAPAttribute[] attrs)
      Creates a new LDAP attribute set with the provided attributes.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(LDAPAttribute attr)
      Adds the provided attribute to this attribute set.
      LDAPAttributeSet duplicate()
      Creates a duplicate of this attribute set.
      LDAPAttribute elementAt​(int index)
      Retrieves the attribute at the specified position in this attribute set.
      LDAPAttribute getAttribute​(java.lang.String attrName)
      Retrieves the attribute from this set whose name exactly matches the provided name.
      LDAPAttribute getAttribute​(java.lang.String attrName, java.lang.String lang)
      Retrieves the attribute with the specified base name and the specified language subtype.
      java.util.Enumeration<LDAPAttribute> getAttributes()
      Retrieves an enumeration of the attributes in this set.
      LDAPAttributeSet getSubset​(java.lang.String subtype)
      Retrieves a subset of the attributes in this attribute set which contain the specified subtype.
      void remove​(java.lang.String name)
      Removes the attribute with the specified name.
      void removeElementAt​(int index)
      Removes the attribute at the specified position in this attribute set.
      int size()
      Retrieves the number of attributes contained in this attribute set.
      java.lang.String toString()
      Retrieves a string representation of this attribute set.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • LDAPAttributeSet

        public LDAPAttributeSet()
        Creates a new LDAP attribute set with no attributes.
      • LDAPAttributeSet

        public LDAPAttributeSet​(LDAPAttribute[] attrs)
        Creates a new LDAP attribute set with the provided attributes.
        Parameters:
        attrs - The set of attributes to include in the set.
    • Method Detail

      • getAttributes

        public java.util.Enumeration<LDAPAttributegetAttributes()
        Retrieves an enumeration of the attributes in this set.
        Returns:
        An enumeration of the attributes in this set.
      • getSubset

        public LDAPAttributeSet getSubset​(java.lang.String subtype)
        Retrieves a subset of the attributes in this attribute set which contain the specified subtype.
        Parameters:
        subtype - The subtype for which to retrieve all of the attributes.
        Returns:
        A new attribute set with all attributes from this set containing the specified subtype.
      • getAttribute

        public LDAPAttribute getAttribute​(java.lang.String attrName)
        Retrieves the attribute from this set whose name exactly matches the provided name.
        Parameters:
        attrName - The name of the attribute to retrieve.
        Returns:
        The requested attribute, or null if there is no such attribute in this set.
      • getAttribute

        public LDAPAttribute getAttribute​(java.lang.String attrName,
                                          java.lang.String lang)
        Retrieves the attribute with the specified base name and the specified language subtype.
        Parameters:
        attrName - The base name for the attribute to retrieve.
        lang - The language subtype to retrieve, or null if there should not be a language subtype.
        Returns:
        The attribute with the specified base name and language subtype, or null if there is no such attribute.
      • elementAt

        public LDAPAttribute elementAt​(int index)
                                throws java.lang.IndexOutOfBoundsException
        Retrieves the attribute at the specified position in this attribute set.
        Parameters:
        index - The position of the attribute to retrieve.
        Returns:
        The attribute at the specified position.
        Throws:
        java.lang.IndexOutOfBoundsException - If the provided index invalid.
      • add

        public void add​(LDAPAttribute attr)
        Adds the provided attribute to this attribute set.
        Parameters:
        attr - The attribute to be added to this set.
      • remove

        public void remove​(java.lang.String name)
        Removes the attribute with the specified name.
        Parameters:
        name - The name of the attribute to remove.
      • removeElementAt

        public void removeElementAt​(int index)
                             throws java.lang.IndexOutOfBoundsException
        Removes the attribute at the specified position in this attribute set.
        Parameters:
        index - The position of the attribute to remove.
        Throws:
        java.lang.IndexOutOfBoundsException - If the provided index is invalid.
      • size

        public int size()
        Retrieves the number of attributes contained in this attribute set.
        Returns:
        The number of attributes contained in this attribute set.
      • duplicate

        public LDAPAttributeSet duplicate()
        Creates a duplicate of this attribute set.
        Returns:
        A duplicate of this attribute set.
      • toString

        public java.lang.String toString()
        Retrieves a string representation of this attribute set.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this attribute set.