org.verapdf.cos.xref.COSXRefEntry Maven / Gradle / Ivy

Go to download

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

veraPDF tools for parsing, modifying and creating PDF documents.

There is a newer version: 1.26.1

/**
 * This file is part of veraPDF Parser, a module of the veraPDF project.
 * Copyright (c) 2015, veraPDF Consortium 
 * All rights reserved.
 *
 * veraPDF Parser is free software: you can redistribute it and/or modify
 * it under the terms of either:
 *
 * The GNU General public license GPLv3+.
 * You should have received a copy of the GNU General Public License
 * along with veraPDF Parser as the LICENSE.GPL file in the root of the source
 * tree.  If not, see http://www.gnu.org/licenses/ or
 * https://www.gnu.org/licenses/gpl-3.0.en.html.
 *
 * The Mozilla Public License MPLv2+.
 * You should have received a copy of the Mozilla Public License along with
 * veraPDF Parser as the LICENSE.MPL file in the root of the source tree.
 * If a copy of the MPL was not distributed with this file, you can obtain one at
 * http://mozilla.org/MPL/2.0/.
 */
package org.verapdf.cos.xref;

/**
 * Class represents entry in xref. Entry has offset, generation and character
 * showing if it is a free entry.
 *
 * @author Timur Kamalov
 */
public class COSXRefEntry {

	/**
	 * Is offset of object in the document.
	 */
	public long offset;
	/**
	 * Is generation number for this entry.
	 */
	public int generation;
	/**
	 * Is 'f' is entry is free and 'n' otherwise.
	 */
	public char free;

	/**
	 * Default constructor that initializes offset and generation with zeroes,
	 * entry is marked as in-use.
	 */
	public COSXRefEntry() {
		this(0, 0, 'n');
	}

	/**
	 * Constructor from offset and generation. Entry is marked as in-use.
	 *
	 * @param offset is offset of object represented by this entry.
	 * @param generation is generation of object represented by this entry.
	 */
	public COSXRefEntry(long offset, int generation) {
		this(offset, generation, 'n');
	}

	/**
	 * Constructor setting offset, generation and free value.
	 *
	 * @param offset is offset of object represented by this entry.
	 * @param generation is generation of object represented by this entry.
	 * @param free is 'f' is entry is free and 'n' otherwise.
	 */
	public COSXRefEntry(long offset, int generation, char free) {
		this.offset = offset;
		this.generation = generation;
		this.free = free;
	}
}