|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
com.unboundid.ldap.sdk.unboundidds.jsonfilter.EqualsAnyJSONObjectFilter
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class EqualsAnyJSONObjectFilter
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have a specified field whose value matches one of specified set of values.
field
-- A field path specifier for the JSON field for which to
make the determination. This may be either a single string or an array
of strings as described in the "Targeting Fields in JSON Objects" section
of the class-level documentation for JSONObjectFilter
.
values
-- The set of values that should be used to match. This
should be an array, but the elements of the array may be of any type. In
order for a JSON object ot match this "equals any" filter, either the
value of the target field must have the same type and value as one of the
values in this array, or the value of the target field must be an array
containing at least one element with the same type and value as one of
the values in this array.
caseSensitive
-- Indicates whether string values should be
treated in a case-sensitive manner. If present, this field must have a
Boolean value of either true
or false
. If it is not
provided, then a default value of false
will be assumed so that
strings are treated in a case-insensitive manner.
{ "filterType" : "equalsAny", "field" : "userType", "values" : [ "employee", "partner", "contractor" ] }The above filter can be created with the code:
EqualsAnyJSONObjectFilter filter = new EqualsAnyJSONObjectFilter( "userType", "employee", "partner", "contractor");
Field Summary | |
---|---|
static java.lang.String |
FIELD_CASE_SENSITIVE
The name of the JSON field that is used to indicate whether string matching should be case-sensitive. |
static java.lang.String |
FIELD_FIELD_PATH
The name of the JSON field that is used to specify the field in the target JSON object for which to make the determination. |
static java.lang.String |
FIELD_VALUES
The name of the JSON field that is used to specify the values to use for the matching. |
static java.lang.String |
FILTER_TYPE
The value that should be used for the filterType element of the JSON object that represents an "equals any" filter. |
Fields inherited from class com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter |
---|
FIELD_FILTER_TYPE, JSON_OBJECT_FILTER_MATCHING_RULE_NAME, JSON_OBJECT_FILTER_MATCHING_RULE_OID |
Constructor Summary | |
---|---|
EqualsAnyJSONObjectFilter(java.util.List<java.lang.String> field,
java.util.Collection<JSONValue> values)
Creates a new instance of this filter type with the provided information. |
|
EqualsAnyJSONObjectFilter(java.lang.String field,
java.util.Collection<JSONValue> values)
Creates a new instance of this filter type with the provided information. |
|
EqualsAnyJSONObjectFilter(java.lang.String field,
JSONValue... values)
Creates a new instance of this filter type with the provided information. |
|
EqualsAnyJSONObjectFilter(java.lang.String field,
java.lang.String... values)
Creates a new instance of this filter type with the provided information. |
Method Summary | |
---|---|
boolean |
caseSensitive()
Indicates whether string matching should be performed in a case-sensitive manner. |
protected EqualsAnyJSONObjectFilter |
decodeFilter(JSONObject filterObject)
Decodes the provided JSON object as a filter of this type. |
java.util.List<java.lang.String> |
getField()
Retrieves the field path specifier for this filter. |
java.lang.String |
getFilterType()
Retrieves the value that must appear in the filterType field for
this filter. |
protected java.util.Set<java.lang.String> |
getOptionalFieldNames()
Retrieves the names of all fields that may optionally be present but are not required in the JSON object representing a filter of this type. |
protected java.util.Set<java.lang.String> |
getRequiredFieldNames()
Retrieves the names of all fields (excluding the filterType field)
that must be present in the JSON object representing a filter of this type. |
java.util.List<JSONValue> |
getValues()
Retrieves the set of target values for this filter. |
boolean |
matchesJSONObject(JSONObject o)
Indicates whether this JSON object filter matches the provided JSON object. |
void |
setCaseSensitive(boolean caseSensitive)
Specifies whether string matching should be performed in a case-sensitive manner. |
void |
setField(java.util.List<java.lang.String> field)
Sets the field path specifier for this filter. |
void |
setField(java.lang.String... field)
Sets the field path specifier for this filter. |
void |
setValues(java.util.Collection<JSONValue> values)
Specifies the set of target values for this filter. |
void |
setValues(JSONValue... values)
Specifies the set of target values for this filter. |
void |
setValues(java.lang.String... values)
Specifies the set of target values for this filter. |
JSONObject |
toJSONObject()
Retrieves a JSON object that represents this filter. |
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter |
---|
decode, equals, getBoolean, getFilters, getString, getStrings, getValues, hashCode, registerFilterType, toLDAPFilter, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FILTER_TYPE
public static final java.lang.String FIELD_FIELD_PATH
public static final java.lang.String FIELD_VALUES
public static final java.lang.String FIELD_CASE_SENSITIVE
Constructor Detail |
---|
public EqualsAnyJSONObjectFilter(java.lang.String field, java.lang.String... values)
field
- The name of the top-level field to target with this filter.
It must not be null
. See the class-level
documentation for the JSONObjectFilter
class for
information about field path specifiers.values
- The set of expected string values for the target field.
This filter will match an object in which the target field
has the same type and value as any of the values in this
set, or in which the target field is an array containing an
element with the same type and value as any of the values
in this set. It must not be null
or empty.public EqualsAnyJSONObjectFilter(java.lang.String field, JSONValue... values)
field
- The name of the top-level field to target with this filter.
It must not be null
. See the class-level
documentation for the JSONObjectFilter
class for
information about field path specifiers.values
- The set of expected string values for the target field.
This filter will match an object in which the target field
has the same type and value as any of the values in this
set, or in which the target field is an array containing an
element with the same type and value as any of the values
in this set. It must not be null
or empty.public EqualsAnyJSONObjectFilter(java.lang.String field, java.util.Collection<JSONValue> values)
field
- The name of the top-level field to target with this filter.
It must not be null
. See the class-level
documentation for the JSONObjectFilter
class for
information about field path specifiers.values
- The set of expected string values for the target field.
This filter will match an object in which the target field
has the same type and value as any of the values in this
set, or in which the target field is an array containing an
element with the same type and value as any of the values
in this set. It must not be null
or empty.public EqualsAnyJSONObjectFilter(java.util.List<java.lang.String> field, java.util.Collection<JSONValue> values)
field
- The field path specifier for this filter. It must not be
null
or empty. See the class-level documentation
for the JSONObjectFilter
class for information
about field path specifiers.values
- The set of expected string values for the target field.
This filter will match an object in which the target field
has the same type and value as any of the values in this
set, or in which the target field is an array containing an
element with the same type and value as any of the values
in this set. It must not be null
or empty.Method Detail |
---|
public java.util.List<java.lang.String> getField()
public void setField(java.lang.String... field)
field
- The field path specifier for this filter. It must not be
null
or empty. See the class-level documentation
for the JSONObjectFilter
class for information about
field path specifiers.public void setField(java.util.List<java.lang.String> field)
field
- The field path specifier for this filter. It must not be
null
or empty. See the class-level documentation
for the JSONObjectFilter
class for information about
field path specifiers.public java.util.List<JSONValue> getValues()
public void setValues(java.lang.String... values)
values
- The set of target string values for this filter. It must
not be null
or empty.public void setValues(JSONValue... values)
values
- The set of target values for this filter. It must not be
null
or empty.public void setValues(java.util.Collection<JSONValue> values)
values
- The set of target values for this filter. It must not be
null
or empty.public boolean caseSensitive()
true
if string matching should be case sensitive, or
false
if not.public void setCaseSensitive(boolean caseSensitive)
caseSensitive
- Indicates whether string matching should be
case sensitive.public java.lang.String getFilterType()
filterType
field for
this filter.
getFilterType
in class JSONObjectFilter
filterType
field for
this filter.protected java.util.Set<java.lang.String> getRequiredFieldNames()
filterType
field)
that must be present in the JSON object representing a filter of this type.
getRequiredFieldNames
in class JSONObjectFilter
filterType
field)
that must be present in the JSON object representing a filter of
this type.protected java.util.Set<java.lang.String> getOptionalFieldNames()
getOptionalFieldNames
in class JSONObjectFilter
public boolean matchesJSONObject(JSONObject o)
matchesJSONObject
in class JSONObjectFilter
o
- The JSON object for which to make the determination.
true
if this JSON object filter matches the provided JSON
object, or false
if not.public JSONObject toJSONObject()
toJSONObject
in class JSONObjectFilter
protected EqualsAnyJSONObjectFilter decodeFilter(JSONObject filterObject) throws JSONException
decodeFilter
in class JSONObjectFilter
filterObject
- The JSON object to be decoded. The caller will have already
validated that all required fields are present, and that it
does not have any fields that are neither required nor optional.
JSONException
- If the provided JSON object cannot be decoded as a
valid filter of this type.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |