Класс BasicAttribute

java.lang.Object

javax.naming.directory.BasicAttribute

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

public class BasicAttribute extends Object implements Attribute

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

Данная реализация не поддерживает методы схемы getAttributeDefinition() и getAttributeSyntaxDefinition(). Они просто выбрасывают исключение OperationNotSupportedException. Подклассы класса BasicAttribute должны переопределять эти методы, если они их поддерживают.

Класс BasicAttribute по умолчанию использует Object.equals() для определения равенства значений атрибутов при проверке на равенство или при поиске значений, *за исключением* случаев, когда значение является массивом. Для массива каждый элемент массива проверяется с помощью Object.equals(). Подклассы класса BasicAttribute могут использовать информацию схемы при выполнении аналогичных проверок на равенство, переопределяя методы, в которых такое использование схемы имеет смысл. Аналогично, класс BasicAttribute по умолчанию возвращает значения, переданные в конструктор и/или изменённые с помощью методов добавления/удаления. Подклассы класса BasicAttribute могут переопределить методы get() и getAll(), чтобы динамически получать значения из каталога (или реализовать интерфейс Attribute напрямую вместо наследования от класса BasicAttribute).

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

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

С тех пор:

1.3

См. также:

Краткое описание полей

Модификатор и тип	Поле	Описание
`protected String`	`attrID`	Содержит идентификатор атрибута.
`protected boolean`	`ordered`	Флаг для записи о том, упорядочены ли значения этого атрибута.
`protected Vector<Object>`	`values`	Содержит значения атрибута.

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

Конструктор	Описание
`BasicAttribute(String id)`	Создаёт новый экземпляр неупорядоченного атрибута без значения.
`BasicAttribute(String id, boolean ordered)`	Создаёт новый экземпляр, возможно, упорядоченного атрибута без значения.
`BasicAttribute(String id, Object value)`	Создаёт новый экземпляр неупорядоченного атрибута с единственным значением.
`BasicAttribute(String id, Object value, boolean ordered)`	Создаёт новый экземпляр, возможно, упорядоченного атрибута с единственным значением.

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

Модификатор и тип	Метод	Описание
`void`	`add(int ix, Object attrVal)`	Добавляет значение атрибута в упорядоченный список значений атрибута.
`boolean`	`add(Object attrVal)`	Добавляет новое значение к этому атрибуту.
`void`	`clear()`	Удаляет все значения из этого атрибута.
`Object`	`clone()`	Создаёт копию атрибута.
`boolean`	`contains(Object attrVal)`	Определяет, присутствует ли значение в этом атрибуте.
`boolean`	`equals(Object obj)`	Определяет, равен ли объект obj этому атрибуту.
`Object`	`get()`	Возвращает одно из значений этого атрибута.
`Object`	`get(int ix)`	Возвращает значение атрибута из упорядоченного списка значений атрибута.
`NamingEnumeration<?>`	`getAll()`	Возвращает перечисление значений этого атрибута.
`DirContext`	`getAttributeDefinition()`	Возвращает определение схемы этого атрибута.
`DirContext`	`getAttributeSyntaxDefinition()`	Возвращает определение синтаксиса, связанное с этим атрибутом.
`String`	`getID()`	Возвращает идентификатор этого атрибута.
`int`	`hashCode()`	Вычисляет хэш-код этого атрибута.
`boolean`	`isOrdered()`	Определяет, упорядочены ли значения этого атрибута.
`Object`	`remove(int ix)`	Удаляет значение атрибута из упорядоченного списка значений атрибута.
`boolean`	`remove(Object attrval)`	Удаляет указанное значение из этого атрибута.
`Object`	`set(int ix, Object attrVal)`	Устанавливает значение атрибута в упорядоченном списке значений атрибута.
`int`	`size()`	Возвращает количество значений в этом атрибуте.
`String`	`toString()`	Генерирует строковое представление этого атрибута.

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

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

Подробное описание полей

attrID

protected String attrID

Содержит идентификатор атрибута. Инициализируется в конструкторе public и не может быть null, если методы в BasicAttribute, использующие attrID, не переопределены.

values

protected transient Vector<Object> values

Содержит значения атрибута. Инициализируется в конструкторах public. Не может быть null, если методы в BasicAttribute, использующие values, не переопределены.

ordered

protected boolean ordered

Флаг, указывающий, упорядочены ли значения этого атрибута.

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

BasicAttribute

public BasicAttribute(String id)

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

Параметры:: id - Идентификатор атрибута. Не может быть null.

BasicAttribute

public BasicAttribute(String id, Object value)

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

Параметры:: id - Идентификатор атрибута. Не может быть null.; value - Значение атрибута. Если null, то null добавляется в атрибут.

BasicAttribute

public BasicAttribute(String id, boolean ordered)

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

Параметры:: id - Идентификатор атрибута. Не может быть null.; ordered - true означает, что значения атрибута будут упорядочены; в противном случае - false.

BasicAttribute

public BasicAttribute(String id, Object value, boolean ordered)

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

Параметры:: id - Идентификатор атрибута. Не может быть null.; value - Значение атрибута. Если null, то null добавляется в атрибут.; ordered - true означает, что значения атрибута будут упорядочены; в противном случае - false.

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

clone

public Object clone()

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

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

Определено в:

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

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

clone в классе Object

Возвращает:

Непустая копия атрибута.

См. также:

equals

public boolean equals(Object obj)

Определяет, равен ли obj этому атрибуту. Два атрибута равны, если их идентификаторы атрибутов, синтаксисы и значения равны. Если значения атрибута неупорядочены, порядок добавления значений не имеет значения. Если значения атрибута упорядочены, то порядок значений должен совпадать. Если obj равен null или не является атрибутом, возвращается false.

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

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

equals в классе Object

Параметры:

obj - Возможно null объект для проверки.

Возвращает:

true, если obj равен этому атрибуту; иначе - false.

См. также:

hashCode

public int hashCode()

Вычисляет хэш-код этого атрибута.

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

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

hashCode в классе Object

Возвращает:

Целое число, представляющее хэш-код этого атрибута.

См. также:

toString

public String toString()

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

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

getAll

public NamingEnumeration<?> getAll() throws NamingException

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

По умолчанию возвращаемые значения — те, которые были переданы в конструктор и/или изменены с помощью методов добавления/замены/удаления. Подкласс может переопределить этот метод для динамического получения значений из каталога.

Определено в:

getAll в интерфейсе Attribute

Возвращает:

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

Исключения:

NamingException - Если при получении значений возникло исключение по имени.

См. также:

get

public Object get() throws NamingException

Возвращает одно из значений этого атрибута.

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

Определено в:: get в интерфейсе Attribute
Возвращает:: Возможно null объект, представляющий одно из значений атрибута. Равно null, если значение атрибута null.
Исключения:: NamingException - Если при извлечении значения возникло исключение по имени.

size

public int size()

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

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

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

getID

public String getID()

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

Возвращает идентификатор этого атрибута.

Определено в:: getID в интерфейсе Attribute
Возвращает:: Идентификатор этого атрибута. Не может быть null.

contains

public boolean contains(Object attrVal)

Определяет, содержится ли значение в этом атрибуте.

По умолчанию Object.equals() используется при сравнении attrVal со значениями этого атрибута, за исключением случаев, когда attrVal является массивом. Для массива проверяется каждый элемент массива с использованием Object.equals(). Подкласс может использовать информацию схемы для определения равенства.

Определено в:

contains в интерфейсе Attribute

Параметры:

attrVal - Возможно null значение для проверки. Если null, проверяется, есть ли значение атрибута, равное null.

Возвращает:

true, если attrVal — одно из значений этого атрибута; иначе - false.

См. также:

добавить

public boolean add(Object attrVal)

Добавляет новое значение в этот атрибут.

По умолчанию, Object.equals() используется при сравнении attrVal со значениями этого атрибута, за исключением случаев, когда attrVal является массивом. Для массива каждый элемент массива проверяется с помощью Object.equals(). Подкласс может использовать информацию схемы для определения равенства.

Указано в:: add в интерфейсе Attribute
Параметры:: attrVal - Новое, возможно, null значение для добавления. Если null, null добавляется как значение атрибута.
Возвращает:: true, если значение было добавлено; иначе false.

удалить

public boolean remove(Object attrval)

Удаляет указанное значение из этого атрибута.

Указано в:: remove в интерфейсе Attribute
Параметры:: attrval - Возможно, null значение для удаления из этого атрибута. Если null, удаляется значение атрибута, которое равно null.
Возвращает:: true, если значение было удалено; иначе false.

очистить

public void clear()

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

Удаляет все значения из этого атрибута.

Указано в:: clear в интерфейсе Attribute

упорядочен

public boolean isOrdered()

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

Определяет, упорядочены ли значения этого атрибута. Если значения атрибута упорядочены, допускаются дублируемые значения. Если значения атрибута неупорядочены, они представлены в любом порядке, и дублируемых значений нет.

Указано в:

isOrdered в интерфейсе Attribute

Возвращает:

true, если значения этого атрибута упорядочены; иначе false.

См. также:

получить

public Object get(int ix) throws NamingException

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

Извлекает значение атрибута из упорядоченного списка значений атрибутов. Этот метод возвращает значение по ix индексу списка значений атрибутов. Если значения атрибута неупорядочены, этот метод возвращает значение, которое случайно находится на этом индексе.

Указано в:: get в интерфейсе Attribute
Параметры:: ix - Индекс значения в упорядоченном списке значений атрибутов. 0 <= ix < size().
Возвращает:: Возможно, null значение атрибута по индексу ix; null, если значение атрибута равно null.
Исключения:: NamingException - Если при извлечении значения произошла ошибка именования.

удалить

public Object remove(int ix)

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

Удаляет значение атрибута из упорядоченного списка значений атрибутов. Этот метод удаляет значение по ix индексу списка значений атрибутов. Если значения атрибута неупорядочены, этот метод удаляет значение, которое случайно находится на этом индексе. Значения, расположенные по индексам, большим чем ix, смещаются вверх к началу списка (и их индексы уменьшаются на единицу).

Указано в:: remove в интерфейсе Attribute
Параметры:: ix - Индекс значения для удаления. 0 <= ix < size().
Возвращает:: Возможно, null значение атрибута по индексу ix, которое было удалено; null, если значение атрибута равно null.

добавить

public void add(int ix, Object attrVal)

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

Добавляет значение атрибута в упорядоченный список значений атрибутов. Этот метод добавляет attrVal в список значений атрибутов по индексу ix. Значения, расположенные по индексам, равным или большим чем ix, смещаются вниз к концу списка (и их индексы увеличиваются на единицу). Если значения атрибута неупорядочены и уже содержат attrVal, то генерируется IllegalStateException.

Указано в:: add в интерфейсе Attribute
Параметры:: ix - Индекс в упорядоченном списке значений атрибутов для добавления нового значения. 0 <= ix <= size().; attrVal - Возможно, null значение атрибута для добавления; если null, добавляется null.

установить

public Object set(int ix, Object attrVal)

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

Устанавливает значение атрибута в упорядоченном списке значений атрибутов. Этот метод устанавливает значение по ix индексу списка значений атрибутов в attrVal. Старое значение удаляется. Если значения атрибута неупорядочены, этот метод устанавливает значение, которое случайно находится на этом индексе, в attrVal, если attrVal уже не является одним из значений. В этом случае генерируется IllegalStateException.

Указано в:: set в интерфейсе Attribute
Параметры:: ix - Индекс значения в упорядоченном списке значений атрибутов. 0 <= ix < size().; attrVal - Возможно, null значение атрибута для использования. Если null, 'null' заменяет старое значение.
Возвращает:: Возможно, null значение атрибута по индексу ix, которое было заменено. Null, если значение атрибута было null.

определениеСинтаксисаАтрибута

public DirContext getAttributeSyntaxDefinition() throws NamingException

Возвращает определение синтаксиса, связанное с этим атрибутом.

Этот метод по умолчанию выбрасывает OperationNotSupportedException. Подкласс должен переопределить этот метод, если он поддерживает схемы.

Указано в:: getAttributeSyntaxDefinition в интерфейсе Attribute
Возвращает:: Определение синтаксиса атрибута. Null, если реализация поддерживает схемы, но у данного атрибута нет информации о схеме.
Исключения:: OperationNotSupportedException - Если получение схемы не поддерживается.; NamingException - Если при получении схемы произошла ошибка именования.

определениеАтрибута

public DirContext getAttributeDefinition() throws NamingException

Возвращает определение схемы этого атрибута.

Указано в:: getAttributeDefinition в интерфейсе Attribute
Возвращает:: Определение схемы этого атрибута. Null, если реализация поддерживает схемы, но у данного атрибута нет информации о схеме.
Исключения:: OperationNotSupportedException - Если получение схемы не поддерживается.; NamingException - Если при получении схемы произошла ошибка именования.

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.naming/javax/naming/directory/BasicAttribute.html