1 /*
2 * $Id: AbstractTilesContainerFactory.java 833737 2009-11-07 19:17:09Z apetrelli $
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21 package org.apache.tiles.factory;
22
23 import org.apache.tiles.TilesContainer;
24 import org.apache.tiles.request.ApplicationContext;
25
26 /**
27 * Abstract Factory that creates instances of {@link TilesContainerFactory}.
28 *
29 * @version $Rev: 833737 $ $Date: 2009-11-08 06:17:09 +1100 (Sun, 08 Nov 2009) $
30 * @since 2.1.0
31 */
32 public abstract class AbstractTilesContainerFactory {
33
34 /**
35 * Initialization parameter that represents the container factory class
36 * name.
37 *
38 * @since 2.1.0
39 */
40 public static final String CONTAINER_FACTORY_INIT_PARAM =
41 "org.apache.tiles.factory.AbstractTilesContainerFactory";
42
43 /**
44 * Creates a Tiles container.
45 *
46 * @param applicationContext The Tiles application context object.
47 * @return The created container.
48 * @throws TilesContainerFactoryException If something goes wrong during
49 * instantiation.
50 * @since 2.1.1
51 */
52 public abstract TilesContainer createContainer(ApplicationContext applicationContext);
53 }