Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
AnnotatedContent | 33 | 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 | ||
21 | package org.xwiki.blame; | |
22 | ||
23 | import java.util.Iterator; | |
24 | ||
25 | /** | |
26 | * Annotated content. | |
27 | * | |
28 | * @param <R> type of the revision object that old metadata about the revision. | |
29 | * @param <E> type of the element to annotate (ie: String holding a line). | |
30 | * @version $Id: adcb84cf7fe901604dd71016963550f9a949d889 $ | |
31 | * @since 6.2M2 | |
32 | */ | |
33 | public interface AnnotatedContent<R, E> extends Iterable<AnnotatedElement<R, E>> | |
34 | { | |
35 | @Override | |
36 | Iterator<AnnotatedElement<R, E>> iterator(); | |
37 | ||
38 | /** | |
39 | * @return the oldest revision provided to this annotated content. If you do not have further revision in | |
40 | * the past, you may consider all unannotated line to belong to that revision. To do so, you may also call | |
41 | * BlameManager#blame(AnnotatedContent, null, null) with this annotated content. | |
42 | */ | |
43 | R getOldestRevision(); | |
44 | ||
45 | /** | |
46 | * @return true if all elements as receive its source revision, which means that further call to BlameManager#blame | |
47 | * are useless. | |
48 | */ | |
49 | boolean isEntirelyAnnotated(); | |
50 | } |