| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| FilterStreamFactory | 34 | 0 | - | 0 | 0 |
| 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; | |
| 21 | ||
| 22 | import java.util.Collection; | |
| 23 | ||
| 24 | import org.xwiki.filter.descriptor.FilterStreamDescriptor; | |
| 25 | import org.xwiki.filter.type.FilterStreamType; | |
| 26 | ||
| 27 | /** | |
| 28 | * Filter class should be inherited by all the stream based classes to implement the type and descriptor which describes | |
| 29 | * a filter with list of bean class parameters. | |
| 30 | * | |
| 31 | * @version $Id: bd35719417bb6109a371443b64805b9f66bfa874 $ | |
| 32 | * @since 6.2M1 | |
| 33 | */ | |
| 34 | public interface FilterStreamFactory | |
| 35 | { | |
| 36 | /** | |
| 37 | * @return The {@link FilterStreamType}, which identifies a filter input and output components using a role hint. | |
| 38 | */ | |
| 39 | FilterStreamType getType(); | |
| 40 | ||
| 41 | /** | |
| 42 | * @return The FilterDescriptor describes a Filter and has the list of bean class parameters or properties. | |
| 43 | */ | |
| 44 | FilterStreamDescriptor getDescriptor(); | |
| 45 | ||
| 46 | /** | |
| 47 | * @return the filters supported by this stream factory | |
| 48 | * @throws FilterException when failing to get filters interfaces | |
| 49 | */ | |
| 50 | Collection<Class<?>> getFilterInterfaces() throws FilterException; | |
| 51 | } |