1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package com.xpn.xwiki.internal.filter.output

File EntityOutputFilterStream.java

 

Code metrics

0
0
0
1
71
15
0
-
-
0
-

Classes

Class Line # Actions
EntityOutputFilterStream 35 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 com.xpn.xwiki.internal.filter.output;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.filter.instance.output.DocumentInstanceOutputProperties;
24   
25    import com.xpn.xwiki.internal.filter.XWikiDocumentFilter;
26   
27    /**
28    * Create an entity from filter events.
29    *
30    * @param <E> the type of the entity supported
31    * @version $Id: f28c441617c7966cbfe20f579dcdbd5059516dd1 $
32    * @since 9.0RC1
33    */
34    @Role
 
35    public interface EntityOutputFilterStream<E> extends XWikiDocumentFilter
36    {
37    /**
38    * @return the filter to send events to
39    */
40    Object getFilter();
41   
42    /**
43    * @return the entity
44    */
45    E getEntity();
46   
47    /**
48    * @param entity the entity
49    */
50    void setEntity(E entity);
51   
52    /**
53    * @param properties the properties to control EntityOutputFilterStream behavior
54    */
55    void setProperties(DocumentInstanceOutputProperties properties);
56   
57    /**
58    * @return true if the listener is enabled
59    */
60    boolean isEnabled();
61   
62    /**
63    * Enable.
64    */
65    void enable();
66   
67    /**
68    * Disable.
69    */
70    void disable();
71    }