001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.util;
029
030import java.io.UnsupportedEncodingException;
031import java.util.List;
032
033/**
034 * HTML converters can be used to clean up HTML code and/or pretty print the code.<p>
035 *
036 * They can be configured in the configuration file <code>opencms-vfs.xml</code> and triggered when saving
037 * XML contents or XML pages. Their behavior is configurable by setting the <code>content-conversion</code> property
038 * value on VFS resources.<p>
039 *
040 * @since 7.5.1
041 *
042 */
043public interface I_CmsHtmlConverter {
044
045    /**
046     * Converts the given HTML code according to the settings of this converter.<p>
047     *
048     * @param htmlInput the HTML input stored in a string
049     * @return string containing the converted HTML
050     *
051     * @throws UnsupportedEncodingException if the encoding set for the conversion is not supported
052     */
053    String convertToString(String htmlInput) throws UnsupportedEncodingException;
054
055    /**
056     * Returns the encoding used for the HTML code conversion.<p>
057     *
058     * @return the encoding used for the HTML code conversion
059     */
060    String getEncoding();
061
062    /**
063     * Returns the conversion modes to use as List of String parameters.<p>
064     *
065     * @return the conversion modes to use as List of String parameters
066     */
067    List<String> getModes();
068
069    /**
070     * Initializes the HTML converter instance.<p>
071     *
072     * Possible values for the conversion mode are dependent from the converter implementation.<p>
073     *
074     * @param encoding the encoding used for the HTML code conversion
075     * @param modes the conversion modes to use
076     */
077    void init(String encoding, List<String> modes);
078
079}