Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
XDelta | 28 | 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.maintainer; | |
21 | ||
22 | /** | |
23 | * This interface models a difference between two pieces of content. | |
24 | * | |
25 | * @version $Id: 6b49c4bdead602a2d3a3b62203e47ca95adf64b4 $ | |
26 | * @since 2.3M1 | |
27 | */ | |
28 | public interface XDelta | |
29 | { | |
30 | /** | |
31 | * @return the position in the original content where the edit takes place | |
32 | */ | |
33 | int getOffset(); | |
34 | ||
35 | /** | |
36 | * @return the length difference between the old content and the new content | |
37 | */ | |
38 | int getSignedDelta(); | |
39 | ||
40 | /** | |
41 | * Returns the original string at the position returned by {@link #getOffset()}. If this string is void and the one | |
42 | * returned by {@link #getChanged()} is not, it means that this difference is an addition at position | |
43 | * {@link #getOffset()}. | |
44 | * | |
45 | * @return the original string at the position returned by {@link #getOffset()} | |
46 | */ | |
47 | String getOriginal(); | |
48 | ||
49 | /** | |
50 | * Returns the modified string at the position returned by {@link #getOffset()}. If this string is void and the one | |
51 | * returned by {@link #getOriginal()} is not, it means that this difference is a deletion at position | |
52 | * {@link #getOffset()}. | |
53 | * | |
54 | * @return the modified string at the position returned by {@link #getOffset()} | |
55 | */ | |
56 | String getChanged(); | |
57 | } |