Package com.unboundid.ldap.sdk.unboundidds.jsonfilter

Class NegateJSONObjectFilter

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
com.unboundid.ldap.sdk.unboundidds.jsonfilter.NegateJSONObjectFilter
All Implemented Interfaces:
Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class NegateJSONObjectFilter extends JSONObjectFilter
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.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

The fields that are required to be included in a "negate" filter are:
  • negateFilter -- The JSON object filter whose match result should be negated.

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:

  • Field Details

  • Constructor Details

    • NegateJSONObjectFilter

      public NegateJSONObjectFilter(@NotNull 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 Details

    • getNegateFilter

      @NotNull 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(@NotNull 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

      @NotNull public 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

      @NotNull protected Set<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

      @NotNull protected Set<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(@NotNull 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

      @NotNull 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.

    • toNormalizedJSONObject

      @NotNull public JSONObject toNormalizedJSONObject()
      Retrieves a JSON object that represents a normalized version of this filter.
      Specified by:
      toNormalizedJSONObject in class JSONObjectFilter
      Returns:
      A JSON object that represents a normalized version of this filter.

    • decodeFilter

      @NotNull protected NegateJSONObjectFilter decodeFilter(@NotNull 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.