1 /*
2 * $Id: PreparerFactory.java 1310865 2012-04-07 21:01:22Z nlebas $
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.preparer.factory;
22
23 import org.apache.tiles.preparer.ViewPreparer;
24 import org.apache.tiles.request.Request;
25
26 /**
27 * <p>
28 * Factory interface used to create/retrieve instances of
29 * the {@link ViewPreparer} interface.
30 * <p/>
31 *
32 * <p>
33 * This factory provides an extension point into the default
34 * tiles implementation. Implementors wishing to provide
35 * per request initialization of the ViewPreparer (for instance)
36 * may provide a custom prerparer.
37 * </p>
38 *
39 * @since 2.0
40 *
41 * @version $Rev: 1310865 $ $Date: 2012-04-08 07:01:22 +1000 (Sun, 08 Apr 2012) $
42 */
43 public interface PreparerFactory {
44
45 /**
46 * Create the named {link ViewPreparer} for the specified context.
47 *
48 * @param name ViewPreparer name, commonly the qualified classname.
49 * @param context the context within which the preparerInstance will be invoked.
50 * @return instance of the ViewPreparer
51 */
52 ViewPreparer getPreparer(String name, Request context);
53 }