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

Все суперинтерфейсы:: 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. Должен находиться в диапазоне [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

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

Параметры:: 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()).
Возвращает:: удалённый компонент (String)
Выбрасывает:: ArrayIndexOutOfBoundsException — если posn находится за пределами указанного диапазона; InvalidNameException — если удаление компонента нарушает синтаксические правила имени

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.naming/javax/naming/Name.html