1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.filter.instance.input

File BeanEntityEventGenerator.java

 

Code metrics

0
0
0
1
39
6
0
-
-
0
-

Classes

Class Line # Actions
BeanEntityEventGenerator 30 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.filter.instance.input;
21   
22    import org.xwiki.filter.FilterException;
23   
24    /**
25    * @param <E> the type of the entity (XWikiDocument, BaseObject, BaseClass, etc.)
26    * @param <P> the type of the properties bean
27    * @version $Id: 9a3f4262cf7780c129e46775b88bd217854fd19b $
28    * @since 9.0RC1
29    */
 
30    public interface BeanEntityEventGenerator<E, P> extends EntityEventGenerator<E>
31    {
32    /**
33    * @param entity the entity to read
34    * @param filter the filter to send events to
35    * @param properties the properties
36    * @throws FilterException when failing to convert passed entity into events
37    */
38    void write(E entity, Object filter, P properties) throws FilterException;
39    }