1 /**
2 * This file Copyright (c) 2003-2015 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.module.files;
35
36 import java.io.IOException;
37
38 /**
39 * A component to extract files from modules.
40 */
41 public interface FileExtractor {
42
43 /**
44 * Extracts the given resource from the classpath and stores it as absTargetPath.
45 * extractFile("/foo/bar.baz", "/Users/greg/tok.tak"). Does not handle any kind
46 * of logic regarding location and name of source and target files.
47 */
48 void extractFile(String resourcePath, String absTargetPath) throws IOException;
49
50 /**
51 * Extracts the given resource from the classpath and stores it as dictacted by
52 * the given Transformer.
53 */
54 void extractFile(String resourcePath, Transformer transformer) throws IOException;
55
56 /**
57 * Extracts all found resources from the classpath, using the given Transformer.
58 */
59 void extractFiles(Transformer transformer) throws IOException;
60
61 /**
62 * Transforms a resource path into a file system path. (i.e where the resource is extracted)
63 * Returns null if the resource should not be extracted.
64 *
65 * TODO : find better name !
66 */
67 interface Transformer {
68 /**
69 * A filter in the same vein as java.io.FileFilter and such, except this
70 * returns the (absolute) targetPath of a file to be extracted, or null
71 * if the file should not be extracted.
72 */
73 String accept(String resourcePath);
74 }
75 }