1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.annotation.maintainer

File AnnotationMaintainer.java

 

Code metrics

0
0
0
1
46
8
0
-
-
0
-

Classes

Class Line # Actions
AnnotationMaintainer 32 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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    import org.xwiki.component.annotation.Role;
23   
24    /**
25    * Interface defining the annotation maintainer service, which should be able to update the annotations on a specified
26    * target, wrt to the previous and the current versions of the content.
27    *
28    * @version $Id: e6173f4ad418dfe4382d755b2da5f4bcc7e642dd $
29    * @since 2.3M1
30    */
31    @Role
 
32    public interface AnnotationMaintainer
33    {
34    /**
35    * Updates all the annotations found on the passed target. Should use the IO services to get the annotations and
36    * information about the target, such as syntax.
37    *
38    * @param target is serialized reference to the content concerned by the annotation
39    * @param previousContent the previous content of the document (before the update)
40    * @param currentContent the current content of the document (after the update)
41    * @throws MaintainerServiceException in case something goes wrong handling the annotation updates on the passed
42    * content
43    */
44    void updateAnnotations(String target, String previousContent, String currentContent)
45    throws MaintainerServiceException;
46    }