net.pwall.pipeline.codec.EncoderFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pipelines Show documentation
Pipelines Library for Java
The newest version!
/*
 * @(#) EncoderFactory.java
 *
 * pipelines   Pipeline conversion library for Java
 * Copyright (c) 2023 Peter Wall
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package net.pwall.pipeline.codec;

import net.pwall.pipeline.AbstractIntPipeline;
import net.pwall.pipeline.IntAcceptor;

import java.nio.charset.Charset;

/**
 * Factory class to get encoder pipeline objects for a given encoding.
 *
 * @author  Peter Wall
 */
public class EncoderFactory {

    /**
     * Get an encoder pipeline for the given character set name.
     *
     * @param   charsetName     the character set name
     * @param   downstream      the downstream {@link IntAcceptor}
     * @param   errorStrategy   the error strategy to be used on errors
     * @param                the pipeline result type
     * @return  a pipeline (with UTF-8 as the default)
     */
    public static  AbstractIntPipeline getEncoder(
            String charsetName,
            IntAcceptor downstream,
            ErrorStrategy errorStrategy
    ) {
        if (charsetName.equalsIgnoreCase("windows-1252"))
            return new UTF16_Windows1252<>(downstream, errorStrategy);

        if (charsetName.equalsIgnoreCase("ISO-8859-1"))
            return new UTF16_ISO8859_1<>(downstream, errorStrategy);

        if (charsetName.equalsIgnoreCase("ISO-8859-15"))
            return new UTF16_ISO8859_15<>(downstream, errorStrategy);

        if (charsetName.equalsIgnoreCase("US-ASCII"))
            return new UTF16_ASCII<>(downstream, errorStrategy);

        return new CodePoint_UTF8<>(downstream, errorStrategy);
    }

    /**
     * Get an encoder pipeline for the given character set name.
     *
     * @param   charsetName     the character set name
     * @param   downstream      the downstream {@link IntAcceptor}
     * @param                the pipeline result type
     * @return  a pipeline (with UTF-8 as the default)
     */
    public static  AbstractIntPipeline getEncoder(
            String charsetName,
            IntAcceptor downstream
    ) {
        return getEncoder(charsetName, downstream, ErrorStrategy.DEFAULT);
    }

    /**
     * Get an encoder pipeline for the given {@link Charset}.
     *
     * @param   charset         the character set name
     * @param   downstream      the downstream {@link IntAcceptor}
     * @param   errorStrategy   the error strategy to be used on errors
     * @param                the pipeline result type
     * @return  a pipeline (with UTF-8 as the default)
     */
    public static  AbstractIntPipeline getEncoder(
            Charset charset,
            IntAcceptor downstream,
            ErrorStrategy errorStrategy
    ) {
        return getEncoder(charset.name(), downstream, errorStrategy);
    }

    /**
     * Get an encoder pipeline for the given {@link Charset}.
     *
     * @param   charset         the character set name
     * @param   downstream      the downstream {@link IntAcceptor}
     * @param                the pipeline result type
     * @return  a pipeline (with UTF-8 as the default)
     */
    public static  AbstractIntPipeline getEncoder(
            Charset charset,
            IntAcceptor downstream
    ) {
        return getEncoder(charset.name(), downstream, ErrorStrategy.DEFAULT);
    }

}