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

File WatchListEventHTMLDiffExtractor.java

 

Code metrics

0
0
0
1
40
9
0
-
-
0
-

Classes

Class Line # Actions
WatchListEventHTMLDiffExtractor 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.watchlist.internal;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.watchlist.internal.api.WatchListEvent;
24    import org.xwiki.watchlist.internal.api.WatchListException;
25   
26    /**
27    * Extracts the diff based on the change(s) described by a {@link WatchListEvent} and displays them as HTML.
28    *
29    * @version $Id: a94ba560b68b3465c332384d98dab01bfb58292c $
30    */
31    @Role
 
32    public interface WatchListEventHTMLDiffExtractor
33    {
34    /**
35    * @param event the event describing the changes
36    * @return the HTML string representing the diff caused by the changes described by the event
37    * @throws WatchListException if problems occur
38    */
39    String getHTMLDiff(WatchListEvent event) throws WatchListException;
40    }