1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.plugins.clean;
20
21 /**
22 * Determines whether a path is selected for deletion. The pathnames used for method parameters will be relative to some
23 * base directory and use {@link java.io.File#separatorChar} as separator.
24 *
25 * @author Benjamin Bentmann
26 */
27 interface Selector {
28
29 /**
30 * Determines whether a path is selected for deletion.
31 *
32 * @param pathname The pathname to test, must not be <code>null</code>.
33 * @return <code>true</code> if the given path is selected for deletion, <code>false</code> otherwise.
34 */
35 boolean isSelected(String pathname);
36
37 /**
38 * Determines whether a directory could contain selected paths.
39 *
40 * @param pathname The directory pathname to test, must not be <code>null</code>.
41 * @return <code>true</code> if the given directory might contain selected paths, <code>false</code> if the
42 * directory will definitively not contain selected paths..
43 */
44 boolean couldHoldSelected(String pathname);
45 }