1 /*
2 * $Id: Renderer.java 1215008 2011-12-16 00:31:49Z 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.request.render;
22
23 import java.io.IOException;
24
25 import org.apache.tiles.request.Request;
26
27 /**
28 * An object that can render a path, depending on the request passed as a
29 * parameter.
30 *
31 * @version $Rev: 1215008 $ $Date: 2011-12-16 11:31:49 +1100 (Fri, 16 Dec 2011) $
32 */
33 public interface Renderer {
34
35 /**
36 * Renders a path.
37 *
38 * @param path The path to render.
39 * @param request The Tiles request context.
40 * @throws IOException If something goes wrong during rendition.
41 */
42 void render(String path, Request request) throws IOException;
43
44 /**
45 * Checks if this renderer can render a path. Note that this does not mean
46 * it is the <strong>best</strong> renderer available, but checks only its capability.
47 *
48 * @param path The path to be rendered.
49 * @param request The request context.
50 * @return <code>true</code> if this renderer can render the attribute.
51 */
52 boolean isRenderable(String path, Request request);
53 }