View Javadoc
1   /**
2    * This file Copyright (c) 2015-2018 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.util;
35  
36  import info.magnolia.resourceloader.Resource;
37  import info.magnolia.resourceloader.ResourceVisitor;
38  
39  /**
40   * Implements a simple traversal of a tree of {@link Resource}.
41   *
42   */
43  public class ResourceTreeWalker {
44      private final ResourceVisitor visitor;
45  
46      public ResourceTreeWalker(ResourceVisitor visitor) {
47          this.visitor = visitor;
48      }
49  
50      public void traverse(Resource resource) {
51          if (resource.isDirectory()) {
52              final boolean keepOnVisiting = visitor.visitDirectory(resource);
53              if (keepOnVisiting) {
54                  // Traversal order currently depends on the returned children order
55                  final Iterable<Resource> children = resource.listChildren();
56                  for (Resource child : children) {
57                      traverse(child);
58                  }
59              }
60          } else {
61              visitor.visitFile(resource);
62          }
63      }
64  }