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

Все суперинтерфейсы:: 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()

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

Возвращает:

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

См. также:

compareTo

int compareTo(Object obj)

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

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

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

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

Параметры:

obj - объект для сравнения (не null).

Возвращает:

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

Исключение:

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

См. также:

size

int size()

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

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

isEmpty

boolean isEmpty()

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

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

getAll

Enumeration<String> getAll()

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

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

get

String get(int posn)

Извлекает компонент этого имени.

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

getPrefix

Name getPrefix(int posn)

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

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

getSuffix

Name getSuffix(int posn)

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

Параметры:: posn - индекс компонента, с которого начинается суффикс (с нуля). Должен быть в диапазоне [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) для размещения новых компонентов.

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

add

Name add(String comp) throws InvalidNameException

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

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

add

Name add(int posn, String comp) throws InvalidNameException

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

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

remove

Object remove(int posn) throws InvalidNameException

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

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

© 1993, 2023, 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/21/docs/api/java.naming/javax/naming/Name.html