Интерфейс Name

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

static final long serialVersionUID

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

См. также:: Значения константных полей

Методы

clone

Object clone()

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

Возвращает:: копию этого имени
См. также:: Object.clone()

compareTo

int compareTo(Object obj)

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

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

Определено в:: compareTo в интерфейсе Comparable<Object>
Параметры:: obj - объект для сравнения (не null).
Возвращает:: отрицательное целое число, ноль или положительное целое число, если это имя меньше, равно или больше, чем заданное имя соответственно
Исключения:: 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, 2020, 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/11/docs/api/java.naming/javax/naming/Name.html