001/*
002 * JDrupes GitVersioning
003 * Copyright (C) 2026 Michael N. Lipp
004 * 
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
017 */
018
019package org.jdrupes.gitversioning.core;
020
021import java.nio.file.Path;
022
023/**
024 * Matches a file path against a pattern.
025 *
026 * <p>Internal interface used by {@link VersionEvaluatorProvider} to
027 * determine which files are relevant for version evaluation.
028 */
029@SuppressWarnings("PMD.ImplicitFunctionalInterface")
030public interface IncludeMatcher {
031
032    /**
033     * Checks whether the path matches the pattern.
034     *
035     * @param path the file path (relative to the work tree)
036     * @return {@code true} if the path matches
037     */
038    boolean matches(Path path);
039}