Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
ContentAlterer | 32 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.annotation.content; | |
21 | ||
22 | import org.xwiki.component.annotation.Role; | |
23 | ||
24 | /** | |
25 | * Service that provides functionality for filtering a sequence of characters and producing an altered content from an | |
26 | * original content. | |
27 | * | |
28 | * @version $Id: 74322c1d768a911932365cc579c42a7d1049f6ee $ | |
29 | * @since 2.3M1 | |
30 | */ | |
31 | @Role | |
32 | public interface ContentAlterer | |
33 | { | |
34 | /** | |
35 | * @param sequence the characters sequence to alter | |
36 | * @return the altered content resulted from altering the passed sequence | |
37 | */ | |
38 | AlteredContent alter(CharSequence sequence); | |
39 | ||
40 | /** | |
41 | * Provides altering of an already altered content, such allowing for multiple alterers to be composed. | |
42 | * | |
43 | * @param alteredContent the already altered content to apply filtering on | |
44 | * @return AlteredContent the composed altered content | |
45 | */ | |
46 | AlteredContent alter(AlteredContent alteredContent); | |
47 | } |