Spec-Zone.ru › OpenJDK 27

Класс 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 в миллисекундах.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Модификатор и тип Метод Описание
protected Object clone()
Создаёт и возвращает копию этого объекта.
boolean equals(Object obj)
Указывает, равен ли этот объект какому-либо другому объекту.
protected void finalize()
Устарело, планируется удаление: этот элемент API может быть удалён в одной из будущих версий.
Финализация устарела и может быть удалена в одном из будущих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
int hashCode()
Возвращает хеш-код этого объекта.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
String toString()
Возвращает строковое представление объекта.
final void wait()
Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt.
final void wait(long timeoutMillis)
Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt, либо истечения заданного промежутка реального времени.
final void wait(long timeoutMillis, int nanos)
Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt, либо истечения заданного промежутка реального времени.

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

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.
countlim — максимальное количество возвращаемых записей. Если значение равно 0, возвращаются все записи, удовлетворяющие фильтру.
timelim — время ожидания в миллисекундах перед возвратом. Если значение равно 0, ожидание не ограничено.
attrs — идентификаторы атрибутов, возвращаемых вместе с записью. Если значение равно null, возвращаются все атрибуты. Если массив пуст, атрибуты не возвращаются.
retobj — если значение true, возвращается объект, связанный с именем записи; если false, объект не возвращается.
deref — если значение true, ссылки разыменовываются во время поиска.

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

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(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()

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2026, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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