Package io.jans.orm.model

Enum SearchScope

java.lang.Object
java.lang.Enum<SearchScope>
io.jans.orm.model.SearchScope
All Implemented Interfaces:
Serializable, Comparable<SearchScope>, java.lang.constant.Constable
public enum SearchScope extends Enum<SearchScope>
LDAP search scope
Author:
Yuriy Movchan Date: 11/18/2016

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BASE
    A predefined baseObject scope value, which indicates that only the entry specified by the base DN should be considered.
    ONE
    A predefined singleLevel scope value, which indicates that only entries that are immediate subordinates of the entry specified by the base DN (but not the base entry itself) should be considered.
    SUB
    A predefined wholeSubtree scope value, which indicates that the base entry itself and any subordinate entries (to any depth) should be considered.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SearchScope
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static SearchScope[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • BASE

      public static final SearchScope BASE
      A predefined baseObject scope value, which indicates that only the entry specified by the base DN should be considered.

    • ONE

      public static final SearchScope ONE
      A predefined singleLevel scope value, which indicates that only entries that are immediate subordinates of the entry specified by the base DN (but not the base entry itself) should be considered.

    • SUB

      public static final SearchScope SUB
      A predefined wholeSubtree scope value, which indicates that the base entry itself and any subordinate entries (to any depth) should be considered.

  • Method Details

    • values

      public static SearchScope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static SearchScope valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null