1 /**
2 * This file Copyright (c) 2009-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.freemarker.models;
35
36 import freemarker.ext.util.ModelFactory;
37 import freemarker.template.ObjectWrapper;
38 import freemarker.template.TemplateModel;
39
40 /**
41 * A specialization of Freemarker's ModelFactory, which knows which
42 * class its handling. Mostly just used so we can simply register
43 * other factories in Magnolia's configuration without too many hacks
44 * nor billions of subnodes.
45 */
46 public interface MagnoliaModelFactory extends ModelFactory {
47 /**
48 * Returns the Class this ModelFactory is able to create Model instances for.
49 * MagnoliaObjectWrapper uses this with a isAssignableFrom call to determine
50 * which ModelFactory to use.
51 */
52 Class factoryFor();
53
54 /**
55 * If possible, our models should instantiate models which implement AdapterTemplateModel,
56 * so they can be unwrapped easily. (by custom directives, for example)
57 *
58 * @see freemarker.template.AdapterTemplateModel
59 */
60 @Override
61 TemplateModel create(Object object, ObjectWrapper wrapper);
62 }