SubstringFilter.Substrings (Ldaptive 2.3.2 API)

java.lang.Object
- java.lang.Enum<SubstringFilter.Substrings>
- - org.ldaptive.filter.SubstringFilter.Substrings

All Implemented Interfaces:

Serializable, Comparable<SubstringFilter.Substrings>

Enclosing class:

SubstringFilter
```
public static enum SubstringFilter.Substrings
extends Enum<SubstringFilter.Substrings>
```
Type of substring match.

Enum Constant Summary

Enum Constants
Enum Constant Description

ANY
Any substring.

FINAL
Final substring.

INITIAL
Initial substring.

Constructor Summary

Constructors
Modifier Constructor Description

private Substrings()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static SubstringFilter.Substrings`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static SubstringFilter.Substrings[]`	`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
  - INITIAL
```
public static final SubstringFilter.Substrings INITIAL
```
    Initial substring.
  - ANY
```
public static final SubstringFilter.Substrings ANY
```
    Any substring.
  - FINAL
```
public static final SubstringFilter.Substrings FINAL
```
    Final substring.
- Constructor Detail
  - Substrings
```
private Substrings()
```
- Method Detail
  - values
```
public static SubstringFilter.Substrings[] 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 (SubstringFilter.Substrings c : SubstringFilter.Substrings.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SubstringFilter.Substrings 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