org.javabits.yar.IdMatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yar-api Show documentation

Yar API: provide the main interfaces to manipulate the registry

There is a newer version: 3.0.1.RELEASE

/*
 * Copyright 2013 Romain Gilles
 *
 *    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 org.javabits.yar;

/**
 * Returns {@code true} or {@code false} for a given id input.
 * TODO future version have to support cation {@literal Matcher} and bounds {@literal Matcher} or {@literal Matcher}
 * Date: 3/15/13
 *
 * @param  the matching type
 * @author Romain Gilles
 */
public interface IdMatcher extends Matcher> {
    /**
     * Returns {@code true} if this matches {@code item}, {@code false} otherwise.
     */
    boolean matches(Id otherId);

    /**
     * Returns the template id that this matcher is looking for.
     * It is used to pre-filter content to avoid you to receive to many notification.
     */
    Id id();

}