org.apache.fontbox.ttf.CmapLookup Maven / Gradle / Ivy

/*
 * 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.fontbox.ttf;

import java.util.List;

/**
 * An interface that abstracts the cid <-> codepoint lookup functionality of cmap.
 *
 * @author Aaron Madlon-Kay
 */
public interface CmapLookup
{

    /**
     * Returns the GlyphId linked with the given character code.
     *
     * @param codePointAt the given character code to be mapped
     * @return glyphId the corresponding glyph id for the given character code
     */
    int getGlyphId(int codePointAt);

    /**
     * Returns all possible character codes for the given gid, or null if there is none.
     *
     * @param gid glyph id
     * @return a list with all character codes the given gid maps to
     */
    List getCharCodes(int gid);

}