Spec-Zone.ru › OpenJDK 17

Класс SortKey

java.lang.Object
javax.naming.ldap.SortKey
public class SortKey extends Object
Ключ сортировки и связанные с ним параметры сортировки. Этот класс реализует ключ сортировки, используемый LDAPv3-управлением для сортировки результатов поиска на сервере, как определено в RFC 2891.
С момента:
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 - Возможно, нулевой идентификатор правила сопоставления для упорядочения значений атрибута. Если не указан, используется правило сопоставления упорядочения, определённое для атрибута ключа сортировки.

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

getAttributeID

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

isAscending

public boolean isAscending()
Определяет порядок сортировки.
Возвращает:
true, если порядок сортировки возрастающий, false – если убывающий.

getMatchingRuleID

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

© 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/ldap/SortKey.html

Spec-Zone.ru

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