Spec-Zone.ru › OpenJDK 8

Класс 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(Attribute attr)

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

Attribute put(String attrID, Object val)

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

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 для класса Object выполняет определённую операцию клонирования. Во-первых, если класс этого объекта не реализует интерфейс Cloneable, то выбрасывается CloneNotSupportedException. Обратите внимание, что все массивы считаются реализующими интерфейс Cloneable, и что тип возвращаемого значения метода clone типа массива T[] является T[], где T — любой ссылочный или примитивный тип.

В противном случае этот метод создаёт новый экземпляр класса этого объекта и инициализирует все его поля точно теми же значениями, что и соответствующие поля этого объекта, как если бы они были присвоены; содержимое полей не клонируется. Таким образом, этот метод выполняет «поверхностную копию» этого объекта, а не операцию «глубокой копии».

Класс Object сам не реализует интерфейс Cloneable, поэтому вызов метода clone для объекта, класс которого Object, приведёт к сбою во время выполнения.

Указано в:
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
Возвращает:
Не null перечисление атрибутов в этом наборе атрибутов. Каждый элемент перечисления является классом Attribute. Если набор атрибутов содержит ноль атрибутов, возвращается пустое перечисление.

getIDs

public NamingEnumeration<String> getIDs()

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

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

Указано в:
getIDs в интерфейсе Attributes
Возвращает:
Не null перечисление идентификаторов атрибутов в этом наборе атрибутов. Каждый элемент перечисления является классом 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
Возвращает:
Не null строку, перечисляющую содержимое этого набора атрибутов.

equals

public boolean equals(Object obj)

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

Переопределяет:
equals в классе Object
Параметры:
obj - возможно нулевой объект для сравнения.
Возвращает:
true, если obj равен этому BasicAttributes.
См. также:
hashCode()

hashCode

public int hashCode()

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

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

Переопределяет:
hashCode в классе Object
Возвращает:
целое число, представляющее хэш-код этого экземпляра BasicAttributes.
См. также:
equals(java.lang.Object)

© 1993, 2020, 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.

Spec-Zone.ru

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