LdapIdentityStoreDefinition.LdapSearchScope (Jakarta EE Web Profile API)

java.lang.Object
- java.lang.Enum<LdapIdentityStoreDefinition.LdapSearchScope>
- - jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition.LdapSearchScope

All Implemented Interfaces:

Serializable, Comparable<LdapIdentityStoreDefinition.LdapSearchScope>

Enclosing class:

LdapIdentityStoreDefinition
```
public static enum LdapIdentityStoreDefinition.LdapSearchScope
extends Enum<LdapIdentityStoreDefinition.LdapSearchScope>
```
Enum representing LDAP search scope values.

Enum Constant Summary

Enum Constants
Enum Constant Description

ONE_LEVEL

SUBTREE

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static LdapIdentityStoreDefinition.LdapSearchScope`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static LdapIdentityStoreDefinition.LdapSearchScope[]`	`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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ONE_LEVEL
```
public static final LdapIdentityStoreDefinition.LdapSearchScope ONE_LEVEL
```
  - SUBTREE
```
public static final LdapIdentityStoreDefinition.LdapSearchScope SUBTREE
```
- Method Detail
  - values
```
public static LdapIdentityStoreDefinition.LdapSearchScope[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (LdapIdentityStoreDefinition.LdapSearchScope c : LdapIdentityStoreDefinition.LdapSearchScope.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LdapIdentityStoreDefinition.LdapSearchScope 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