View Javadoc

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