Predicate.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.felix.ipojo.manipulator.spi;

/**
 * A Predicate is executed with a given {@link BindingContext} and returns {@literal true} if the
 * {@link #matches(BindingContext)} operation is a success. It returns {@literal false} otherwise.
 * Predicates can be used to determine if the traversed element (can be found on {@link BindingContext})
 * matches some properties.
 *
 * @see org.apache.felix.ipojo.manipulator.spi.helper.Predicates
 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
 */
public interface Predicate {

    /**
     * Returns {@literal true} if the context is matching the predicate.
     * @param context Binding information source
     * @return {@literal true} if the context is matching the predicate, {@literal false} otherwise.
     */
    boolean matches(BindingContext context);
}