1 /***
2 * Copyright (c) 2003 held jointly by the individual authors.
3 *
4 * This library is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU Lesser General Public License as published
6 * by the Free Software Foundation; either version 2.1 of the License, or
7 * (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; with out even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this library; if not, write to the Free Software Foundation,
16 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17 *
18 * > http://www.gnu.org/copyleft/lesser.html
19 * > http://www.opensource.org/licenses/lgpl-license.php
20 */
21 package net.mlw.vlh.web.tag.support;
22
23 import java.util.Map;
24
25 import javax.servlet.jsp.PageContext;
26
27 /*** This interface defines a means to encode a url.
28 * This will allow for protlets and other unknow enviroments.
29 *
30 * @author Matthew L. Wilson
31 * @version $Revision: 1.5 $ $Date: 2004/08/17 15:30:50 $
32 */
33 public interface LinkEncoder
34 {
35 /*** Returns an encoded String from the given parameters.
36 *
37 * @param pageContext The PageContext to assist if needed.
38 * @param parameters A Map containing all the parameters to encode.
39 * @param includedKeys The parameters to include. Includes all if null or empty.
40 * @param ignoredKeys The parameters to exclude. Excludes none if null or empty.
41 * @return An encoded String
42 */
43 String encode(PageContext pageContext, Map parameters);
44 }