1 package org.apache.rat.mp.util.ignore; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import java.util.Optional; 23 24 public interface IgnoreMatcher { 25 /** 26 * Checks if the file matches the stored expressions. 27 * @param filename The filename to be checked 28 * @return empty: not matched, True: must be ignored, False: it must be UNignored 29 */ 30 Optional<Boolean> isIgnoredFile(String filename); 31 32 /** 33 * Returns {@code true} if this IgnoreMatcher contains no rules. 34 * @return {@code true} if this IgnoreMatcher contains no rules 35 */ 36 boolean isEmpty(); 37 }