com.unboundid.ldap.sdk.unboundidds.jsonfilter
Class NegateJSONObjectFilter

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
      extended by com.unboundid.ldap.sdk.unboundidds.jsonfilter.NegateJSONObjectFilter
All Implemented Interfaces:
java.io.Serializable

@Mutable
@ThreadSafety(level=NOT_THREADSAFE)
public final class NegateJSONObjectFilter
extends JSONObjectFilter

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 negate the result of a provided filter. If the embedded filter matches a given JSON object, then this negate filter will not match that object. If the embedded filter does not match a JSON object, then this negate filter will match that object.

The fields that are required to be included in a "negate" filter are:

Example

The following is an example of a "negate" filter that will match any JSON object that does not have a top-level field named "userType" with a value of "employee":
   { "filterType" : "negate",
     "negateFilter" : {
       "filterType" : "equals",
       "field" : "userType",
       "value" : "employee" } }
 
The above filter can be created with the code:
   NegateJSONObjectFilter filter = new NegateJSONObjectFilter(
        new EqualsJSONObjectFilter("userType", "employee"));
 

See Also:
Serialized Form

Field Summary
static java.lang.String FIELD_NEGATE_FILTER
          The name of the JSON field that is used to specify the filter to negate.
static java.lang.String FILTER_TYPE
          The value that should be used for the filterType element of the JSON object that represents a "negate" 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
NegateJSONObjectFilter(JSONObjectFilter negateFilter)
          Creates a new instance of this filter type with the provided information.
 
Method Summary
protected  NegateJSONObjectFilter decodeFilter(JSONObject filterObject)
          Decodes the provided JSON object as a filter of this type.
 java.lang.String getFilterType()
          Retrieves the value that must appear in the filterType field for this filter.
 JSONObjectFilter getNegateFilter()
          Retrieves the JSON object filter whose match result will be negated.
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.
 boolean matchesJSONObject(JSONObject o)
          Indicates whether this JSON object filter matches the provided JSON object.
 void setNegateFilter(JSONObjectFilter negateFilter)
          Specifies the JSON object filter whose match result should be negated.
 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

FILTER_TYPE

public static final java.lang.String FILTER_TYPE
The value that should be used for the filterType element of the JSON object that represents a "negate" filter.

See Also:
Constant Field Values

FIELD_NEGATE_FILTER

public static final java.lang.String FIELD_NEGATE_FILTER
The name of the JSON field that is used to specify the filter to negate.

See Also:
Constant Field Values
Constructor Detail

NegateJSONObjectFilter

public NegateJSONObjectFilter(JSONObjectFilter negateFilter)
Creates a new instance of this filter type with the provided information.

Parameters:
negateFilter - The JSON object filter whose match result should be negated. It must not be null.
Method Detail

getNegateFilter

public JSONObjectFilter getNegateFilter()
Retrieves the JSON object filter whose match result will be negated.

Returns:
The JSON object filter whose match result will be negated.

setNegateFilter

public void setNegateFilter(JSONObjectFilter negateFilter)
Specifies the JSON object filter whose match result should be negated.

Parameters:
negateFilter - The JSON object filter whose match result should be negated.

getFilterType

public java.lang.String getFilterType()
Retrieves the value that must appear in the filterType field for this filter.

Specified by:
getFilterType in class JSONObjectFilter
Returns:
The value that must appear in the filterType field for this filter.

getRequiredFieldNames

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.

Specified by:
getRequiredFieldNames in class JSONObjectFilter
Returns:
The names of all fields (excluding the filterType field) that must be present in the JSON object representing a filter of this type.

getOptionalFieldNames

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.

Specified by:
getOptionalFieldNames in class JSONObjectFilter
Returns:
The names of all fields that may optionally be present but are not required in the JSON object representing a filter of this type.

matchesJSONObject

public boolean matchesJSONObject(JSONObject o)
Indicates whether this JSON object filter matches the provided JSON object.

Specified by:
matchesJSONObject in class JSONObjectFilter
Parameters:
o - The JSON object for which to make the determination.
Returns:
true if this JSON object filter matches the provided JSON object, or false if not.

toJSONObject

public JSONObject toJSONObject()
Retrieves a JSON object that represents this filter.

Specified by:
toJSONObject in class JSONObjectFilter
Returns:
A JSON object that represents this filter.

decodeFilter

protected NegateJSONObjectFilter decodeFilter(JSONObject filterObject)
                                       throws JSONException
Decodes the provided JSON object as a filter of this type.

Specified by:
decodeFilter in class JSONObjectFilter
Parameters:
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.
Returns:
The decoded JSON object filter.
Throws:
JSONException - If the provided JSON object cannot be decoded as a valid filter of this type.