File AbstractEntityEventGenerator.java
Coverage histogram
0% of files have more coverage
Classes
| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| AbstractEntityEventGenerator | 40 | 6 | 0% | 4 | 0 |
Contributing tests
This file is covered by 19 tests.
.
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 java.lang.reflect.ParameterizedType; | |
| 23 | import java.util.Map; | |
| 24 | ||
| 25 | import javax.inject.Inject; | |
| 26 | ||
| 27 | import org.xwiki.component.phase.Initializable; | |
| 28 | import org.xwiki.component.phase.InitializationException; | |
| 29 | import org.xwiki.component.util.ReflectionUtils; | |
| 30 | import org.xwiki.filter.FilterDescriptorManager; | |
| 31 | import org.xwiki.filter.FilterException; | |
| 32 | import org.xwiki.filter.descriptor.FilterStreamDescriptor; | |
| 33 | ||
| 34 | /** | |
| 35 | * @param <E> the type of the entity (XWikiDocument, BaseObject, BaseClass, etc.) | |
| 36 | * @param <F> the type of the filter declaring the events supported by this {@link EntityEventGenerator} | |
| 37 | * @version $Id: 035175dd379d2ccbac878c9bfc4dc50ab9cd4050 $ | |
| 38 | * @since 6.2M1 | |
| 39 | */ | |
| 40 | public abstract class AbstractEntityEventGenerator<E, F> implements EntityEventGenerator<E>, Initializable | |
| 41 | { | |
| 42 | @Inject | |
| 43 | protected FilterDescriptorManager filterDescriptorManager; | |
| 44 | ||
| 45 | protected Class<F> filterType; | |
| 46 | ||
| 47 | protected FilterStreamDescriptor descriptor; | |
| 48 | ||
| 49 | 476 |  @Override |
| 50 | public void initialize() throws InitializationException | |
| 51 | { | |
| 52 | // Get the type of the internal filter | |
| 53 | 476 | ParameterizedType genericType = |
| 54 | (ParameterizedType) ReflectionUtils.resolveType(AbstractEntityEventGenerator.class, getClass()); | |
| 55 | 476 | this.filterType = ReflectionUtils.getTypeClass(genericType.getActualTypeArguments()[1]); |
| 56 | } | |
| 57 | ||
| 58 | 2 | @Override |
| 59 | public FilterStreamDescriptor getDescriptor() | |
| 60 | { | |
| 61 | 2 | return this.descriptor; |
| 62 | } | |
| 63 | ||
| 64 | 476 | protected void setDescriptor(FilterStreamDescriptor descriptor) |
| 65 | { | |
| 66 | 476 | this.descriptor = descriptor; |
| 67 | } | |
| 68 | ||
| 69 | 29737 | @Override |
| 70 | public void write(E entity, Object filter, Map<String, Object> properties) throws FilterException | |
| 71 | { | |
| 72 | 29737 | F internalFilter = this.filterDescriptorManager.createFilterProxy(filter, this.filterType); |
| 73 | ||
| 74 | 29737 | write(entity, filter, internalFilter, properties); |
| 75 | } | |
| 76 | ||
| 77 | protected abstract void write(E entity, Object filter, F internalFilter, Map<String, Object> properties) | |
| 78 | throws FilterException; | |
| 79 | } |