View Javadoc

1   /*
2    * $Id: RendererFactory.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.renderer;
22  
23  import java.util.Map;
24  
25  /***
26   * <p>
27   * Factory interface used to create/retrieve instances of the
28   * {@link AttributeRenderer} interface.
29   * </p>
30   *
31   * <p>
32   * This factory provides an extension point into the default tiles
33   * implementation. Implementors wishing to provide per request initialization of
34   * the AttributeRenderer (for instance) may provide a custom renderer.
35   * </p>
36   *
37   * @version $Rev: 637434 $ $Date: 2008-03-15 16:48:38 +0100 (sab, 15 mar 2008) $
38   * @since 2.1.0
39   */
40  public interface RendererFactory {
41  
42      /***
43       * Initialize the renderer factory.
44       *
45       * @param parameters The parameters for the initialization.
46       * @since 2.1.0
47       */
48      void init(Map<String, String> parameters);
49  
50      /***
51       * Returns a renderer by its name.
52       *
53       * @param name The name of the renderer.
54       * @return The renderer.
55       * @since 2.1.0
56       */
57      AttributeRenderer getRenderer(String name);
58  }