javax.naming.directory

Интерфейсный Атрибут

Все Суперинтерфейсы:

Cloneable, Сериализуемый

Все Известные Классы с реализацией:

BasicAttribute

public interface Attribute
extends Cloneable, Serializable

Этот интерфейс представляет атрибут, связанный с именованным объектом.

В каталоге, названном объектами, мог связать с ними атрибуты. Интерфейс Attribute представляет атрибут, связанный с именованным объектом. Атрибут содержит 0 или больше, возможно нуль, значения. Значения атрибута могут быть упорядочены или неупорядочены (см. isOrdered()). Если значения неупорядочиваются, никакие копии не позволяются. Если значения упорядочиваются, копии позволяются.

Контент и представление атрибута и его значений определяются схемой атрибута. Схема содержит информацию о синтаксисе атрибута и другие свойства об атрибуте. См. getAttributeDefinition() и getAttributeSyntaxDefinition() для деталей относительно того, как получить информацию схемы об атрибуте, если базовая служба каталогов поддерживает схемы.

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

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

С тех пор:

1.3

См. Также:

BasicAttribute

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
static long	serialVersionUID Используйте serialVersionUID от JNDI 1.1.1 для функциональной совместимости.

Сводка метода

Методы

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

Полевая Деталь

serialVersionUID

static final long serialVersionUID

Используйте serialVersionUID от JNDI 1.1.1 для функциональной совместимости.

См. Также:

Постоянные Значения полей

Деталь метода

getAll

NamingEnumeration<?> getAll()
                            throws NamingException

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

Возвраты:

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

Броски:

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

См. Также:

isOrdered()

добраться

Object get()
           throws NamingException

Получает одно из значений этого атрибута. Если атрибут имеет больше чем одно значение и неупорядочивается, любое из значений возвращается. Если атрибут имеет больше чем одно значение и упорядочивается, первое значение возвращается.

Возвраты:

Возможно нулевой объект, представляющий одно из значения атрибута. Это - нуль, если значение атрибута является нулем.

Броски:

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

NoSuchElementException - Если у этого атрибута нет никаких значений.

размер

int size()

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

Возвраты:

Неотрицательное число значений в этом атрибуте.

getID

String getID()

Получает идентификатор этого атрибута.

Возвраты:

Идентификатор этого атрибута. Это не может быть нуль.

содержит

boolean contains(Object attrVal)

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

Параметры:

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

Возвраты:

истина, если attrVal является одним из значений этого атрибута; ложь иначе.

См. Также:

Object.equals(java.lang.Object), BasicAttribute.equals(java.lang.Object)

добавить

boolean add(Object attrVal)

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

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

Параметры:

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

Возвраты:

истина, если значение было добавлено; ложь иначе.

удалить

boolean remove(Object attrval)

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

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

Параметры:

attrval - Возможно нулевое значение, чтобы удалить из этого атрибута. Если ноль, удалите значение атрибута, которое является нулем.

Возвраты:

истина, если значение было удалено; ложь иначе.

очистить

void clear()

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

getAttributeSyntaxDefinition

DirContext getAttributeSyntaxDefinition()
                                        throws NamingException

Получает определение синтаксиса, связанное с атрибутом. Определение синтаксиса атрибута определяет формат значения (й) атрибута. Отметьте, что это отличается от представления значения атрибута как объект Java. Определение синтаксиса относится к понятию каталога синтаксиса.

Например, даже при том, что значение могло бы быть Строковым объектом Java, его синтаксис каталога мог бы быть "Печатаемой Строкой" или "Номером телефона". Или значение могло бы быть байтовым массивом, и его синтаксис каталога является "JPEG" или "Сертификатом". Например, если бы синтаксис этого атрибута является "JPEG", этот метод возвратил бы определение синтаксиса для "JPEG".

Информация, которую можно получить из определения синтаксиса, зависима от каталога.

Если реализация не поддерживает схемы, она должна бросить OperationNotSupportedException. Если реализация действительно поддерживает схемы, она должна определить этот метод, чтобы возвратить соответствующую информацию.

Возвраты:

Определение синтаксиса атрибута. У нуля, если реализация поддерживает схемы, но этот определенный атрибут, нет никакой информации о схеме.

Броски:

OperationNotSupportedException - Если получение схемы не поддерживается.

NamingException - Если исключение именования происходит, получая схему.

getAttributeDefinition

DirContext getAttributeDefinition()
                                  throws NamingException

Получает определение схемы атрибута. Определение схемы атрибута содержит информацию такой как, является ли атрибут многозначным или однозначным, соответствующие правила использовать, сравнивая значения атрибута. Информация, которую можно получить из определения атрибута, зависима от каталога.

Если реализация не поддерживает схемы, она должна бросить OperationNotSupportedException. Если реализация действительно поддерживает схемы, она должна определить этот метод, чтобы возвратить соответствующую информацию.

Возвраты:

Определение схемы этого атрибута. У нуля, если реализация поддерживает схемы, но этот определенный атрибут, нет никакой информации о схеме.

Броски:

OperationNotSupportedException - Если получение схемы не поддерживается.

NamingException - Если исключение именования происходит, получая схему.

клон

Object clone()

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

Возвраты:

Ненулевая копия атрибута.

isOrdered

boolean isOrdered()

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

Возвраты:

истина, если значения этого атрибута упорядочиваются; ложь иначе.

См. Также:

get(int), remove(int), add(int, java.lang.Object), set(int, java.lang.Object)

добраться

Object get(int ix)
           throws NamingException

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

Параметры:

ix - Индекс значения в упорядоченном списке значений атрибута. 0 <= ixsize ().

Возвраты:

Возможно неопределенный атрибут оценивает в индекс ix; нуль, если значение атрибута является нулем.

Броски:

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

IndexOutOfBoundsException - Если ix вне указанного диапазона.

удалить

Object remove(int ix)

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

Параметры:

ix - Индекс значения, чтобы удалить. 0 <= ixsize ().

Возвраты:

Возможно неопределенный атрибут оценивает в индекс ix, который был удален; нуль, если значение атрибута является нулем.

Броски:

IndexOutOfBoundsException - Если ix вне указанного диапазона.

добавить

void add(int ix,
       Object attrVal)

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

Параметры:

ix - Индекс в упорядоченном списке значений атрибута, чтобы добавить новое значение. 0 <= ixsize ().

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

Броски:

IndexOutOfBoundsException - Если ix вне указанного диапазона.

IllegalStateException - Если значения атрибута неупорядочиваются, и attrVal является одним из тех значений.

набор

Object set(int ix,
         Object attrVal)

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

Параметры:

ix - Индекс значения в упорядоченном списке значений атрибута. 0 <= ixsize ().

attrVal - Возможно неопределенный атрибут оценивает использованию. Если ноль, 'нуль' заменяет старое значение.

Возвраты:

Возможно неопределенный атрибут оценивает в индекс ix, который был заменен. Нуль, если значение атрибута было нулем.

Броски:

IndexOutOfBoundsException - Если ix вне указанного диапазона.

IllegalStateException - Если attrVal уже существует, и значения атрибута неупорядочиваются.