View Javadoc
1   /**
2    * This file Copyright (c) 2010-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.objectfactory;
35  
36  /**
37   * ClassFactory implementations are responsible for locating and instantiating classes. Specific implementations
38   * could take care of container-specific hacks, provide support for a scripting language, etc.
39   *
40   * TODO ? an spi-like layer that would allow to have multiple implementations of this and delegate to the first which "accepts" the given parameters ?
41   */
42  public interface ClassFactory {
43  
44      <C> Class<C> forName(String className) throws ClassNotFoundException;
45  
46      /**
47       * Instantiates the given class with the given parameters. This attempts to find a matching constructor.
48       * For the empty constructor, pass no parameters (or an empty array, or null).
49       * Null arguments are not supported.
50       *
51       * @throws MgnlInstantiationException wrapping possible instantiation exceptions
52       */
53      <T> T newInstance(Class<T> c, Object... params);
54  
55      /**
56       * Instantiates the given class with the given parameters, using a constructor that matches the given
57       * <code>argTypes</code> exactly.
58       *
59       * To pass "null" to a single-arg constructor,  use newInstance(c, new Object[]{null}) (otherwise the *array* itself will be considered null)
60       *
61       * @throws MgnlInstantiationException wrapping possible instantiation exceptions
62       */
63      <T> T newInstance(Class<T> c, Class<?>[] argTypes, Object... params);
64  
65  }