1 /*
2  * Copyright (c) 2007, 2009, 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  * The result type of a {@link FileVisitor FileVisitor}.
30  *
31  * @since 1.7
32  *
33  * @see Files#walkFileTree
34  */
35 
36 public enum FileVisitResult {
37     /**
38      * Continue. When returned from a {@link FileVisitor#preVisitDirectory
39      * preVisitDirectory} method then the entries in the directory should also
40      * be visited.
41      */
42     CONTINUE,
43     /**
44      * Terminate.
45      */
46     TERMINATE,
47     /**
48      * Continue without visiting the entries in this directory. This result
49      * is only meaningful when returned from the {@link
50      * FileVisitor#preVisitDirectory preVisitDirectory} method; otherwise
51      * this result type is the same as returning {@link #CONTINUE}.
52      */
53     SKIP_SUBTREE,
54     /**
55      * Continue without visiting the <em>siblings</em> of this file or directory.
56      * If returned from the {@link FileVisitor#preVisitDirectory
57      * preVisitDirectory} method then the entries in the directory are also
58      * skipped and the {@link FileVisitor#postVisitDirectory postVisitDirectory}
59      * method is not invoked.
60      */
61     SKIP_SIBLINGS;
62 }
63