/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.addthis.hydra.data.filter.bundle;

import com.addthis.bundle.core.Bundle;
import com.addthis.bundle.util.AutoField;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * This {@link BundleFilter BundleFilter} <span class="hydra-summary">returns true if a specified field is not set</span>.
 * <p/>
 * <p>Example:</p>
 * <pre>
 *   {not.field:"USERNAME"},
 * </pre>
 *
 * @user-reference
 */
public class BundleFilterNot implements BundleFilter {

    /** The field to test. This field is required. */
    private final AutoField field;

    public BundleFilterNot(@JsonProperty("field") AutoField field) {
        this.field = field;
    }

    @Override
    public boolean filter(Bundle bundle) {
        return field.getValue(bundle) == null;
    }
}