1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.pdfbox.encoding.conversion;
18
19 import org.apache.fontbox.cmap.CMap;
20
21 /**
22 * EncodingConverter converts string or characters in one encoding, which is specified in PDF
23 * file, to another string with respective java charset. The mapping from
24 * PDF encoding name to java charset name is maintained by EncodingConversionManager
25
26 * @author Pin Xue (http://www.pinxue.net), Holly Lee (holly.lee (at) gmail.com)
27 * @version $Revision: 1.0 $
28 */
29 public interface EncodingConverter
30 {
31 /**
32 * Convert a string.
33 *
34 * @param s the string to be converted
35 * @return the converted string
36 */
37 public String convertString(String s);
38
39 /**
40 * Convert bytes to a string.
41 *
42 * @param c the byte array to be converted
43 * @param offset the starting offset of the array
44 * @param length the number of bytes
45 * @param cmap the cmap to be used for conversion
46 * @return the converted string
47 */
48 public String convertBytes(byte [] c, int offset, int length, CMap cmap);
49 }