Интерфейс атрибутов

Все суперинтерфейсы:: Cloneable, Serializable

Все известные реализующие классы:: BasicAttributes

public interface Attributes
extends Cloneable, Serializable

Этот интерфейс представляет собой коллекцию атрибутов.

В каталоге именованные объекты могут иметь связанные с ними атрибуты. Интерфейс Attributes представляет собой коллекцию атрибутов. Например, вы можете запросить у каталога атрибуты, связанные с объектом. Эти атрибуты возвращаются в объекте, реализующем интерфейс Attributes.

Атрибуты в объекте, реализующем интерфейс Attributes, не упорядочены. Объект может иметь ноль или более атрибутов. Attributes может быть чувствителен к регистру или нечувствителен к регистру (регистронезависимый). Этот параметр определяется в момент создания объекта Attributes (см. конструктор BasicAttributes для примера). В нечувствительном к регистру Attributes регистр идентификаторов атрибутов игнорируется при поиске атрибута или добавлении атрибутов. В чувствительном к регистру Attributes регистр имеет значение.

Обратите внимание, что обновления Attributes (например, добавление или удаление атрибута) не влияют на соответствующее представление в каталоге. Обновления каталога могут быть произведены только с помощью операций в интерфейсе DirContext.

С:: 1.3
См. также:: DirContext.getAttributes(javax.naming.Name), DirContext.modifyAttributes(javax.naming.Name, int, javax.naming.directory.Attributes), DirContext.bind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes), DirContext.rebind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes), DirContext.createSubcontext(javax.naming.Name, javax.naming.directory.Attributes), DirContext.search(javax.naming.Name, javax.naming.directory.Attributes, java.lang.String[]), BasicAttributes

Методы

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Создает копию набора атрибутов.
`Attribute`	`get(String attrID)`	Возвращает атрибут с заданным идентификатором атрибута из набора атрибутов.
`NamingEnumeration<? extends Attribute>`	`getAll()`	Возвращает перечисление атрибутов в наборе атрибутов.
`NamingEnumeration<String>`	`getIDs()`	Возвращает перечисление идентификаторов атрибутов в наборе атрибутов.
`boolean`	`isCaseIgnored()`	Определяет, игнорирует ли набор атрибутов регистр идентификаторов атрибутов при получении или добавлении атрибутов.
`Attribute`	`put(String attrID, Object val)`	Добавляет новый атрибут в набор атрибутов.
`Attribute`	`put(Attribute attr)`	Добавляет новый атрибут в набор атрибутов.
`Attribute`	`remove(String attrID)`	Удаляет атрибут с идентификатором атрибута 'attrID' из набора атрибутов.
`int`	`size()`	Возвращает количество атрибутов в наборе атрибутов.

Методы

isCaseIgnored

boolean isCaseIgnored()

Определяет, игнорирует ли набор атрибутов регистр идентификаторов атрибутов при получении или добавлении атрибутов.

Возвращает:: true, если регистр игнорируется; false в противном случае.

size

int size()

Возвращает количество атрибутов в наборе атрибутов.

Возвращает:: Положительное количество атрибутов в этом наборе атрибутов.

get

Attribute get(String attrID)

Возвращает атрибут с заданным идентификатором атрибута из набора атрибутов.

Параметры:: attrID - Непустой идентификатор атрибута для получения. Если этот набор атрибутов игнорирует регистр своих идентификаторов атрибутов, регистр attrID игнорируется.
Возвращает:: Атрибут, идентифицированный attrID; null, если не найден.
См. также:: put(java.lang.String, java.lang.Object), remove(java.lang.String)

getAll

NamingEnumeration<? extends Attribute> getAll()

Возвращает перечисление атрибутов в наборе атрибутов. Эффекты обновлений этого набора атрибутов на этом перечислении не определены.

Возвращает:: Непустое перечисление атрибутов в этом наборе атрибутов. Каждый элемент перечисления является объектом класса Attribute. Если набор атрибутов имеет ноль атрибутов, возвращается пустое перечисление.

getIDs

NamingEnumeration<String> getIDs()

Возвращает перечисление идентификаторов атрибутов в наборе атрибутов. Эффекты обновлений этого набора атрибутов на этом перечислении не определены.

Возвращает:: Непустое перечисление идентификаторов атрибутов в этом наборе атрибутов. Каждый элемент перечисления является строкой. Если набор атрибутов имеет ноль атрибутов, возвращается пустое перечисление.

put

Attribute put(String attrID,
              Object val)

Добавляет новый атрибут в набор атрибутов.

Параметры:: attrID - Непустой идентификатор добавляемого атрибута. Если набор атрибутов игнорирует регистр своих идентификаторов атрибутов, регистр attrID игнорируется.; val - Возможный null-значение добавляемого атрибута. Если null, атрибут не имеет значений.
Возвращает:: Атрибут с attrID, который был ранее в этом наборе атрибутов; null, если такого атрибута не существовало.
См. также:: remove(java.lang.String)

put

Attribute put(Attribute attr)

Добавляет новый атрибут в набор атрибутов.

Параметры:: attr - Непустой добавляемый атрибут. Если набор атрибутов игнорирует регистр своих идентификаторов атрибутов, регистр идентификатора attr игнорируется.
Возвращает:: Атрибут с тем же ID, что и attr, который был ранее в этом наборе атрибутов; null, если такого атрибута не существовало.
См. также:: remove(java.lang.String)

remove

Attribute remove(String attrID)

Удаляет атрибут с идентификатором атрибута 'attrID' из набора атрибутов. Если атрибут не существует, игнорируется.

Параметры:: attrID - Непустой идентификатор удаляемого атрибута. Если набор атрибутов игнорирует регистр своих идентификаторов атрибутов, регистр attrID игнорируется.
Возвращает:: Атрибут с тем же ID, что и attrID, который был ранее в наборе атрибутов; null, если такого атрибута не существовало.

clone

Object clone()

Создает копию набора атрибутов. Новый набор содержит те же атрибуты, что и исходный набор: сами атрибуты не клонируются. Изменения в копии не повлияют на оригинал и наоборот.

Возвращает:: Непустая копия этого набора атрибутов.