Класс CompoundName

java.lang.Object

javax.naming.CompoundName

Все реализованные интерфейсы:: Serializable, Cloneable, Comparable<Object>, Name

public class CompoundName extends Object implements Name

Этот класс представляет составное имя — имя из иерархического пространства имён. Каждый компонент в составном имени является атомным именем.

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

Синтаксис составного имени

Синтаксис составного имени задаётся набором свойств:

jndi.syntax.direction: Направление для разбора ("right_to_left", "left_to_right", "flat"). Если не указано, по умолчанию используется "flat", что означает плоское пространство имён без иерархической структуры.
jndi.syntax.separator: Разделитель между компонентами атомного имени. Требуется, если направление не "flat".
jndi.syntax.ignorecase: Если присутствует, "true" означает игнорирование регистра при сравнении компонентов имени. Если его значение не "true", или если свойство не указано, регистр учитывается при сравнении компонентов имени.
jndi.syntax.escape: Если присутствует, задаёт строку экранирования для переопределения разделителей, экранирования и кавычек.
jndi.syntax.beginquote: Если присутствует, задаёт строку, определяющую начало цитируемой строки.
jndi.syntax.endquote: Строка, определяющая конец цитируемой строки. Если присутствует, задаёт строку, определяющую конец цитируемой строки. Если отсутствует, используется syntax.beginquote как конечная кавычка.
jndi.syntax.beginquote2: Альтернативный набор кавычек начала/конца.
jndi.syntax.endquote2: Альтернативный набор кавычек начала/конца.
jndi.syntax.trimblanks: Если присутствует, "true" означает обрезку всех начальных и конечных пробелов в компоненте имени для целей сравнения. Если его значение не "true", или если свойство не указано, пробелы учитываются.
jndi.syntax.separator.ava: Если присутствует, задаёт строку, разделяющую утверждения атрибут-значение, когда указываются несколько пар атрибут/значение. (например, "," в age=65,gender=male).
jndi.syntax.separator.typeval: Если присутствует, задаёт строку, разделяющую атрибут и значение (например, "=" в "age=65").

Эти свойства интерпретируются в соответствии со следующими правилами:

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

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

Доступ в нескольких потоках

Экземпляр CompoundName не синхронизирован против одновременного доступа в нескольких потоках. Несколько потоков, пытающихся получить доступ и изменить CompoundName, должны заблокировать объект.

С тех пор:

1.3

См. также:

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

Модификатор и тип	Поле	Описание
`protected Properties`	`mySyntax`	Свойства синтаксиса для этого составного имени.

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

CompoundName(String n,
 Properties syntax)

CompoundName(Enumeration<String> comps,
 Properties syntax)

Модификатор	Конструктор	Описание
	Создаёт новый экземпляр составного имени, анализируя строку n с использованием синтаксиса, указанного в свойствах синтаксиса.
`protected`	Создаёт новый экземпляр составного имени, используя компоненты, указанные в comps и синтаксисе.

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

Модификатор и тип	Метод	Описание
`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)`	Сравнивает это CompoundName с указанным объектом по порядку.
`boolean`	`endsWith(Name n)`	Определяет, является ли составное имя суффиксом этого составного имени.
`boolean`	`equals(Object obj)`	Определяет, является ли obj синтаксически равным этому составному имени.
`String`	`get(int posn)`	Извлекает компонент этого составного имени.
`Enumeration<String>`	`getAll()`	Возвращает компоненты этого составного имени как перечисление строк.
`Name`	`getPrefix(int posn)`	Создаёт составное имя, компоненты которого состоят из префикса компонентов в этом составном имени.
`Name`	`getSuffix(int posn)`	Создаёт составное имя, компоненты которого состоят из суффикса компонентов в этом составном имени.
`int`	`hashCode()`	Вычисляет хэш-код этого составного имени.
`boolean`	`isEmpty()`	Определяет, пусто ли это составное имя.
`Object`	`remove(int posn)`	Удаляет компонент из этого составного имени.
`int`	`size()`	Возвращает количество компонентов в этом составном имени.
`boolean`	`startsWith(Name n)`	Определяет, является ли составное имя префиксом этого составного имени.
`String`	`toString()`	Генерирует строковое представление этого составного имени, используя правила синтаксиса составного имени.

Методы, объявленные в классе java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

mySyntax

protected transient Properties mySyntax

Свойства синтаксиса для этого составного имени. Это поле инициализируется конструкторами и не может быть null. Его следует рассматривать как только для чтения для подклассов. Все необходимые изменения в mySyntax должны вноситься в конструкторы, а не после того, как составное имя было создано.

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

CompoundName

protected CompoundName(Enumeration<String> comps, Properties syntax)

Создает новый экземпляр составного имени, используя компоненты, указанные в comps и syntax. Этот защищенный метод предназначен для использования подклассами CompoundName при переопределении методов, таких как clone(), getPrefix(), getSuffix().

Параметры:: comps - Непустой перечисление компонентов для добавления. Каждый элемент перечисления имеет тип String. Перечисление будет использовано для извлечения его элементов.; syntax - Непустой набор свойств, определяющих синтаксис этого составного имени. См. описание класса для содержимого свойств.

CompoundName

public CompoundName(String n, Properties syntax) throws InvalidNameException

Создает новый экземпляр составного имени, анализируя строку n с использованием синтаксиса, заданного свойствами синтаксиса.

Параметры:: n - Непустая строка для анализа.; syntax - Непустой список свойств, определяющих синтаксис этого составного имени. См. описание класса для содержимого свойств.
Исключение:: InvalidNameException - Если 'n' нарушает синтаксис, заданный syntax.

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

toString

public String toString()

Генерирует строковое представление этого составного имени, используя правила синтаксиса составного имени. Правила синтаксиса описаны в описании класса. Пустой компонент представлен пустой строкой. Таким образом сгенерированное строковое представление можно передать в конструктор CompoundName с теми же свойствами синтаксиса для создания нового эквивалентного составного имени.

Переопределяет:: toString в классе Object
Возвращает:: Непустое строковое представление этого составного имени.

equals

public boolean equals(Object obj)

Определяет, является ли obj синтаксически равным этому составному имени. Если obj равен null или не является CompoundName, возвращается false. Два составных имени равны, если каждый компонент в одном «равен» соответствующему компоненту в другом.

Равенство также определяется в терминах синтаксиса этого составного имени. По умолчанию CompoundName использует свойства синтаксиса jndi.syntax.ignorecase и jndi.syntax.trimblanks при сравнении двух компонентов на равенство. Если регистр игнорируется, две строки с одинаковой последовательностью символов, но разным регистром, считаются равными. Если пробелы обрезаются, ведущие и хвостовые пробелы игнорируются для целей сравнения.

Оба составных имени должны иметь одинаковое количество компонентов.

Примечание к реализации: В настоящее время свойства синтаксиса двух составных имён не сравниваются на равенство. Возможно, это будет сделано в будущем.

Переопределяет:

equals в классе Object

Параметры:

obj - Возможно null объект для сравнения.

Возвращает:

true, если obj равен этому составному имени, иначе false.

См. также:

hashCode

public int hashCode()

Вычисляет хэш-код этого составного имени. Хэш-код — это сумма хэш-кодов «канонизированных» форм отдельных компонентов этого составного имени. Каждый компонент «канонизируется» в соответствии с синтаксисом составного имени перед вычислением его хэш-кода. Например, для имени, не учитывающего регистр, верхний регистр имеет тот же хэш-код, что и его эквивалент в нижнем регистре.

Переопределяет:

hashCode в классе Object

Возвращает:

Целое число, представляющее хэш-код этого имени.

См. также:

clone

public Object clone()

Создает копию этого составного имени. Изменения в компонентах этого составного имени не повлияют на новую копию, и наоборот. Клон и это составное имя используют один и тот же синтаксис.

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

clone в интерфейсе Name

Переопределяет:

clone в классе Object

Возвращает:

Непустую копию этого составного имени.

См. также:

compareTo

public int compareTo(Object obj)

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

Если obj равен null или не является экземпляром CompoundName, выбрасывается ClassCastException.

См. equals() для того, что означает равенство двух составных имён. Если два составных имени равны, возвращается 0.

Порядок составных имён зависит от синтаксиса составного имени. По умолчанию они следуют лексикографическим правилам для сравнения строк с расширением, которое применяется ко всем компонентам составного имени и сравнение отдельных компонентов зависит от свойств jndi.syntax.ignorecase и jndi.syntax.trimblanks, аналогично тому, как они влияют на equals(). Если это составное имя «лексикографически» меньше obj, возвращается отрицательное число. Если это составное имя «лексикографически» больше obj, возвращается положительное число.

Примечание к реализации: В настоящее время свойства синтаксиса двух составных имён не сравниваются при проверке порядка. Возможно, это будет сделано в будущем.

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

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

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

compareTo в интерфейсе Name

Параметры:

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

Возвращает:

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

Исключение:

ClassCastException - если obj не является CompoundName.

См. также:

size

public int size()

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

Определено в:: size в интерфейсе Name
Возвращает:: Положительное количество компонентов в этом составном имени.

isEmpty

public boolean isEmpty()

Определяет, пусто ли это составное имя. Составное имя пусто, если у него нет компонентов.

Определено в:: isEmpty в интерфейсе Name
Возвращает:: true, если это составное имя пусто, иначе false.

getAll

public Enumeration<String> getAll()

Возвращает компоненты этого составного имени как перечисление строк. Эффекты обновлений этого составного имени на этом перечислении не определены.

Определено в:: getAll в интерфейсе Name
Возвращает:: Непустое перечисление компонентов этого составного имени. Каждый элемент перечисления имеет тип String.

get

public String get(int posn)

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

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

getPrefix

public Name getPrefix(int posn)

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

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

getSuffix

public Name getSuffix(int posn)

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

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

startsWith

public boolean startsWith(Name n)

Определяет, является ли составное имя префиксом этого составного имени. Составное имя 'n' является префиксом, если оно равно getPrefix(n.size()) — другими словами, это составное имя начинается с 'n'. Если n равно null или не является составным именем, возвращается false.

Примечание по реализации: В настоящее время свойства синтаксиса n не используются при сравнении. Они могут быть использованы в будущем.

Указано в:: startsWith в интерфейсе Name
Параметры:: n - Возможно null составное имя для проверки.
Возвращает:: true, если n является CompoundName и является префиксом этого составного имени, в противном случае false.

endsWith

public boolean endsWith(Name n)

Определяет, является ли составное имя суффиксом этого составного имени. Составное имя 'n' является суффиксом, если оно равно getSuffix(size()-n.size()) — другими словами, это составное имя заканчивается на 'n'. Если n равно null или не является составным именем, возвращается false.

Указано в:: endsWith в интерфейсе Name
Параметры:: n - Возможно null составное имя для проверки.
Возвращает:: true, если n является CompoundName и является суффиксом этого составного имени, в противном случае false.

addAll

public Name addAll(Name suffix) throws InvalidNameException

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

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

Указано в:: addAll в интерфейсе Name
Параметры:: suffix - Не null компоненты для добавления.
Возвращает:: Обновлённое составное имя, а не новое. Не может быть null.
Исключения:: InvalidNameException - Если suffix не является составным именем или добавление компонентов нарушает синтаксис этого составного имени (например, превышение количества компонентов).

addAll

public Name addAll(int posn, Name n) throws InvalidNameException

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

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

add

public Name add(String comp) throws InvalidNameException

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

Указано в:: add в интерфейсе Name
Параметры:: comp - Не null компонент для добавления.
Возвращает:: Обновлённое составное имя, а не новое. Не может быть null.
Исключения:: InvalidNameException - Если добавление comp в конец имени нарушает синтаксис составного имени.

add

public Name add(int posn, String comp) throws InvalidNameException

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

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

remove

public Object remove(int posn) throws InvalidNameException

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

Указано в:: remove в интерфейсе Name
Параметры:: posn - Индекс компонента для удаления. Должен быть в диапазоне [0,size()).
Возвращает:: Удаленный компонент (строка).
Исключения:: 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://download.java.net/java/early_access/jdk24/docs/api/java.naming/javax/naming/CompoundName.html