1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.watchlist.internal

File WatchListEventConverter.java

 

Code metrics

0
0
0
1
40
8
0
-
-
0
-

Classes

Class Line # Actions
WatchListEventConverter 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   
25    /**
26    * Converts a given object to a {@link WatchListEvent}, if possible.
27    *
28    * @param <T> the type of the object we are converting from
29    * @version $Id: f51b38225cd4acd17c6dd19bed86f4a572a73681 $
30    */
31    @Role
 
32    public interface WatchListEventConverter<T>
33    {
34    /**
35    * @param from the object to convert from
36    * @param parameters any additional parameters needed in the conversion
37    * @return a {@link WatchListEvent} if the conversion was possible, {@code null} otherwise
38    */
39    WatchListEvent convert(T from, Object... parameters);
40    }