com.itextpdf.kernel.pdf.DocumentRevision 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-2024 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;

/**
 * Class which stores information about single PDF document revision.
 */
public class DocumentRevision {
    private final long eofOffset;
    private final Set modifiedObjects;

    /**
     * Creates {@link DocumentRevision} from end-of-file byte position and a set of indirect references which were
     * modified in this document revision.
     *
     * @param eofOffset       end-of-file byte position
     * @param modifiedObjects {@link Set} of {@link PdfIndirectReference} objects which were modified
     */
    public DocumentRevision(long eofOffset, Set modifiedObjects) {
        this.eofOffset = eofOffset;
        this.modifiedObjects = modifiedObjects;
    }

    /**
     * Gets end-of-file byte position.
     *
     * @return end-of-file byte position
     */
    public long getEofOffset() {
        return eofOffset;
    }

    /**
     * Gets objects which were modified in this document revision.
     *
     * @return {@link Set} of {@link PdfIndirectReference} objects which were modified
     */
    public Set getModifiedObjects() {
        return modifiedObjects;
    }
}