LdapName (Платформа Java SE 7)

java.lang. Объект
- javax.naming.ldap. LdapName

Все Реализованные Интерфейсы:

Сериализуемый, Cloneable, Сопоставимый <Объект>, Имя
```
public class LdapName
extends Object
implements Name
```
Этот класс представляет отличительное имя как определено RFC 2253. Отличительное имя, или DN, составляется из упорядоченного списка компонентов, названных относительными отличительными именами, или RDNs. Детали синтаксиса DN описываются в RFC 2253.
Этот класс разрешает несколько неоднозначностей, найденных в RFC 2253 следующим образом:
- Листы RFC 2253 термин неопределенный "пробел". Пробел 0x20 ASCII (" ") используется в его месте.
- По обе стороны от пробела позволяют',', ';', '=', и '+'. Такой пробел принимается, но не сгенерировался этим кодом, и игнорируется, сравнивая имена.
- Строки AttributeValue, содержащие '=' или неведущие '#' символы, которых (неоставляют), принимаются.
Названия строк, к которым передают LdapName или возвратился этим, используют полный набор символов Unicode. Они могут также содержать символы, закодированные в UTF-8 с каждым октетом, представленным трехсимвольной подстрокой такой как "\\B4". Они, возможно, не, однако, содержат символы, закодированные в UTF-8 с каждым октетом, представленным единственным символом в строке: значение было бы неоднозначно.
LdapName должным образом проанализирует все допустимые имена, но не пытается обнаружить все возможные нарушения, анализируя недопустимые имена. Это "щедро" в принятии недопустимых имен. "Законность" имени определяется в конечном счете, когда она предоставляется серверу LDAP, который может принять или отклонить имя, основанное на факторах, таких как его соображения информации и функциональной совместимости схемы.
Когда имена тестируются на равенство, приписывают типы, и двоичный файл и представляют значения в виде строки, являются нечувствительными к регистру. Строковые значения с различным но эквивалентным использованием заключения в кавычки, выхода, или UTF8-hex-encoding считают равными. Порядок компонентов в многозначном RDNs (таких как "ou=Sales+cn=Bob") не является существенным.
Компоненты имени LDAP, то есть, RDNs, нумеруются. Индексы LDAP называют с n RDNs диапазон от 0 до n-1. Этот диапазон может быть записан как [0, n). Право, которое большинство RDN по индексу 0, и покинутым большинство RDN, по индексу n-1. Например, отличительное имя: "CN=Steve Kille, O=Isode Limited, C=GB" нумеруются в следующей последовательности в пределах от от 0 до 2: {C=GB, O=Isode Limited, CN=Steve Kille}. Пустое имя LDAP представляется пустым списком RDN.
Параллельный многопоточный доступ только для чтения экземпляра LdapName не должен синхронизироваться.
Если не указано иное, поведение передачи нулевого параметра конструктору или методу в этом классе заставит NullPointerException быть брошенным.
С тех пор:

1.5

См. Также:
Сериализированная Форма

Сводка конструктора

Конструкторы
Конструктор и Описание
`LdapName(List<Rdn> rdns)` Создает имя LDAP, данное его проанализированные компоненты RDN.
`LdapName(String name)` Создает имя LDAP из данного отличительного имени.

Сводка метода

Методы
Модификатор и Тип	Метод и Описание
`Имя`	`add(int posn, Rdn comp)` Добавляет единственный RDN в указанной позиции в пределах этого имени LDAP.
`Имя`	`add(int posn, String comp)` Добавляет единственный компонент в указанной позиции в пределах этого имени LDAP.
`Имя`	`add(Rdn comp)` Добавляет единственный RDN до конца этого имени LDAP.
`Имя`	`add(String comp)` Добавляет единственный компонент до конца этого имени LDAP.
`Имя`	`addAll(int posn, List<Rdn> suffixRdns)` Добавляет RDNs имени - в порядке - в указанной позиции в пределах этого имени.
`Имя`	`addAll(int posn, Name suffix)` Добавляют компоненты имени - в порядке - в указанной позиции в пределах этого имени.
`Имя`	`addAll(List<Rdn> suffixRdns)` Добавляет RDNs имени - в порядке - до конца этого имени.
`Имя`	`addAll(Name suffix)` Добавляют компоненты имени - в порядке - до конца этого имени.
`Объект`	`clone()` Генерирует новую копию этого имени.
`int`	`compareTo(Object obj)` Сравнивает этот LdapName с указанным Объектом для порядка.
`boolean`	`endsWith(List<Rdn> rdns)` Определяет, формирует ли указанная последовательность RDN суффикс этого имени LDAP.
`boolean`	`endsWith(Name n)` Определяет, называет ли этот LDAP концы с указанным суффиксом имени LDAP.
`boolean`	`equals(Object obj)` Определяет, равны ли два имени LDAP.
`Строка`	`get(int posn)` Получает компонент этого имени LDAP как строка.
`Enumeration<String>`	`getAll()` Получает компоненты этого имени как перечисление строк.
`Имя`	`getPrefix(int posn)` Создает имя, компоненты которого состоят из префикса компонентов этого имени LDAP.
`Rdn`	`getRdn(int posn)` Получает RDN этого имени LDAP как Rdn.
`List<Rdn>`	`getRdns()` Получает список относительных отличительных имен.
`Имя`	`getSuffix(int posn)` Создает имя, компоненты которого состоят из суффикса компонентов на это имя LDAP.
`int`	`hashCode()` Вычисляет хэш-код этого имени LDAP.
`boolean`	`isEmpty()` Определяет, пусто ли это имя LDAP.
`Объект`	`remove(int posn)` Удаляет компонент из этого имени LDAP.
`int`	`size()` Получает число компонентов на это имя LDAP.
`boolean`	`startsWith(List<Rdn> rdns)` Определяет, формирует ли указанная последовательность RDN префикс этого имени LDAP.
`boolean`	`startsWith(Name n)` Определяет, запускается ли это имя LDAP с указанного префикса имени LDAP.
`Строка`	`toString()` Возвращает строковое представление этого имени LDAP в формате, определенном RFC 2253, и описал в описании класса.

Методы java.lang унаследованный от класса. Объект
finalize, getClass, notify, notifyAll, wait, wait, wait

- Деталь конструктора
  - LdapName
```
public LdapName(String name)
         throws InvalidNameException
```
    Создает имя LDAP из данного отличительного имени.
    
    Параметры:
    name - Это - ненулевое отличительное имя, отформатированное согласно правилам, определенным в RFC 2253.
    
    Броски:
    
    InvalidNameException - если нарушение синтаксиса обнаруживается.
    См. Также:
    Rdn.escapeValue(Object value)
  - LdapName
```
public LdapName(List<Rdn> rdns)
```
    Создает имя LDAP, данное его проанализированные компоненты RDN.
    Индексация RDNs в списке следует за нумерацией RDNs, описанного в описании класса.
    
    Параметры:
    rdns - Ненулевой список Rdn s формирующий это имя LDAP.
- Деталь метода
  - размер
```
public int size()
```
    Получает число компонентов на это имя LDAP.
    
    Определенный:
    
    size в интерфейсе Name
    
    Возвраты:
    Неотрицательное число компонентов на это имя LDAP.
  - isEmpty
```
public boolean isEmpty()
```
    Определяет, пусто ли это имя LDAP. Пустое название один с нулевыми компонентами.
    
    Определенный:
    
    isEmpty в интерфейсе Name
    
    Возвраты:
    истина, если это имя LDAP пусто, ложно иначе.
  - getAll
```
public Enumeration<String> getAll()
```
    Получает компоненты этого имени как перечисление строк. Эффект обновлений к этому имени на этом перечислении неопределен. Если у имени есть нулевые компоненты, пустое (ненулевое) перечисление возвращается. Порядок компонентов, возвращенных перечислением, является тем же самым как порядок, в котором компоненты нумеруются как описано в описании класса.
    
    Определенный:
    
    getAll в интерфейсе Name
    
    Возвраты:
    Ненулевое перечисление компонентов этого имени LDAP. Каждый элемент перечисления имеет Строку класса.
  - добраться
```
public String get(int posn)
```
    Получает компонент этого имени LDAP как строка.
    
    Определенный:
    
    get в интерфейсе Name
    
    Параметры:
    posn - Индекс на основе 0 компонента, чтобы получить. Должен быть в диапазоне [0, размер ()).
    
    Возвраты:
    Ненулевой компонент по индексу posn.
    
    Броски:
    
    IndexOutOfBoundsException - если posn вне указанного диапазона.
  - getRdn
```
public Rdn getRdn(int posn)
```
    Получает RDN этого имени LDAP как Rdn.
    
    Параметры:
    posn - Индекс на основе 0 RDN, чтобы получить. Должен быть в диапазоне [0, размер ()).
    
    Возвраты:
    Ненулевой RDN по индексу posn.
    
    Броски:
    
    IndexOutOfBoundsException - если posn вне указанного диапазона.
  - getPrefix
```
public Name getPrefix(int posn)
```
    Создает имя, компоненты которого состоят из префикса компонентов этого имени LDAP. Последующие изменения к этому имени не будут влиять на имя, которое возвращается и наоборот.
    
    Определенный:
    
    getPrefix в интерфейсе Name
    
    Параметры:
    posn - Индекс на основе 0 компонента, в котором можно остановиться. Должен быть в диапазоне [0, размер ()].
    
    Возвраты:
    Экземпляр LdapName, состоящего из компонентов по индексам в диапазоне [0, posn). Если posn является нулем, пустое имя LDAP возвращается.
    
    Броски:
    
    IndexOutOfBoundsException - Если posn вне указанного диапазона.
  - getSuffix
```
public Name getSuffix(int posn)
```
    Создает имя, компоненты которого состоят из суффикса компонентов на это имя LDAP. Последующие изменения к этому имени не влияют на имя, которое возвращается и наоборот.
    
    Определенный:
    
    getSuffix в интерфейсе Name
    
    Параметры:
    posn - Индекс на основе 0 компонента, в котором можно запустить. Должен быть в диапазоне [0, размер ()].
    
    Возвраты:
    Экземпляр LdapName, состоящего из компонентов по индексам в диапазоне [posn, размер ()). Если posn равен размеру (), пустое имя LDAP возвращается.
    
    Броски:
    
    IndexOutOfBoundsException - Если posn вне указанного диапазона.
  - startsWith
```
public boolean startsWith(Name n)
```
    Определяет, запускается ли это имя LDAP с указанного префикса имени LDAP. Имя n является префиксом, если это равно getPrefix(n.size()) - другими словами это имя LDAP, запускается с 'n'. Если n является нулем или не RFC2253 отформатированное имя как описано в описании класса, false возвращается.
    
    Определенный:
    
    startsWith в интерфейсе Name
    
    Параметры:
    n - LDAP называют к проверке.
    
    Возвраты:
    истина, если n является префиксом этого имени LDAP, ложь иначе.
    См. Также:
    getPrefix(int posn)
  - startsWith
```
public boolean startsWith(List<Rdn> rdns)
```
    Определяет, формирует ли указанная последовательность RDN префикс этого имени LDAP. Возвращает true, если этот LdapName, по крайней мере, пока rdns, и для каждой позиции p в диапазоне [0, rdns.size ()), компонент getRdn (p) соответствует rdns.get (p). Возвращает false иначе. Если rdns является нулем, false возвращается.
    
    Параметры:
    rdns - Последовательность Rdn s, чтобы проверить.
    
    Возвраты:
    истина, если форма rdns префикс этого имени LDAP, ложь иначе.
  - endsWith
```
public boolean endsWith(Name n)
```
    Определяет, называет ли этот LDAP концы с указанным суффиксом имени LDAP. n имени является суффиксом, если это равно getSuffix(size()-n.size()) - другими словами это имя LDAP концы с 'n'. Если n является нулем или не RFC2253 отформатированное имя как описано в описании класса, false возвращается.
    
    Определенный:
    
    endsWith в интерфейсе Name
    
    Параметры:
    n - LDAP называют к проверке.
    
    Возвраты:
    истина, если n является суффиксом этого имени, ложь иначе.
    См. Также:
    getSuffix(int posn)
  - endsWith
```
public boolean endsWith(List<Rdn> rdns)
```
    Определяет, формирует ли указанная последовательность RDN суффикс этого имени LDAP. Возвращает true, если этот LdapName, по крайней мере, пока rdns, и для каждой позиции p в диапазоне [размер () - rdns.size (), размер ()), компонент getRdn (p) соответствует rdns.get (p). Возвращает false иначе. Если rdns является нулем, false возвращается.
    
    Параметры:
    rdns - Последовательность Rdn s, чтобы проверить.
    
    Возвраты:
    истина, если форма rdns суффикс этого имени LDAP, ложь иначе.
  - addAll
```
public Name addAll(Name suffix)
            throws InvalidNameException
```
    Добавляют компоненты имени - в порядке - до конца этого имени.
    
    Определенный:
    
    addAll в интерфейсе Name
    
    Параметры:
    suffix - Ненулевые компоненты, чтобы добавить.
    
    Возвраты:
    Обновленное имя (не новый экземпляр).
    
    Броски:
    
    InvalidNameException - если suffix не является допустимым именем LDAP, или если бы добавление компонентов нарушило бы правила синтаксиса этого имени LDAP.
  - addAll
```
public Name addAll(List<Rdn> suffixRdns)
```
    Добавляет RDNs имени - в порядке - до конца этого имени.
    
    Параметры:
    suffixRdns - Ненулевой суффиксный Rdn s, чтобы добавить.
    
    Возвраты:
    Обновленное имя (не новый экземпляр).
  - addAll
```
public Name addAll(int posn,
          Name suffix)
            throws InvalidNameException
```
    Добавляют компоненты имени - в порядке - в указанной позиции в пределах этого имени. Компоненты этого LDAP называют в или после того, как индекс (если кто-либо) первого нового компонента смещается (далеко от индекса 0), чтобы разместить новые компоненты.
    
    Определенный:
    
    addAll в интерфейсе Name
    
    Параметры:
    suffix - Ненулевые компоненты, чтобы добавить.
    posn - Индекс, по которому можно добавить новый компонент. Должен быть в диапазоне [0, размер ()].
    
    Возвраты:
    Обновленное имя (не новый экземпляр).
    
    Броски:
    
    InvalidNameException - если suffix не является допустимым именем LDAP, или если бы добавление компонентов нарушило бы правила синтаксиса этого имени LDAP.
    
    IndexOutOfBoundsException. - Если posn вне указанного диапазона.
  - addAll
```
public Name addAll(int posn,
          List<Rdn> suffixRdns)
```
    Добавляет RDNs имени - в порядке - в указанной позиции в пределах этого имени. RDNs этого LDAP называют в или после того, как индекс (если кто-либо) первого нового RDN смещается (далеко от индекса 0), чтобы разместить новый RDNs.
    
    Параметры:
    suffixRdns - Ненулевой суффиксный Rdn s, чтобы добавить.
    posn - Индекс, по которому можно добавить суффиксный RDNs. Должен быть в диапазоне [0, размер ()].
    
    Возвраты:
    Обновленное имя (не новый экземпляр).
    
    Броски:
    
    IndexOutOfBoundsException. - Если posn вне указанного диапазона.
  - добавить
```
public Name add(String comp)
         throws InvalidNameException
```
    Добавляет единственный компонент до конца этого имени LDAP.
    
    Определенный:
    
    add в интерфейсе Name
    
    Параметры:
    comp - Ненулевой компонент, чтобы добавить.
    
    Возвраты:
    Обновленный LdapName, не новый экземпляр. Не может быть нуль.
    
    Броски:
    
    InvalidNameException - Если добавление аккомпанемента в конце имени нарушило бы синтаксис имени.
  - добавить
```
public Name add(Rdn comp)
```
    Добавляет единственный RDN до конца этого имени LDAP.
    
    Параметры:
    comp - Ненулевой RDN, чтобы добавить.
    
    Возвраты:
    Обновленный LdapName, не новый экземпляр. Не может быть нуль.
  - добавить
```
public Name add(int posn,
       String comp)
         throws InvalidNameException
```
    Добавляет единственный компонент в указанной позиции в пределах этого имени LDAP. Компоненты этого LDAP называют в или после того, как индекс (если кто-либо) нового компонента смещается одним (далеко от индекса 0), чтобы разместить новый компонент.
    
    Определенный:
    
    add в интерфейсе Name
    
    Параметры:
    comp - Ненулевой компонент, чтобы добавить.
    posn - Индекс, по которому можно добавить новый компонент. Должен быть в диапазоне [0, размер ()].
    
    Возвраты:
    Обновленный LdapName, не новый экземпляр. Не может быть нуль.
    
    Броски:
    
    IndexOutOfBoundsException. - Если posn вне указанного диапазона.
    
    InvalidNameException - Если добавление аккомпанемента в указанной позиции нарушило бы синтаксис имени.
  - добавить
```
public Name add(int posn,
       Rdn comp)
```
    Добавляет единственный RDN в указанной позиции в пределах этого имени LDAP. RDNs этого LDAP называют в или после того, как индекс (если кто-либо) нового RDN смещается одним (далеко от индекса 0), чтобы разместить новый RDN.
    
    Параметры:
    comp - Ненулевой RDN, чтобы добавить.
    posn - Индекс, по которому можно добавить новый RDN. Должен быть в диапазоне [0, размер ()].
    
    Возвраты:
    Обновленный LdapName, не новый экземпляр. Не может быть нуль.
    
    Броски:
    
    IndexOutOfBoundsException - Если posn вне указанного диапазона.
  - удалить
```
public Object remove(int posn)
              throws InvalidNameException
```
    Удаляет компонент из этого имени LDAP. Компонент этого имени в указанной позиции удаляется. Компоненты с индексами, больше чем эта позиция (если кто-либо), смещаются вниз (к индексу 0) одним.
    
    Определенный:
    
    remove в интерфейсе Name
    
    Параметры:
    posn - Индекс компонента, чтобы удалить. Должен быть в диапазоне [0, размер ()).
    
    Возвраты:
    Удаленный компонент (Строка).
    
    Броски:
    
    IndexOutOfBoundsException - если posn вне указанного диапазона.
    
    InvalidNameException - если удаление компонента нарушило бы правила синтаксиса имени.
  - getRdns
```
public List<Rdn> getRdns()
```
    Получает список относительных отличительных имен. Содержание списка является неподдающимся изменению. Индексация RDNs в возвращенном списке следует за нумерацией RDNs как описано в описании класса. Если у имени есть нулевые компоненты, пустой список возвращается.
    
    Возвраты:
    Имя как список RDNs, которые являются экземплярами класса Rdn.
  - клон
```
public Object clone()
```
    Генерирует новую копию этого имени. Последующие изменения к компонентам этого имени не будут влиять на новую копию, и наоборот.
    
    Определенный:
    
    clone в интерфейсе Name
    
    Переопределения:
    
    clone в классе Object
    
    Возвраты:
    Копия этого имени LDAP.
    См. Также:
    Cloneable
  - toString
```
public String toString()
```
    Возвращает строковое представление этого имени LDAP в формате, определенном RFC 2253, и описал в описании класса. Если у имени есть нулевые компоненты возвращается, пустая строка.
    
    Переопределения:
    
    toString в классе Object
    
    Возвраты:
    Строковое представление LdapName.
  - равняется
```
public boolean equals(Object obj)
```
    Определяет, равны ли два имени LDAP. Если obj является нулем или не именем LDAP, false возвращается.
    Два имени LDAP равны, если каждый RDN в каждый равен соответствующему RDN в другом. Это подразумевает, и имейте то же самое число RDNs, и каждый RDN's равняется (), тест против соответствующего RDN на другое имя возвращает true. См. Rdn.equals(Object obj) для определения равенства RDN.
    
    Переопределения:
    
    equals в классе Object
    
    Параметры:
    obj - Возможно нуль возражают, чтобы сравниться с.
    
    Возвраты:
    истина, если obj равен этому имени LDAP, ложь иначе.
    См. Также:
    hashCode()
  - compareTo
```
public int compareTo(Object obj)
```
    Сравнивает этот LdapName с указанным Объектом для порядка. Возвращает отрицательное целое число, нуль, или положительное целое число, поскольку это Имя является меньше чем, равный, или больше чем данный Объект.
    Если obj является нулем или не экземпляром LdapName, ClassCastException бросается.
    Упорядочивание имен LDAP следует за лексикографическими правилами для сравнения строк с расширением, что это применяется ко всему RDNs на имя LDAP. Все RDNs выстраиваются в линию в их указанном порядке и сравниваются лексикографически. См. Rdn.compareTo(Object obj) для правил сравнения RDN.
    Если это имя LDAP лексикографически меньше чем obj, отрицательное число возвращается. Если это имя LDAP лексикографически больше чем obj, положительное число возвращается.
    
    Определенный:
    
    compareTo в интерфейсе Comparable<Object>
    
    Определенный:
    
    compareTo в интерфейсе Name
    
    Параметры:
    obj - Ненулевой экземпляр LdapName, чтобы сравниться с.
    
    Возвраты:
    Отрицательное целое число, нуль, или положительное целое число как это Имя являются меньше чем, равный, или больше чем данный obj.
    
    Броски:
    
    ClassCastException - если obj является нулем или не LdapName.
    См. Также:
    Comparable.compareTo(Object)
  - хэш-код
```
public int hashCode()
```
    Вычисляет хэш-код этого имени LDAP. Хэш-код является суммой хэш-кодов отдельного RDNs этого имени.
    
    Переопределения:
    
    hashCode в классе Object
    
    Возвраты:
    Интервал, представляющий хэш-код этого имени.
    См. Также:
    equals(java.lang.Object)

Представьте ошибку или функцию
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2011, Oracle и/или его филиалы. Все права защищены.

Класс LdapName

Сводка конструктора

Сводка метода

Методы java.lang унаследованный от класса. Объект

Деталь конструктора

LdapName

LdapName

Деталь метода

размер

isEmpty

getAll

добраться

getRdn

getPrefix

getSuffix

startsWith

startsWith

endsWith

endsWith

addAll

addAll

addAll

addAll

добавить

добавить

добавить

добавить

удалить

getRdns

клон

toString

равняется

compareTo

хэш-код