3e4c583e4c3873c69d3a9710ca7aca1d203eadf2
[mir.git] / source / mir / util / HTMLRoutines.java
1 /*\r
2  * Copyright (C) 2001, 2002  The Mir-coders group\r
3  *\r
4  * This file is part of Mir.\r
5  *\r
6  * Mir is free software; you can redistribute it and/or modify\r
7  * it under the terms of the GNU General Public License as published by\r
8  * the Free Software Foundation; either version 2 of the License, or\r
9  * (at your option) any later version.\r
10  *\r
11  * Mir is distributed in the hope that it will be useful,\r
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
14  * GNU General Public License for more details.\r
15  *\r
16  * You should have received a copy of the GNU General Public License\r
17  * along with Mir; if not, write to the Free Software\r
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
19  *\r
20  * In addition, as a special exception, The Mir-coders gives permission to link\r
21  * the code of this program with the com.oreilly.servlet library, any library\r
22  * licensed under the Apache Software License, The Sun (tm) Java Advanced\r
23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of\r
24  * the above that use the same license as the above), and distribute linked\r
25  * combinations including the two.  You must obey the GNU General Public\r
26  * License in all respects for all of the code used other than the above\r
27  * mentioned libraries.  If you modify this file, you may extend this exception\r
28  * to your version of the file, but you are not obligated to do so.  If you do\r
29  * not wish to do so, delete this exception statement from your version.\r
30  */\r
31 \r
32 package mir.util;\r
33 \r
34 import java.net.URLEncoder;\r
35 \r
36 public class HTMLRoutines {\r
37 \r
38   public static String encodeURL(String aString) {\r
39     return URLEncoder.encode(aString);\r
40   }\r
41 \r
42   /**\r
43    *\r
44    *\r
45    * @param aString\r
46    * @param anEncoding the encoding to use (Note: JDK 1.3 does not seem to support custom\r
47    *             encodings, so this parameter is ignored for now)\r
48    * @return\r
49    */\r
50 \r
51   public static String encodeURL(String aString, String anEncoding) {\r
52     try {\r
53       return URLEncoder.encode(aString);\r
54     }\r
55     catch (Throwable t) {\r
56       throw new RuntimeException(t.getMessage());\r
57     }\r
58   }\r
59 \r
60   public static String encodeHTML(String aText) {\r
61     final char[] CHARACTERS_TO_ESCAPE = { '&', '<', '>', '"' };\r
62     final String[] ESCAPE_CODES = { "&amp;", "&lt;", "&gt;", "&quot;" };\r
63 \r
64     return StringRoutines.replaceStringCharacters(aText, CHARACTERS_TO_ESCAPE, ESCAPE_CODES);\r
65   }\r
66 \r
67   public static String encodeXML(String aText) {\r
68     final char[] CHARACTERS_TO_ESCAPE = { '&', '<', '>', '"', '\'' };\r
69     final String[] ESCAPE_CODES = { "&amp;", "&lt;", "&gt;", "&quot;", "&apos;" };\r
70 \r
71     return StringRoutines.replaceStringCharacters(aText, CHARACTERS_TO_ESCAPE, ESCAPE_CODES);\r
72   }\r
73 }