|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<FilterUsage>
com.unboundid.ldap.sdk.persist.FilterUsage
public enum FilterUsage
This enumeration defines a set of options that indicate how the value of a
field or getter method may be used in the process of constructing a search
filter. The resulting filter will be constructed as a logical AND of
equality components created from the structural object class and any
auxiliary classes, as well as equality components created from the values of
fields with the LDAPField
annotation type and/or the return values of
methods with the LDAPGetter
annotation type.
If a class has any fields or getter methods with a filter usage of
REQUIRED
, then all fields and/or getter methods marked as
REQUIRED
must have a non-null
value and will be included in
the filter, and any other fields or getter methods marked as
ALWAYS_ALLOWED
or CONDITIONALLY_ALLOWED
with non-null
values will be included in the filter as well.
If a class does not have any fields or getter methods that are marked
REQUIRED
, then at least one field or getter method marked
ALWAYS_ALLOWED
must have a non-null
value in order to
generate a search filter from that object, and the resulting filter will
contain components for all non-null
fields and/or getter methods
marked ALWAYS_ALLOWED
or CONDITIONALLY_ALLOWED
. If an object
does not have any non-null
fields or getter methods marked
REQUIRED
or ALWAYS_ALLOWED
, then it will not be possible to
generate a search filter from that object.
Enum Constant Summary | |
---|---|
ALWAYS_ALLOWED
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. |
|
CONDITIONALLY_ALLOWED
Indicates that the associated field or getter method may be included in a generated search filter if it has a non- null value, and if at least
one field or getter method marked REQUIRED or
ALWAYS_ALLOWED has a non-null value. |
|
EXCLUDED
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. |
|
REQUIRED
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. |
Method Summary | |
---|---|
static FilterUsage |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static FilterUsage[] |
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 |
---|
public static final FilterUsage REQUIRED
public static final FilterUsage ALWAYS_ALLOWED
public static final FilterUsage CONDITIONALLY_ALLOWED
null
value, and if at least
one field or getter method marked REQUIRED
or
ALWAYS_ALLOWED
has a non-null
value. 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
Method Detail |
---|
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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |