Класс SearchControls
- java.lang.Object
-
- javax.naming.directory.SearchControls
- Все реализованные интерфейсы:
- Serializable
public class SearchControls extends Object implements Serializable
Этот класс инкапсулирует факторы, определяющие область поиска и то, что возвращается в результате поиска.
Экземпляр SearchControls не синхронизирован для одновременного доступа в нескольких потоках. Несколько потоков, пытающихся получить доступ и изменить один экземпляр SearchControls, должны заблокировать объект.
- С момента:
- 1.3
- См. также:
- Сериализованная форма
Поля
| Модификатор и тип | Поле и описание |
|---|---|
static int |
OBJECT_SCOPE Поиск по имени объекта. |
static int |
ONELEVEL_SCOPE Поиск на одном уровне контекста с именем. |
static 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(). Имена элементов в перечислении являются атомарными именами, относительными к именованному контексту.
Значение этой константы равно 1.
- См. также:
- Значения константных полей
SUBTREE_SCOPE
public static final int SUBTREE_SCOPE
Поиск всего поддерева, укорененного в именованном объекте.
Если именованный объект не является DirContext, поиск выполняется только для этого объекта. Если именованный объект является DirContext, выполняется поиск поддерева, укорененного в именованном объекте, включая сам именованный объект.
Поиск не пересекает границы систем именования.
Перечисление NamingEnumeration, полученное в результате вызова search() с SUBTREE_SCOPE, содержит элементы объектов из поддерева (включая именованный контекст), удовлетворяющие фильтру поиска, указанному в search(). Имена элементов в перечислении либо относительны к именованному контексту, либо представляют собой строку 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, 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.
