Класс BasicAttributes

java.lang.Object

javax.naming.directory.BasicAttributes

Все реализованные интерфейсы:: Serializable, Cloneable, Attributes

public class BasicAttributes extends Object implements Attributes

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

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

Когда класс BasicAttributes нуждается в создании атрибута, он использует BasicAttribute. Нет других зависимостей от BasicAttribute.

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

Экземпляр BasicAttributes не синхронизирован против одновременного доступа нескольких потоков. Несколько потоков, пытающихся получить доступ к одному экземпляру BasicAttributes и изменить его, должны заблокировать объект.

С:

1.3

См. также:

Краткое описание конструкторов

Конструктор	Описание
`BasicAttributes()`	Создаёт новый экземпляр Attributes.
`BasicAttributes(boolean ignoreCase)`	Создаёт новый экземпляр Attributes.
`BasicAttributes(String attrID, Object val)`	Создаёт новый экземпляр Attributes с одним атрибутом.
`BasicAttributes(String attrID, Object val, boolean ignoreCase)`	Создаёт новый экземпляр Attributes с одним атрибутом.

Краткое описание методов

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Определяет, равен ли этот `BasicAttributes` другому `Attributes` Два `Attributes` равны, если оба являются экземплярами `Attributes`, обрабатывают регистр идентификаторов атрибутов одинаково и содержат те же атрибуты.
`Attribute`	`get(String attrID)`	Извлекает атрибут с заданным идентификатором атрибута из набора атрибутов.
`NamingEnumeration<Attribute>`	`getAll()`	Извлекает перечисление атрибутов в наборе атрибутов.
`NamingEnumeration<String>`	`getIDs()`	Извлекает перечисление идентификаторов атрибутов в наборе атрибутов.
`int`	`hashCode()`	Вычисляет хэш-код этого BasicAttributes.
`boolean`	`isCaseIgnored()`	Определяет, игнорирует ли набор атрибутов регистр идентификаторов атрибутов при извлечении или добавлении атрибутов.
`Attribute`	`put(String attrID, Object val)`	Добавляет новый атрибут в набор атрибутов.
`Attribute`	`put(Attribute attr)`	Добавляет новый атрибут в набор атрибутов.
`Attribute`	`remove(String attrID)`	Удаляет атрибут с идентификатором атрибута 'attrID' из набора атрибутов.
`int`	`size()`	Извлекает количество атрибутов в наборе атрибутов.
`String`	`toString()`	Генерирует строковое представление этого набора атрибутов.

Методы, объявленные в классе java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Подробное описание конструкторов

BasicAttributes

public BasicAttributes()

Создаёт новый экземпляр Attributes. Регистр символов идентификаторов атрибутов имеет значение при последующем получении или добавлении атрибутов.

BasicAttributes

public BasicAttributes(boolean ignoreCase)

Создаёт новый экземпляр Attributes. Если ignoreCase имеет значение true, регистр символов идентификаторов атрибутов игнорируется; в противном случае регистр имеет значение.

Параметры:: ignoreCase - true означает, что этот набор атрибутов будет игнорировать регистр своих идентификаторов атрибутов при получении или добавлении атрибутов; false означает, что регистр учитывается.

BasicAttributes

public BasicAttributes(String attrID, Object val)

Создаёт новый экземпляр Attributes с одним атрибутом. Атрибут, указанный attrID и val, добавляется к новосозданному атрибуту. Регистр символов идентификаторов атрибутов имеет значение при последующем получении или добавлении атрибутов.

Параметры:: attrID - не null Идентификатор добавляемого атрибута.; val - Значение добавляемого атрибута. Если null, то добавляется значение null для атрибута.

BasicAttributes

public BasicAttributes(String attrID, Object val, boolean ignoreCase)

Создаёт новый экземпляр Attributes с одним атрибутом. Атрибут, указанный attrID и val, добавляется к новосозданному атрибуту. Если ignoreCase имеет значение true, регистр символов идентификаторов атрибутов игнорируется; в противном случае регистр имеет значение.

Параметры:: attrID - не null Идентификатор добавляемого атрибута. Если этот набор атрибутов игнорирует регистр своих идентификаторов атрибутов, регистр attrID игнорируется.; val - Значение добавляемого атрибута. Если null, то добавляется значение null для атрибута.; ignoreCase - true означает, что этот набор атрибутов будет игнорировать регистр своих идентификаторов атрибутов при получении или добавлении атрибутов; false означает, что регистр учитывается.

Подробное описание методов

clone

public Object clone()

Описание скопировано из класса: Object

Создаёт и возвращает копию этого объекта. Точное значение "копии" может зависеть от класса объекта. Общий замысел заключается в том, что для любого объекта x, выражение:

 x.clone() != x

будет истинным, и выражение:

 x.clone().getClass() == x.getClass()

будет true, но это не абсолютные требования. Хотя обычно верно, что:

 x.clone().equals(x)

будет true, это не абсолютное требование.

По соглашению, возвращаемый объект должен быть получен путём вызова super.clone. Если класс и все его суперклассы (кроме Object) следуют этому соглашению, то x.clone().getClass() == x.getClass().

По соглашению, объект, возвращаемый этим методом, должен быть независимым от этого объекта (который клонируется). Для достижения этой независимости может потребоваться изменить одно или несколько полей объекта, возвращаемого super.clone перед его возвращением. Как правило, это означает копирование любых изменяемых объектов, которые составляют внутреннюю "глубокую структуру" клонируемого объекта и замену ссылок на эти объекты ссылками на копии. Если класс содержит только примитивные поля или ссылки на неизменяемые объекты, то обычно поля в объекте, возвращаемом super.clone, не нужно изменять.

Указано в:

clone в интерфейсе Attributes

Переопределяет:

clone в классе Object

Возвращает:

клонированный экземпляр.

См. также:

isCaseIgnored

public boolean isCaseIgnored()

Описание скопировано из интерфейса: Attributes

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

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

size

public int size()

Описание скопировано из интерфейса: Attributes

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

Указано в:: size в интерфейсе Attributes
Возвращает:: Неотрицательное количество атрибутов в этом наборе атрибутов.

get

public Attribute get(String attrID)

Описание скопировано из интерфейса: Attributes

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

Указано в:

get в интерфейсе Attributes

Параметры:

attrID - не null идентификатор атрибута для получения. Если этот набор атрибутов игнорирует регистр своих идентификаторов атрибутов, регистр attrID игнорируется.

Возвращает:

Атрибут, идентифицированный attrID; null, если не найден.

См. также:

getAll

public NamingEnumeration<Attribute> getAll()

Описание скопировано из интерфейса: Attributes

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

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

getIDs

public NamingEnumeration<String> getIDs()

Описание скопировано из интерфейса: Attributes

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

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

put

public Attribute put(String attrID, Object val)

Описание скопировано из интерфейса: Attributes

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

Указано в:

put в интерфейсе Attributes

Параметры:

attrID - не null Идентификатор добавляемого атрибута. Если набор атрибутов игнорирует регистр своих идентификаторов атрибутов, регистр attrID игнорируется.

val - Возможно null значение добавляемого атрибута. Если null, атрибут не имеет значений.

Возвращает:

Атрибут с attrID, который был ранее в этом наборе атрибутов; null, если такого атрибута не существовало.

См. также:

put

public Attribute put(Attribute attr)

Описание скопировано из интерфейса: Attributes

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

Указано в:

put в интерфейсе Attributes

Параметры:

attr - не null добавляемый атрибут. Если набор атрибутов игнорирует регистр своих идентификаторов атрибутов, регистр идентификатора attr игнорируется.

Возвращает:

Атрибут с тем же ID, что и attr, который был ранее в этом наборе атрибутов; null, если такого атрибута не существовало.

См. также:

remove

public Attribute remove(String attrID)

Описание скопировано из интерфейса: Attributes

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

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

toString

public String toString()

Генерирует строковое представление этого набора атрибутов. Строка состоит из каждого идентификатора атрибута и содержимого каждого атрибута. Содержание этой строки полезно для отладки и не предназначено для программной интерпретации.

Переопределяет:: toString в классе Object
Возвращает:: Не нулевая строка, перечисляющая содержимое этого набора атрибутов.

equals

public boolean equals(Object obj)

Определяет, является ли этот BasicAttributes равным другому Attributes Два Attributes равны, если они оба являются экземплярами Attributes, обращаются с идентификаторами атрибутов одинаково, и содержат одинаковые атрибуты. Каждый Attribute в этом BasicAttributes проверяется на равенство с помощью Object.equals(), которая может быть переопределена реализациями Attribute). Если подкласс переопределяет equals(), он также должен переопределить hashCode(), чтобы два экземпляра Attributes , которые равны, имели одинаковый хэш-код.

Overrides:

equals в классе Object

Parameters:

obj - возможно, нулевой объект для сравнения.

Returns:

true, если obj равен этому BasicAttributes.

See Also:

hashCode

public int hashCode()

Вычисляет хэш-код этого BasicAttributes.

Хэш-код вычисляется путем суммирования хэш-кодов атрибутов этого объекта. Если этот BasicAttributes игнорирует регистр идентификаторов атрибутов, к хэш-коду добавляется единица. Если подкласс переопределяет hashCode(), он также должен переопределить equals(), чтобы два экземпляра Attributes , которые равны, имели одинаковый хэш-код.

Overrides:

hashCode в классе Object

Returns:

целое число, представляющее хэш-код экземпляра BasicAttributes.

See Also:

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.naming/javax/naming/directory/BasicAttributes.html