com.itextpdf.styledxmlparser.jsoup.safety.Whitelist Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of styled-xml-parser Show documentation
Styled XML parser is used by iText modules to parse HTML and XML
There is a newer version: 8.0.5
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2023 iText Group NV
    Authors: iText Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.styledxmlparser.jsoup.safety;

import com.itextpdf.styledxmlparser.jsoup.nodes.Attribute;
import com.itextpdf.styledxmlparser.jsoup.nodes.Attributes;
import com.itextpdf.styledxmlparser.jsoup.nodes.Element;

/**
 * @deprecated As of release v1.14.1, this class is deprecated in favour of {@link Safelist}. The name has
 * been changed with the intent of promoting more inclusive language. {@link Safelist} is a drop-in replacement, and no
 * further changes other than updating the name in your code are required to cleanly migrate. This class will be
 * removed in v1.15.1. Until that release, this class acts as a shim to maintain code compatibility
 * (source and binary).
 * 
 * For a clear rationale of the removal of this change, please see
 * Terminology,
 * Power, and Inclusive Language in Internet-Drafts and RFCs
 */
@Deprecated
public class Whitelist extends Safelist {
    public Whitelist() {
        super();
    }

    public Whitelist(Safelist copy) {
        super(copy);
    }

    static public Whitelist basic() {
        return new Whitelist(Safelist.basic());
    }

    static public Whitelist basicWithImages() {
        return new Whitelist(Safelist.basicWithImages());
    }

    static public Whitelist none() {
        return new Whitelist(Safelist.none());
    }

    static public Whitelist relaxed() {
        return new Whitelist(Safelist.relaxed());
    }

    static public Whitelist simpleText() {
        return new Whitelist(Safelist.simpleText());
    }

    @Override
    public Safelist addTags(String... tags) {
        super.addTags(tags);
        return this;
    }

    @Override
    public Safelist removeTags(String... tags) {
        super.removeTags(tags);
        return this;
    }

    @Override
    public Safelist addAttributes(String tag, String... attributes) {
        super.addAttributes(tag, attributes);
        return this;
    }

    @Override
    public Safelist removeAttributes(String tag, String... attributes) {
        super.removeAttributes(tag, attributes);
        return this;
    }

    @Override
    public Safelist addEnforcedAttribute(String tag, String attribute, String value) {
        super.addEnforcedAttribute(tag, attribute, value);
        return this;
    }

    @Override
    public Safelist removeEnforcedAttribute(String tag, String attribute) {
        super.removeEnforcedAttribute(tag, attribute);
        return this;
    }

    @Override
    public Safelist preserveRelativeLinks(boolean preserve) {
        super.preserveRelativeLinks(preserve);
        return this;
    }

    @Override
    public Safelist addProtocols(String tag, String attribute, String... protocols) {
        super.addProtocols(tag, attribute, protocols);
        return this;
    }

    @Override
    public Safelist removeProtocols(String tag, String attribute, String... removeProtocols) {
        super.removeProtocols(tag, attribute, removeProtocols);
        return this;
    }

    @Override
    protected boolean isSafeTag(String tag) {
        return super.isSafeTag(tag);
    }

    @Override
    protected boolean isSafeAttribute(String tagName, Element el, Attribute attr) {
        return super.isSafeAttribute(tagName, el, attr);
    }

    @Override
    Attributes getEnforcedAttributes(String tagName) {
        return super.getEnforcedAttributes(tagName);
    }
}