Класс CompositeName

java.lang.Object

javax.naming.CompositeName

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

public class CompositeName extends Object implements Name

Этот класс представляет составное имя — последовательность имён компонентов, охватывающих несколько пространств имён. Каждый компонент — это строковое имя из пространства имён системы именования. Если компонент происходит из иерархического пространства имён, этот компонент можно дополнительно разбить на атомарные части, используя класс CompoundName.

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

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

JNDI определяет стандартное строковое представление составных имён. Это представление — конкатенация компонентов составного имени слева направо, используя разделитель компонентов (символ слэша /) для разделения каждого компонента. Синтаксис JNDI определяет следующие метасимволы:

экранирование (обратный слэш \),
символы кавычек (одинарная (') и двойная кавычки (")), и
разделитель компонентов (символ слэша /).

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

При сравнении двух составных имён регистр символов учитывается.

Ведущая косая черта (строка составного имени начинается с разделителя) обозначает ведущий пустой компонент (компонент, состоящий из пустой строки). Завершающая косая черта (строка составного имени заканчивается разделителем) обозначает завершающий пустой компонент. Соседние разделители компонентов обозначают пустой компонент.

Примеры составных имён

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

примеры, показывающие строковую форму составного имени и его соответствующую структурную форму (CompositeName)
Строковое имя	CompositeName
""	{} (пустое имя == new CompositeName("") == new CompositeName())
"x"	{"x"}
"x/y"	{"x", "y"}
"x/"	{"x", ""}
"/x"	{"", "x"}
"/"	{""}
"//"	{"", ""}
"/x/"	{"", "x", ""}
"x//y"	{"x", "", "y"}

Примеры составления

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

примеры составления, показывающие строковые имена и составные имена
Строковые имена	Составные имена
"x/y" + "/" = x/y/	{"x", "y"} + {""} = {"x", "y", ""}
"" + "x" = "x"	{} + {"x"} = {"x"}
"/" + "x" = "/x"	{""} + {"x"} = {"", "x"}
"x" + "" + "" = "x"	{"x"} + {} + {} = {"x"}

Доступ в многопоточных средах

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

С:

1.3

См. также:

Сериализованная форма

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

CompositeName()

CompositeName(String n)

CompositeName(Enumeration<String> comps)

Модификатор	Конструктор	Описание
	Создаёт новое пустое составное имя.
	Создаёт новый экземпляр составного имени, анализируя строку 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)`	Сравнивает это CompositeName с указанным объектом для определения порядка.
`boolean`	`endsWith(Name n)`	Определяет, является ли составное имя суффиксом этого составного имени.
`boolean`	`equals(Object 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

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

CompositeName

protected CompositeName(Enumeration<String> comps)

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

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

CompositeName

public CompositeName(String n) throws InvalidNameException

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

Параметры:: n - Непустая строка для анализа.
Исключения:: InvalidNameException - Если n имеет недопустимый синтаксис составного имени.

CompositeName

public CompositeName()

Создаёт новое пустое составное имя. Такое имя возвращает true, когда isEmpty() вызывается на нём.

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

toString

public String toString()

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

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

equals

public boolean equals(Object obj)

Определяет, равны ли два составных имени. Если obj равен null или не является составным именем, возвращается false. Два составных имени равны, если каждый компонент в одном равен соответствующему компоненту в другом. Это подразумевает, что у обоих одинаковое количество компонентов, и тест equals() для каждого компонента с соответствующим компонентом в другом имени возвращает true.

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

equals в классе Object

Параметры:

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

Возвращает:

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

См. также:

hashCode()

hashCode

public int hashCode()

Вычисляет код хэша этого составного имени. Код хэша представляет собой сумму кодов хэша отдельных компонентов этого составного имени.

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

hashCode в классе Object

Возвращает:

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

См. также:

equals(java.lang.Object)

compareTo

public int compareTo(Object obj)

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

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

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

Порядок составных имён соответствует лексикографическим правилам сравнения строк, с расширением, что это применяется ко всем компонентам составного имени. Эффект такой, как если бы все компоненты были выстроены в указанном порядке, и лексикографические правила применялись к двум последовательностям. Если это составное имя "лексикографически" меньше obj, возвращается отрицательное число. Если это составное имя "лексикографически" больше obj, возвращается положительное число.

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

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

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

См. также:

Comparable.compareTo(Object)

clone

public Object clone()

Генерирует копию этого составного имени. Изменения в компонентах этого составного имени не повлияют на новую копию и наоборот.

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

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

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

clone в классе Object

Возвращает:

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

См. также:

Cloneable

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.

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

endsWith

public boolean endsWith(Name n)

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

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

addAll

public Name addAll(Name suffix) throws InvalidNameException

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

Specified by:: addAll в интерфейсе Name
Parameters:: suffix - Добавляемые компоненты, не равные null.
Returns:: Обновленное CompositeName, а не новое. Не может быть null.
Throws:: InvalidNameException - Если суффикс не является составным именем.

addAll

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

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

Specified by:: addAll в интерфейсе Name
Parameters:: n - Добавляемые компоненты, не равные null.; posn - Индекс в этом имени, на котором нужно добавить новые компоненты. Должен быть в диапазоне [0, size()].
Returns:: Обновленное CompositeName, а не новое. Не может быть null.
Throws:: InvalidNameException - Если n не является составным именем.; ArrayIndexOutOfBoundsException - Если posn находится вне заданного диапазона.

add

public Name add(String comp) throws InvalidNameException

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

Specified by:: add в интерфейсе Name
Parameters:: comp - Добавляемый компонент, не равный null.
Returns:: Обновленное CompositeName, а не новое. Не может быть null.
Throws:: InvalidNameException - Если добавление comp в конец имени нарушит синтаксис имени.

add

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

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

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

remove

public Object remove(int posn) throws InvalidNameException

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

Specified by:: remove в интерфейсе Name
Parameters:: posn - Индекс компонента для удаления. Должен быть в диапазоне [0, size()).
Returns:: Удаленный компонент (String).
Throws:: 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/CompositeName.html