com.itextpdf.kernel.pdf.IPdfNameTreeAccess Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kernel-android Show documentation

There is a newer version: 9.0.0

/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2023 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.kernel.pdf;

import java.util.Set;

/**
 * Abstract access interface to a PDF name tree.
 */
public interface IPdfNameTreeAccess {

    /**
     * Retrieve an entry from the name tree.
     *
     * @param key  key of entry to retrieve
     * @return retrieved entry or {@code null} if absent
     */
    PdfObject getEntry(PdfString key);

    /**
     * Retrieve an entry from the name tree.
     *
     * @param key  key of entry to retrieve
     * @return retrieved entry or {@code null} if absent
     */
    PdfObject getEntry(String key);

    /**
     * Retrieve the set of keys in the name tree.
     *
     * @return set of all keys in the name tree
     */
    Set getKeys();
}