burp.api.montoya.utilities.HtmlUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of montoya-api Show documentation

There is a newer version: 2024.12

/*
 * Copyright (c) 2022-2023. PortSwigger Ltd. All rights reserved.
 *
 * This code may be used to extend the functionality of Burp Suite Community Edition
 * and Burp Suite Professional, provided that this usage does not violate the
 * license terms for those products.
 */

package burp.api.montoya.utilities;

/**
 * This interface gives you access to HTML encoding and decoding features.
 */
public interface HtmlUtils
{
    /**
     * Encode HTML text using {@link HtmlEncoding#STANDARD} encoding.
     *
     * @param html {@code String} to be encoded.
     *
     * @return the encoded {@code String}.
     */
    String encode(String html);

    /**
     * Encode HTML text.
     *
     * @param html     {@code String} to be encoded.
     * @param encoding {@link HtmlEncoding} to be used.
     *
     * @return the encoded {@code String}.
     */
    String encode(String html, HtmlEncoding encoding);

    /**
     * Decode encoded HTML text.
     *
     * @param encodedHtml {@code String} to be decoded.
     *
     * @return the decoded {@code String}.
     */
    String decode(String encodedHtml);
}