public enum FilterUsage extends java.lang.Enum<FilterUsage>
LDAPFieldannotation type and/or the return values of methods with the
REQUIRED, then all fields and/or getter methods marked as
REQUIREDmust have a non-
nullvalue and will be included in the filter, and any other fields or getter methods marked as
nullvalues will be included in the filter as well.
REQUIRED, then at least one field or getter method marked
ALWAYS_ALLOWEDmust have a non-
nullvalue in order to generate a search filter from that object, and the resulting filter will contain components for all non-
nullfields and/or getter methods marked
CONDITIONALLY_ALLOWED. If an object does not have any non-
nullfields or getter methods marked
ALWAYS_ALLOWED, then it will not be possible to generate a search filter from that object.
|Enum Constant and Description|
Indicates that the associated field or getter method may always be included in a search filter if it has a value, regardless of whether any other fields or getter methods in the object may have values.
Indicates that the associated field or getter method may be included in a generated search filter if it has a non-
Indicates that the associated field or getter method will never be included in a search filter generated from an object, regardless of whether it has a value in that object.
Indicates that the associated field or getter method must have a value in an object in order to be able to generate a search filter from that object.
|Modifier and Type||Method and Description|
Retrieves the filter usage with the specified name.
Returns the enum constant of this type with the specified name.
Returns an array containing the constants of this enum type, in the order they are declared.
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
public static final FilterUsage REQUIRED
public static final FilterUsage ALWAYS_ALLOWED
public static final FilterUsage CONDITIONALLY_ALLOWED
nullvalue, and if at least one field or getter method marked
ALWAYS_ALLOWEDhas a non-
nullvalue. This usage indicates that the associated field or getter method may be used to help refine a search filter, but is not sufficient to be included in a search filter by itself.
public static final FilterUsage EXCLUDED
public static FilterUsage values()
for (FilterUsage c : FilterUsage.values()) System.out.println(c);
public static FilterUsage valueOf(java.lang.String name)
name- the name of the enum constant to be returned.
java.lang.IllegalArgumentException- if this enum type has no constant with the specified name
java.lang.NullPointerException- if the argument is null
@Nullable public static FilterUsage forName(@NotNull java.lang.String name)
name- The name of the filter usage to retrieve. It must not be
nullif no such usage is defined.