Liking cljdoc? Tell your friends :D

javax.naming.directory.Attributes

This interface represents a collection of attributes.

In a directory, named objects can have associated with them attributes. The Attributes interface represents a collection of attributes. For example, you can request from the directory the attributes associated with an object. Those attributes are returned in an object that implements the Attributes interface.

Attributes in an object that implements the Attributes interface are unordered. The object can have zero or more attributes. Attributes is either case-sensitive or case-insensitive (case-ignore). This property is determined at the time the Attributes object is created. (see BasicAttributes constructor for example). In a case-insensitive Attributes, the case of its attribute identifiers is ignored when searching for an attribute, or adding attributes. In a case-sensitive Attributes, the case is significant.

Note that updates to Attributes (such as adding or removing an attribute) do not affect the corresponding representation in the directory. Updates to the directory can only be effected using operations in the DirContext interface.

This interface represents a collection of attributes.

In a directory, named objects can have associated with them
attributes.  The Attributes interface represents a collection of attributes.
For example, you can request from the directory the attributes
associated with an object.  Those attributes are returned in
an object that implements the Attributes interface.

Attributes in an object that implements the  Attributes interface are
unordered. The object can have zero or more attributes.
Attributes is either case-sensitive or case-insensitive (case-ignore).
This property is determined at the time the Attributes object is
created. (see BasicAttributes constructor for example).
In a case-insensitive Attributes, the case of its attribute identifiers
is ignored when searching for an attribute, or adding attributes.
In a case-sensitive Attributes, the case is significant.

Note that updates to Attributes (such as adding or removing an attribute)
do not affect the corresponding representation in the directory.
Updates to the directory can only be effected
using operations in the DirContext interface.
raw docstring

case-ignored?clj

(case-ignored? this)

Determines whether the attribute set ignores the case of attribute identifiers when retrieving or adding attributes.

returns: true if case is ignored; false otherwise. - boolean

Determines whether the attribute set ignores the case of
 attribute identifiers when retrieving or adding attributes.

returns: true if case is ignored; false otherwise. - `boolean`
raw docstring

cloneclj

(clone this)

Makes a copy of the attribute set. The new set contains the same attributes as the original set: the attributes are not themselves cloned. Changes to the copy will not affect the original and vice versa.

returns: A non-null copy of this attribute set. - java.lang.Object

Makes a copy of the attribute set.
 The new set contains the same attributes as the original set:
 the attributes are not themselves cloned.
 Changes to the copy will not affect the original and vice versa.

returns: A non-null copy of this attribute set. - `java.lang.Object`
raw docstring

getclj

(get this attr-id)

Retrieves the attribute with the given attribute id from the attribute set.

attr-id - The non-null id of the attribute to retrieve. If this attribute set ignores the character case of its attribute ids, the case of attrID is ignored. - java.lang.String

returns: The attribute identified by attrID; null if not found. - javax.naming.directory.Attribute

Retrieves the attribute with the given attribute id from the
 attribute set.

attr-id - The non-null id of the attribute to retrieve. If this attribute set ignores the character case of its attribute ids, the case of attrID is ignored. - `java.lang.String`

returns: The attribute identified by attrID; null if not found. - `javax.naming.directory.Attribute`
raw docstring

get-allclj

(get-all this)

Retrieves an enumeration of the attributes in the attribute set. The effects of updates to this attribute set on this enumeration are undefined.

returns: A non-null enumeration of the attributes in this attribute set. Each element of the enumeration is of class Attribute. If attribute set has zero attributes, an empty enumeration is returned. - javax.naming.NamingEnumeration<? extends javax.naming.directory.Attribute>

Retrieves an enumeration of the attributes in the attribute set.
 The effects of updates to this attribute set on this enumeration
 are undefined.

returns: A non-null enumeration of the attributes in this attribute set.
         Each element of the enumeration is of class Attribute.
         If attribute set has zero attributes, an empty enumeration
         is returned. - `javax.naming.NamingEnumeration<? extends javax.naming.directory.Attribute>`
raw docstring

get-i-dsclj

(get-i-ds this)

Retrieves an enumeration of the ids of the attributes in the attribute set. The effects of updates to this attribute set on this enumeration are undefined.

returns: A non-null enumeration of the attributes' ids in this attribute set. Each element of the enumeration is of class String. If attribute set has zero attributes, an empty enumeration is returned. - javax.naming.NamingEnumeration<java.lang.String>

Retrieves an enumeration of the ids of the attributes in the
 attribute set.
 The effects of updates to this attribute set on this enumeration
 are undefined.

returns: A non-null enumeration of the attributes' ids in
         this attribute set. Each element of the enumeration is
         of class String.
         If attribute set has zero attributes, an empty enumeration
         is returned. - `javax.naming.NamingEnumeration<java.lang.String>`
raw docstring

putclj

(put this attr)
(put this attr-id val)

Adds a new attribute to the attribute set.

attr-id - non-null The id of the attribute to add. If the attribute set ignores the character case of its attribute ids, the case of attrID is ignored. - java.lang.String val - The possibly null value of the attribute to add. If null, the attribute does not have any values. - java.lang.Object

returns: The Attribute with attrID that was previous in this attribute set; null if no such attribute existed. - javax.naming.directory.Attribute

Adds a new attribute to the attribute set.

attr-id - non-null The id of the attribute to add. If the attribute set ignores the character case of its attribute ids, the case of attrID is ignored. - `java.lang.String`
val - The possibly null value of the attribute to add. If null, the attribute does not have any values. - `java.lang.Object`

returns: The Attribute with attrID that was previous in this attribute set;
         null if no such attribute existed. - `javax.naming.directory.Attribute`
raw docstring

removeclj

(remove this attr-id)

Removes the attribute with the attribute id 'attrID' from the attribute set. If the attribute does not exist, ignore.

attr-id - The non-null id of the attribute to remove. If the attribute set ignores the character case of its attribute ids, the case of attrID is ignored. - java.lang.String

returns: The Attribute with the same ID as attrID that was previous in the attribute set; null if no such attribute existed. - javax.naming.directory.Attribute

Removes the attribute with the attribute id 'attrID' from
 the attribute set. If the attribute does not exist, ignore.

attr-id - The non-null id of the attribute to remove. If the attribute set ignores the character case of its attribute ids, the case of attrID is ignored. - `java.lang.String`

returns: The Attribute with the same ID as attrID that was previous
         in the attribute set;
         null if no such attribute existed. - `javax.naming.directory.Attribute`
raw docstring

sizeclj

(size this)

Retrieves the number of attributes in the attribute set.

returns: The nonnegative number of attributes in this attribute set. - int

Retrieves the number of attributes in the attribute set.

returns: The nonnegative number of attributes in this attribute set. - `int`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close