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

public interface Name
extends Cloneable, Serializable, Comparable<Object>

Интерфейс Name представляет собой общее имя — упорядоченную последовательность компонентов. Это может быть составное имя (имена, охватывающие несколько пространств имён) или составное имя (имена, используемые в отдельных иерархических системах именования).

Может быть несколько реализаций Name; например, составные имена, URL-адреса или имена, специфичные для определённого пространства имён.

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

Ни один из методов этого интерфейса не принимает null в качестве допустимого значения для параметра, являющегося именем или компонентом имени. Аналогично, методы, возвращающие имя или компонент имени, никогда не возвращают null.

Экземпляр Name может не быть синхронизирован против одновременного доступа нескольких потоков, если этот доступ не является только чтением.

Поля

serialVersionUID

static final long serialVersionUID

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

См. также:

Значения константных полей

Методы

clone

Object clone()

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

Возвращает:

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

См. также:

Object.clone()

compareTo

int compareTo(Object obj)

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

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 - если удаление компонента нарушает правила синтаксиса имени