01: /*
02: JSPWiki - a JSP-based WikiWiki clone.
03:
04: Copyright (C) 2001-2002 Janne Jalkanen (Janne.Jalkanen@iki.fi)
05:
06: This program is free software; you can redistribute it and/or modify
07: it under the terms of the GNU Lesser General Public License as published by
08: the Free Software Foundation; either version 2.1 of the License, or
09: (at your option) any later version.
10:
11: This program is distributed in the hope that it will be useful,
12: but WITHOUT ANY WARRANTY; without even the implied warranty of
13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: GNU Lesser General Public License for more details.
15:
16: You should have received a copy of the GNU Lesser General Public License
17: along with this program; if not, write to the Free Software
18: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: */
20: package com.ecyrd.jspwiki;
21:
22: /**
23: * Defines an interface for transforming strings within a Wiki context.
24: *
25: * @since 1.6.4
26: */
27: public interface StringTransmutator {
28: /**
29: * Returns a changed String, suitable for Wiki context.
30: *
31: * @param context WikiContext in which mutation is to be done
32: * @param source The source string.
33: * @return The mutated string.
34: */
35: public String mutate(WikiContext context, String source);
36: }
|