View Javadoc

1   /*
2    * $Id: UrlRenderer.java 651946 2008-04-27 13:41: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  
22  package org.apache.struts2.components;
23  
24  import java.io.Writer;
25  
26  /***
27   * Implementations of this interface are responsible for rendering/creating URLs for a specific
28   * environment (e.g. Servlet, Portlet). 
29   *
30   */
31  public interface UrlRenderer {
32  	
33  	/***
34  	 * Preprocessing step
35  	 * @param urlComponent
36  	 */
37  	void beforeRenderUrl(URL urlComponent);
38  	
39  	/***
40  	 * Render a URL.
41  	 * @param writer A writer that the implementation can use to write the result to.
42  	 * @param urlComponent The {@link URL} component that "owns" this renderer.
43  	 */
44  	void renderUrl(Writer writer, URL urlComponent);
45  	
46  	/***
47  	 * Render a Form URL.
48  	 * @param formComponent The {@link Form} component that "owns" this renderer.
49  	 */
50  	void renderFormUrl(Form formComponent);
51  
52  }