Spec-Zone.ru › OpenJDK 8

Класс SortKey

  • java.lang.Object
    • javax.naming.ldap.SortKey

public class SortKey
extends Object

Ключ сортировки и связанные с ним параметры сортировки. Этот класс реализует ключ сортировки, который используется LDAPv3-управлением для сортировки результатов поиска на стороне сервера, как определено в RFC 2891.

Since:
1.5
См. также:
SortControl

Конструкторы

Конструктор и описание
SortKey(String attrID)

Создаёт ключ сортировки по умолчанию для атрибута.

SortKey(String attrID, boolean ascendingOrder, String matchingRuleID)

Создаёт ключ сортировки для атрибута.

Методы

Модификатор и тип Метод и описание
String getAttributeID()

Возвращает идентификатор атрибута ключа сортировки.

String getMatchingRuleID()

Возвращает идентификатор правила сопоставления, используемого для упорядочения значений атрибута.

boolean isAscending()

Определяет порядок сортировки.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Конструкторы

SortKey

public SortKey(String attrID)

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

Параметры:
attrID - Непустой идентификатор атрибута, используемый в качестве ключа сортировки.

SortKey

public SortKey(String attrID,
               boolean ascendingOrder,
               String matchingRuleID)

Создаёт ключ сортировки для атрибута. Элементы будут отсортированы по указанному атрибуту в указанном порядке сортировки и с использованием указанного правила сопоставления, если оно указано.

Параметры:
attrID - Непустой идентификатор атрибута, используемый в качестве ключа сортировки.
ascendingOrder - Если true, то элементы упорядочены по возрастанию. В противном случае по убыванию.
matchingRuleID - Возможный null-идентификатор правила сопоставления для упорядочивания значений атрибута. Если не указан, то используется правило сопоставления для упорядочивания, определённое для атрибута ключа сортировки.

Методы

getAttributeID

public String getAttributeID()

Возвращает идентификатор атрибута ключа сортировки.

Возвращает:
Непустой идентификатор атрибута ключа сортировки.

isAscending

public boolean isAscending()

Определяет порядок сортировки.

Возвращает:
true, если порядок сортировки восходящий, false — если нисходящий.

getMatchingRuleID

public String getMatchingRuleID()

Возвращает идентификатор правила сопоставления, используемого для упорядочения значений атрибута.

Возвращает:
Возможный null-идентификатор правила сопоставления. Если null, то используется правило сопоставления для упорядочивания, определённое для атрибута ключа сортировки.

© 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API