1 /*
2  * Copyright (c) 2007, 2013, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package java.nio.file;
27 
28 /**
29  * An interface that is implemented by objects that perform match operations on
30  * paths.
31  *
32  * @since 1.7
33  *
34  * @see FileSystem#getPathMatcher
35  * @see Files#newDirectoryStream(Path,String)
36  */
37 @FunctionalInterface
38 public interface PathMatcher {
39     /**
40      * Tells if given path matches this matcher's pattern.
41      *
42      * @param   path
43      *          the path to match
44      *
45      * @return  {@code true} if, and only if, the path matches this
46      *          matcher's pattern
47      */
matches(Path path)48     boolean matches(Path path);
49 }
50