1 /**
2 * This file Copyright (c) 2016-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
38 import java.util.Collection;
39 import java.util.function.Predicate;
40
41 /**
42 * A {@link PredicatedResourceVisitor} which simply "collects" file resources matching a given pattern.
43 * Never collects directories, but lets you control which directories to traverses for efficiency. If you need finer-grained control,
44 * use {@link PredicatedResourceVisitor} or implement your own {@link info.magnolia.resourceloader.ResourceVisitor}
45 */
46 public class FileResourceCollectorVisitor extends PredicatedResourceVisitor {
47 public static FileResourceCollectorVisitor on(Predicate<Resource> applyToFile) {
48 return new FileResourceCollectorVisitor(visitDirectory -> true, applyToFile);
49 }
50
51 public static FileResourceCollectorVisitor on(Predicate<Resource> visitDirectory, Predicate<Resource> applyToFile) {
52 return new FileResourceCollectorVisitor(visitDirectory, applyToFile);
53 }
54
55 protected FileResourceCollectorVisitor(Predicate<Resource> visitDirectory, Predicate<Resource> applyToFile) {
56 super(visitDirectory, applyToDirectory -> false, applyToFile, Functions.collector());
57 }
58
59 public Collection<Resource> getCollectedResources() {
60 return ((Functions.CollectorFunction<Resource>) getFunction()).getTarget();
61 }
62 }