1 /*
2 * $Id: HTMLFormat.java,v 1.3 2005/04/11 14:45:38 colinmacleod Exp $
3 * Copyright (c) 2001 - 2005 ivata limited.
4 * All rights reserved.
5 * -----------------------------------------------------------------------------
6 * ivata masks may be redistributed under the GNU General Public
7 * License as published by the Free Software Foundation;
8 * version 2 of the License.
9 *
10 * These programs are free software; you can redistribute them and/or
11 * modify them under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; version 2 of the License.
13 *
14 * These programs are distributed in the hope that they will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
17 *
18 * See the GNU General Public License in the file LICENSE.txt for more
19 * details.
20 *
21 * If you would like a copy of the GNU General Public License write to
22 *
23 * Free Software Foundation, Inc.
24 * 59 Temple Place - Suite 330
25 * Boston, MA 02111-1307, USA.
26 *
27 *
28 * To arrange commercial support and licensing, contact ivata at
29 * http://www.ivata.com/contact.jsp
30 * -----------------------------------------------------------------------------
31 * $Log: HTMLFormat.java,v $
32 * Revision 1.3 2005/04/11 14:45:38 colinmacleod
33 * Changed HTMLFormat from an abstract class
34 * into an interface.
35 *
36 * Revision 1.2 2005/04/09 18:04:18 colinmacleod
37 * Changed copyright text to GPL v2 explicitly.
38 *
39 * Revision 1.1 2005/01/06 22:41:01 colinmacleod
40 * Moved up a version number.
41 * Changed copyright notices to 2005.
42 * Updated the documentation:
43 * - started working on multiproject:site docu.
44 * - changed the logo.
45 * Added checkstyle and fixed LOADS of style issues.
46 * Added separate thirdparty subproject.
47 * Added struts (in web), util and webgui (in webtheme) from ivata op.
48 *
49 * Revision 1.3 2004/03/21 21:16:37 colinmacleod
50 * Shortened name to ivata op.
51 *
52 * Revision 1.2 2004/02/01 22:07:32 colinmacleod
53 * Added full names to author tags
54 *
55 * Revision 1.1.1.1 2004/01/27 20:59:47 colinmacleod
56 * Moved ivata op to SourceForge.
57 *
58 * Revision 1.2 2003/10/15 14:13:39 colin
59 * Fixes for XDoclet.
60 *
61 * Revision 1.1 2003/02/24 19:33:32 colin
62 * Moved to new subproject.
63 *
64 * Revision 1.2 2003/02/04 17:43:46 colin
65 * copyright notice
66 *
67 * Revision 1.1 2002/06/21 11:58:37 colin
68 * restructured com.ivata.mask.jsp into separate sub-categories: format,
69 * JavaScript, theme and tree.
70 * -----------------------------------------------------------------------------
71 */
72 package com.ivata.mask.web.format;
73 /***
74 * <p>
75 * Abstract class defining the methods of a plug-in to {@link HTMLFormatter
76 * HTMLFormatter}. Each add-in should be a simple class performing one or two
77 * related formatting operations. These can then be combined to define a
78 * complete set of formatting in one formatter.
79 * </p>
80 *
81 * @since ivata masks 0.4 (2002-06-19)
82 * @author Colin MacLeod
83 * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
84 * @version $Revision: 1.3 $
85 */
86 public interface HTMLFormat {
87 /***
88 * <p>
89 * This method actually achieves the formatting and is overridden by each
90 * add-in.
91 * </p>
92 *
93 * @param hTMLText
94 * text to be converted - unformatted text.
95 * @return converted/formatted text.
96 */
97 String format(final String hTMLText);
98 }
99