1 /**
2 * This file Copyright (c) 2015-2016 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.resourceloader;
35
36 /**
37 * Used by {@link ResourceOrigin#traverseWith(ResourceVisitor)} to visit resources.
38 *
39 * @see info.magnolia.resourceloader.util.PredicatedResourceVisitor
40 * @see info.magnolia.resourceloader.util.LoggingResourceVisitor
41 */
42 public interface ResourceVisitor {
43 /**
44 * Determines if we should visit this directory resource.
45 * Implementations can decide to do anything with the directory as well; note that {@link #visitFile(Resource)} is
46 * NOT called for directories.
47 * @return true if we should visit children (directories and files) of the given resource.
48 */
49 boolean visitDirectory(Resource resource);
50
51 /**
52 * Implementations can decide to do anything with the file; note that {@link #visitDirectory(Resource)} is
53 * NOT called for files.
54 */
55 void visitFile(Resource resource);
56
57 }