Spec-Zone.ru › OpenJDK 17

Класс SearchControls

java.lang.Object
javax.naming.directory.SearchControls
Все реализуемые интерфейсы:
Serializable
public class SearchControls extends Object implements Serializable
Этот класс инкапсулирует факторы, определяющие область поиска и то, что возвращается в результате поиска.

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

С тех пор:
1.3
См. также:
  • Сериализованная форма

Краткое описание полей

Модификатор и тип Поле Описание
static final int OBJECT_SCOPE
Поиск по заданному объекту.
static final int ONELEVEL_SCOPE
Поиск на одном уровне от заданного контекста.
static final int SUBTREE_SCOPE
Поиск по всему поддереву, укорененному в заданном объекте.

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

Конструктор Описание
SearchControls()
Конструирует ограничения поиска, используя значения по умолчанию.
SearchControls(int scope, long countlim, int timelim, String[] attrs, boolean retobj, boolean deref)
Конструирует ограничения поиска, используя аргументы.

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

Модификатор и тип Метод Описание
long getCountLimit()
Возвращает максимальное количество записей, которые будут возвращены в результате поиска.
boolean getDerefLinkFlag()
Определяет, будут ли ссылки разыменовываться во время поиска.
String[] getReturningAttributes()
Возвращает атрибуты, которые будут возвращены в рамках поиска.
boolean getReturningObjFlag()
Определяет, будут ли возвращены объекты в качестве части результата.
int getSearchScope()
Возвращает область поиска этих SearchControls.
int getTimeLimit()
Возвращает лимит времени этих SearchControls в миллисекундах.
void setCountLimit(long limit)
Устанавливает максимальное количество записей, которые должны быть возвращены в результате поиска.
void setDerefLinkFlag(boolean on)
Включает/выключает разыменование ссылок во время поиска.
void setReturningAttributes(String[] attrs)
Указывает атрибуты, которые будут возвращены в рамках поиска.
void setReturningObjFlag(boolean on)
Включает/выключает возврат объектов в качестве части результата.
void setSearchScope(int scope)
Устанавливает область поиска на одну из: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.
void setTimeLimit(int ms)
Устанавливает лимит времени этих SearchControls в миллисекундах.

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

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

Подробное описание полей

OBJECT_SCOPE

public static final int OBJECT_SCOPE
Поиск по указанному объекту.

NamingEnumeration, полученная в результате вызова search() с OBJECT_SCOPE, будет содержать один или ноль элементов. Перечисление содержит один элемент, если указанный объект соответствует фильтру поиска, заданному в search(). Элемент будет иметь пустое имя, поскольку имена элементов в NamingEnumeration относительны к контексту цели – в данном случае, целевой контекст – это указанный объект. Перечисление содержит ноль элементов, если указанный объект не соответствует фильтру поиска, заданному в search().

Значение этой константы равно 0.

См. также:
  • Значения константных полей

ONELEVEL_SCOPE

public static final int ONELEVEL_SCOPE
Поиск на одном уровне от указанного контекста.

NamingEnumeration, полученная в результате вызова search() с ONELEVEL_SCOPE, содержит элементы с объектами в указанном контексте, которые удовлетворяют фильтру поиска, заданному в search(). Имена элементов в NamingEnumeration являются атомарными именами, относительными к указанному контексту.

Значение этой константы равно 1.

См. также:
  • Значения константных полей

SUBTREE_SCOPE

public static final int SUBTREE_SCOPE
Поиск по всему поддереву, укоренённому в указанном объекте.

Если указанный объект не является DirContext, ищется только сам объект. Если указанный объект является DirContext, ищется поддерево, укоренённое в указанном объекте, включая сам объект.

Поиск не будет пересекать границы системы именования.

NamingEnumeration, полученная в результате вызова search() с SUBTREE_SCOPE, содержит элементы объектов из поддерева (включая сам контекст), удовлетворяющие фильтру поиска, заданному в search(). Имена элементов в NamingEnumeration либо относительны к указанному контексту, либо являются строкой URL. Если указанный контекст удовлетворяет фильтру поиска, он включается в перечисление с пустым именем.

Значение этой константы равно 2.

См. также:
  • Значения константных полей

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

SearchControls

public SearchControls()
Создаёт ограничения поиска с использованием значений по умолчанию.

Значения по умолчанию:

  • поиск на одном уровне
  • нет ограничения на максимальное количество возвращаемых результатов поиска
  • нет ограничения по времени на поиск
  • возвращаются все атрибуты, связанные с объектами, удовлетворяющими фильтру поиска.
  • указанный объект не возвращается (возвращаются только имя и класс)
  • ссылки не разрешаются во время поиска

SearchControls

public SearchControls(int scope, long countlim, int timelim, String[] attrs, boolean retobj, boolean deref)
Создаёт ограничения поиска с использованием аргументов.
Параметры:
scope - Область поиска. Одно из: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.
timelim - Количество миллисекунд ожидания перед возвращением. Если 0, ожидание неограниченное.
deref - Если true, разрешаются ссылки во время поиска.
countlim - Максимальное количество записей для возврата. Если 0, возвращаются все записи, удовлетворяющие фильтру.
retobj - Если true, возвращается объект, связанный с именем записи; если false, объект не возвращается.
attrs - Идентификаторы атрибутов для возврата вместе с записью. Если null, возвращаются все атрибуты. Если пусто, атрибуты не возвращаются.

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

getSearchScope

public int getSearchScope()
Возвращает область поиска этих SearchControls.

Одно из OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.

Возвращает:
Область поиска этого SearchControls.
См. также:
  • setSearchScope(int)

getTimeLimit

public int getTimeLimit()
Возвращает лимит времени этих SearchControls в миллисекундах.

Если значение равно 0, ожидание неограниченное.

Возвращает:
Лимит времени этих SearchControls в миллисекундах.
См. также:
  • setTimeLimit(int)

getDerefLinkFlag

public boolean getDerefLinkFlag()
Определяет, будут ли разрешаться ссылки во время поиска.
Возвращает:
true, если ссылки будут разрешаться; false в противном случае.
См. также:
  • setDerefLinkFlag(boolean)

getReturningObjFlag

public boolean getReturningObjFlag()
Определяет, будут ли возвращаться объекты в результате.
Возвращает:
true, если объекты будут возвращены; false в противном случае.
См. также:
  • setReturningObjFlag(boolean)

getCountLimit

public long getCountLimit()
Возвращает максимальное количество записей, которые будут возвращены в результате поиска.

0 означает, что будут возвращены все записи.

Возвращает:
Максимальное количество записей, которые будут возвращены.
См. также:
  • setCountLimit(long)

getReturningAttributes

public String[] getReturningAttributes()
Возвращает атрибуты, которые будут возвращены в результате поиска.

Значение null означает, что будут возвращены все атрибуты. Пустой массив означает, что атрибуты не возвращаются.

Возвращает:
Массив идентификаторов атрибутов, определяющих атрибуты, которые будут возвращены. Может быть null.
См. также:
  • setReturningAttributes(java.lang.String[])

setSearchScope

public void setSearchScope(int scope)
Устанавливает область поиска на одну из: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.
Параметры:
scope - Область поиска этого SearchControls.
См. также:
  • getSearchScope()

setTimeLimit

public void setTimeLimit(int ms)
Устанавливает лимит времени этих SearchControls в миллисекундах.

Если значение равно 0, ожидание неограниченное.

Параметры:
ms - Лимит времени этих SearchControls в миллисекундах.
См. также:
  • getTimeLimit()

setDerefLinkFlag

public void setDerefLinkFlag(boolean on)
Включает/выключает разрешение ссылок во время поиска.
Параметры:
on - если true, ссылки будут разрешены; если false, не будут следовать.
См. также:
  • getDerefLinkFlag()

setReturningObjFlag

public void setReturningObjFlag(boolean on)
Включает/выключает возврат объектов в результате.

Если выключено, возвращаются только имя и класс объекта. Если включено, возвращается объект.

Параметры:
on - если true, объекты будут возвращены; если false, объекты не будут возвращены.
См. также:
  • getReturningObjFlag()

setCountLimit

public void setCountLimit(long limit)
Устанавливает максимальное количество записей, которые будут возвращены в результате поиска.

0 означает отсутствие ограничения: будут возвращены все записи.

Параметры:
limit - Максимальное количество записей, которые будут возвращены.
См. также:
  • getCountLimit()

setReturningAttributes

public void setReturningAttributes(String[] attrs)
Устанавливает атрибуты, которые будут возвращены в результате поиска.

null означает, что будут возвращены все атрибуты. Пустой массив означает, что атрибуты не возвращаются.

Параметры:
attrs - Массив идентификаторов атрибутов, определяющих атрибуты, которые будут возвращены. Может быть null.
См. также:
  • getReturningAttributes()

© 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/directory/SearchControls.html

Spec-Zone.ru

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