HTMLFilter.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.wysiwyg.server.internal.cleaner;

import org.xwiki.component.annotation.Role;

/**
 * Interface used to tag WYSIWYG editor specific HTML cleaning filters.
 * 
 * @version $Id: f126ca41ff2416a913a619e63f62858c8e6389f8 $
 */
@Role
public interface HTMLFilter extends org.xwiki.xml.html.filter.HTMLFilter
{
    /**
     * The filter priority is used to determine the order in which filters are applied. The lower the returned value the
     * higher the priority. 0 is top priority.
     * 
     * @return the priority of this filter
     */
    int getPriority();
}