Имя интерфейса

Все суперинтерфейсы:: Cloneable, Comparable<Object>, Serializable

Все известные реализующие классы:: CompositeName, CompoundName, LdapName

public interface Name extends Cloneable, Serializable, Comparable<Object>

Интерфейс Name представляет собой общее имя — упорядоченную последовательность компонентов. Это может быть составное имя (имена, охватывающие несколько пространств имён) или составное имя (имена, используемые внутри отдельных иерархических систем именования).

Могут быть разные реализации Name; например, составные имена, URL-адреса или составные имена, специфичные для пространства имён.

Компоненты имени пронумерованы. Индексы имени с N компонентами варьируются от 0 до, но не включая, N. Этот диапазон может быть записан как [0,N). Наиболее значимый компонент находится с индексом 0. Пустое имя не имеет компонентов.

Ни один из методов в этом интерфейсе не принимает null в качестве допустимого значения для параметра, являющегося именем или компонентом имени. Аналогично, методы, возвращающие имя или компонент имени, никогда не возвращают null.

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

С момента:: 1.3

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

Модификатор и тип	Поле	Описание
`static final long`	`serialVersionUID`	Устаревшее. Поле `serialVersionUID` в интерфейсе неэффективно.

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

Модификатор и тип	Метод	Описание
`Name`	`add(int posn, String comp)`	Добавляет один компонент в заданную позицию в этом имени.
`Name`	`add(String comp)`	Добавляет один компонент в конец этого имени.
`Name`	`addAll(int posn, Name n)`	Добавляет компоненты имени — в порядке — в заданную позицию в этом имени.
`Name`	`addAll(Name suffix)`	Добавляет компоненты имени — в порядке — в конец этого имени.
`Object`	`clone()`	Генерирует новую копию этого имени.
`int`	`compareTo(Object obj)`	Сравнивает это имя с другим именем по порядку.
`boolean`	`endsWith(Name n)`	Определяет, заканчивается ли это имя заданным суффиксом.
`String`	`get(int posn)`	Извлекает компонент этого имени.
`Enumeration<String>`	`getAll()`	Извлекает компоненты этого имени как перечисление строк.
`Name`	`getPrefix(int posn)`	Создаёт имя, компоненты которого состоят из префикса компонентов этого имени.
`Name`	`getSuffix(int posn)`	Создаёт имя, компоненты которого состоят из суффикса компонентов в этом имени.
`boolean`	`isEmpty()`	Определяет, является ли это имя пустым.
`Object`	`remove(int posn)`	Удаляет компонент из этого имени.
`int`	`size()`	Возвращает количество компонентов в этом имени.
`boolean`	`startsWith(Name n)`	Определяет, начинается ли это имя с заданного префикса.

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

serialVersionUID

@Deprecated static final long serialVersionUID

Устарело.

Поле serialVersionUID в интерфейсе неэффективно. Не использовать; замены нет.

Отпечаток класса, который задан для указания совместимости сериализации с предыдущей версией класса.

См. также:

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

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

clone

Object clone()

Создаёт новую копию этого имени. Последующие изменения компонентов этого имени не повлияют на новую копию, и наоборот.

Возвращает:

копию этого имени

См. также:

Object.clone()

compareTo

int compareTo(Object obj)

Сравнивает это имя с другим именем для определения порядка. Возвращает отрицательное целое число, ноль или положительное целое число, если это имя меньше, равно или больше заданного имени.

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

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

compareTo в интерфейсе Comparable<Object>

Параметры:

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

Возвращает:

отрицательное целое число, ноль или положительное целое число, если это имя меньше, равно или больше заданного имени

Исключение:

ClassCastException - если obj не является Name типа, который может быть сравнен с этим именем

См. также:

Comparable.compareTo(Object)

size

int size()

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

Возвращает:: количество компонентов в этом имени

isEmpty

boolean isEmpty()

Определяет, пусто ли это имя. Пустое имя — это имя с нулём компонентов.

Возвращает:: true, если это имя пусто, иначе false

getAll

Enumeration<String> getAll()

Возвращает компоненты этого имени в виде перечисления строк. Эффект от обновлений этого имени на перечисление не определён. Если имя имеет нуль компонентов, возвращается пустое (не null) перечисление.

Возвращает:: перечисление компонентов этого имени, каждое из которых является строкой

get

String get(int posn)

Возвращает компонент этого имени.

Параметры:: posn - индекс компонента, который нужно получить (отсчёт с 0). Должен быть в диапазоне [0,size()).
Возвращает:: компонент с индексом posn
Исключение:: ArrayIndexOutOfBoundsException - если posn находится вне указанного диапазона

getPrefix

Name getPrefix(int posn)

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

Параметры:: posn - индекс компонента, после которого нужно остановиться (отсчёт с 0). Должен быть в диапазоне [0,size()].
Возвращает:: имя, состоящее из компонентов с индексами в диапазоне [0,posn).
Исключение:: ArrayIndexOutOfBoundsException - если posn находится вне указанного диапазона

getSuffix

Name getSuffix(int posn)

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

Параметры:: posn - индекс компонента, с которого нужно начать (отсчёт с 0). Должен быть в диапазоне [0,size()].
Возвращает:: имя, состоящее из компонентов с индексами в диапазоне [posn,size()). Если posn равно size(), возвращается пустое имя.
Исключение:: ArrayIndexOutOfBoundsException - если posn находится вне указанного диапазона

startsWith

boolean startsWith(Name n)

Определяет, начинается ли это имя с указанного префикса. Имя n является префиксом, если оно равно getPrefix(n.size()).

Параметры:: n - имя для проверки
Возвращает:: true, если n является префиксом этого имени, иначе false

endsWith

boolean endsWith(Name n)

Определяет, заканчивается ли это имя указанным суффиксом. Имя n является суффиксом, если оно равно getSuffix(size()-n.size()).

Параметры:: n - имя для проверки
Возвращает:: true, если n является суффиксом этого имени, иначе false

addAll

Name addAll(Name suffix) throws InvalidNameException

Добавляет компоненты имени — в порядке — в конец этого имени.

Параметры:: suffix - компоненты для добавления
Возвращает:: обновлённое имя (не новое)
Исключение:: InvalidNameException - если suffix не является допустимым именем или если добавление компонентов нарушит правила синтаксиса этого имени

addAll

Name addAll(int posn, Name n) throws InvalidNameException

Добавляет компоненты имени — в порядке — в указанную позицию в этом имени. Компоненты этого имени с индексом первого нового компонента или позже сдвигаются вверх (от 0) для размещения новых компонентов.

Параметры:: n - компоненты для добавления; posn - индекс в этом имени, в котором нужно добавить новые компоненты. Должен быть в диапазоне [0,size()].
Возвращает:: обновлённое имя (не новое)
Исключение:: ArrayIndexOutOfBoundsException - если posn находится вне указанного диапазона; InvalidNameException - если n не является допустимым именем или если добавление компонентов нарушит правила синтаксиса этого имени

add

Name add(String comp) throws InvalidNameException

Добавляет один компонент в конец этого имени.

Параметры:: comp - компонент для добавления
Возвращает:: обновлённое имя (не новое)
Исключение:: InvalidNameException - если добавление comp нарушит правила синтаксиса этого имени

add

Name add(int posn, String comp) throws InvalidNameException

Добавляет один компонент в указанную позицию в этом имени. Компоненты этого имени с индексом нового компонента или позже сдвигаются вверх на один (от индекса 0) для размещения нового компонента.

Параметры:: comp - компонент для добавления; posn - индекс, в котором нужно добавить новый компонент. Должен быть в диапазоне [0,size()].
Возвращает:: обновлённое имя (не новое)
Исключение:: ArrayIndexOutOfBoundsException - если posn находится вне указанного диапазона; InvalidNameException - если добавление comp нарушит правила синтаксиса этого имени

remove

Object remove(int posn) throws InvalidNameException

Удаляет компонент из этого имени. Компонент этого имени в указанной позиции удаляется. Компоненты с индексами, большими этой позиции, сдвигаются вниз (к индексу 0) на один.

Параметры:: posn - индекс компонента, который нужно удалить. Должен быть в диапазоне [0,size()).
Возвращает:: удаленный компонент (строка)
Исключение:: ArrayIndexOutOfBoundsException - если posn находится вне указанного диапазона; InvalidNameException - если удаление компонента нарушит правила синтаксиса имени

© 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/Name.html