com.aowagie.text.pdf.PdfIndirectObject Maven / Gradle / Ivy
/*
* $Id: PdfIndirectObject.java 3912 2009-04-26 08:38:15Z blowagie $
* $Name$
*
* Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library 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 Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.aowagie.text.pdf;
import java.io.IOException;
import java.io.OutputStream;
import com.aowagie.text.DocWriter;
/**
* PdfIndirectObject is the Pdf indirect object.
*
* An indirect object is an object that has been labeled so that it can be referenced by
* other objects. Any type of PdfObject may be labeled as an indirect object.
* An indirect object consists of an object identifier, a direct object, and the endobj
* keyword. The object identifier consists of an integer object number, an integer
* generation number, and the obj keyword.
* This object is described in the 'Portable Document Format Reference Manual version 1.7'
* section 3.2.9 (page 63-65).
*
* @see PdfObject
* @see PdfIndirectReference
*/
public final class PdfIndirectObject {
// membervariables
/** The object number */
private final int number;
/** the generation number */
private int generation = 0;
private static final byte STARTOBJ[] = DocWriter.getISOBytes(" obj\n");
private static final byte ENDOBJ[] = DocWriter.getISOBytes("\nendobj\n");
private final PdfObject object;
private final PdfWriter writer;
// constructors
/**
* Constructs a PdfIndirectObject.
*
* @param number the object number
* @param object the direct object
*/
PdfIndirectObject(final int number, final PdfObject object, final PdfWriter writer) {
this(number, 0, object, writer);
}
/**
* Constructs a PdfIndirectObject.
*
* @param number the object number
* @param generation the generation number
* @param object the direct object
*/
private PdfIndirectObject(final int number, final int generation, final PdfObject object, final PdfWriter writer) {
this.writer = writer;
this.number = number;
this.generation = generation;
this.object = object;
PdfEncryption crypto = null;
if (writer != null) {
crypto = writer.getEncryption();
}
if (crypto != null) {
crypto.setHashKey(number, generation);
}
}
// methods
/**
* Return the length of this PdfIndirectObject.
*
* @return the length of the PDF-representation of this indirect object.
*/
// public int length() {
// if (isStream)
// return bytes.size() + SIZEOBJ + stream.getStreamLength(writer);
// else
// return bytes.size();
// }
/**
* Returns a PdfIndirectReference to this PdfIndirectObject.
*
* @return a PdfIndirectReference
*/
public PdfIndirectReference getIndirectReference() {
return new PdfIndirectReference(this.object.type(), this.number, this.generation);
}
/**
* Writes efficiently to a stream
*
* @param os the stream to write to
* @throws IOException on write error
*/
void writeTo(final OutputStream os) throws IOException
{
os.write(DocWriter.getISOBytes(String.valueOf(this.number)));
os.write(' ');
os.write(DocWriter.getISOBytes(String.valueOf(this.generation)));
os.write(STARTOBJ);
this.object.toPdf(this.writer, os);
os.write(ENDOBJ);
}
}