Class NegateJSONObjectFilter

  • All Implemented Interfaces:
    java.io.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:
    Serialized Form
    • 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
    • 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.
      • 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.