Spec-Zone.ru › OpenJDK 17

Класс 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
См. также:
  • 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()
Создаёт новый экземпляр 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
Возвращает:
клон этого экземпляра.
См. также:
  • Cloneable

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, если не найден.
См. также:
  • Attributes.put(java.lang.String, java.lang.Object)
  • Attributes.remove(java.lang.String)

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, если такого атрибута не существовало.
См. также:
  • Attributes.remove(java.lang.String)

put

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

remove

public Attribute remove(String attrID)
Описание, скопированное из интерфейса: Attributes
Удаляет атрибут с идентификатором 'attrID' из набора атрибутов. Если атрибут не существует, игнорируется.
Определено в:
remove в интерфейсе Attributes
Параметры:
attrID - не null идентификатор удаляемого атрибута. Если набор атрибутов игнорирует регистр символов своих идентификаторов атрибутов, регистр attrID игнорируется.
Возвращает:
Атрибут с таким же идентификатором, как у 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 - возможно, null, объект для сравнения.
Returns:
true, если obj равен этому BasicAttributes.
See Also:
  • hashCode()

hashCode

public int hashCode()
Вычисляет код хэша этого BasicAttributes.

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

Overrides:
hashCode в классе Object
Returns:
целое число, представляющее код хэша этого экземпляра BasicAttributes.
See Also:
  • equals(java.lang.Object)

© 1993, 2021, 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/17/docs/api/java.naming/javax/naming/directory/BasicAttributes.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API