org.apache.pdfbox.encoding.EncodingManager Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of pdfbox Show documentation

The Apache PDFBox library is an open source Java tool for working with PDF documents.

There is a newer version: 3.0.2

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.pdfbox.encoding;

import java.io.IOException;

import org.apache.pdfbox.cos.COSName;

/**
 * This class will handle getting the appropriate encodings.
 *
 * @author Ben Litchfield
 * @version $Revision: 1.9 $
 */
public class EncodingManager
{

    /**
     * Default singleton instance of this class.
     *
     * @since Apache PDFBox 1.3.0
     */
    public static final EncodingManager INSTANCE = new EncodingManager();

    /**
     * This will get the standard encoding.
     *
     * @return The standard encoding.
     */
    public Encoding getStandardEncoding() {
        return StandardEncoding.INSTANCE;
    }

    /**
     * This will get an encoding by name.
     *
     * @param name The name of the encoding to get.
     * @return The encoding that matches the name.
     * @throws IOException if there is no encoding with that name.
     */
    public Encoding getEncoding( COSName name ) throws IOException {
        if (COSName.STANDARD_ENCODING.equals(name)) {
            return StandardEncoding.INSTANCE;
        } else if (COSName.WIN_ANSI_ENCODING.equals(name)) {
            return WinAnsiEncoding.INSTANCE;
        } else if (COSName.MAC_ROMAN_ENCODING.equals(name)) {
            return MacRomanEncoding.INSTANCE;
        } else if (COSName.PDF_DOC_ENCODING.equals(name)) {
            return PdfDocEncoding.INSTANCE;
        } else {
            throw new IOException(
                    "Unknown encoding for '" + name.getName() + "'");
        }
    }

}