Clover icon

Magnolia Resources Module 2.4.2

  1. Project Clover database Fri Nov 6 2015 16:15:26 CET
  2. Package info.magnolia.module.resources.loaders

File ResourceLoader.java

 

Code metrics

0
0
0
1
61
8
0
-
-
0
-

Classes

Class Line # Actions
ResourceLoader 46 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /**
2    * This file Copyright (c) 2012-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.resources.loaders;
35   
36    import java.io.IOException;
37    import java.io.InputStream;
38   
39    /**
40    * Implementing this interface will allow to use custom resource loader.
41    * Loaders are registered under config/modules/resources/config/resourceLoaders node.
42    *
43    * @deprecated since 2.4 (Magnolia 5.4), please use the new {@link info.magnolia.resourceloader.ResourceOrigin} API.
44    */
45    @Deprecated
 
46    public interface ResourceLoader {
47   
48    /**
49    * Gets {@link InputStream} from template file.
50    *
51    * @param path
52    * @return InputStream if resource was found or null otherwise
53    */
54    public InputStream getStream(String path) throws IOException;
55   
56    /**
57    * @return true if loader is enabled or false otherwise
58    */
59    public boolean isEnabled();
60   
61    }