io.nosqlbench.virtdata.library.basics.shared.unary_string.HTMLEntityEncode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-basics Show documentation

The newest version!

/*
 * Copyright (c) 2022 nosqlbench
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.nosqlbench.virtdata.library.basics.shared.unary_string;

import io.nosqlbench.virtdata.api.annotations.Categories;
import io.nosqlbench.virtdata.api.annotations.Category;
import io.nosqlbench.virtdata.api.annotations.Example;
import io.nosqlbench.virtdata.api.annotations.ThreadSafeMapper;
import org.apache.commons.text.StringEscapeUtils;

import java.util.function.Function;

/**
 * encode HTML Entities
 */
@ThreadSafeMapper
@Categories({Category.conversion})
public class HTMLEntityEncode implements Function {

    @Example({"HTMLEntityEncode()", "Encode/Escape input into HTML4 valid entties."})
    public HTMLEntityEncode() {}

    @Override
    public String apply(String s) {
        return StringEscapeUtils.escapeHtml4(s);
    }
}