1 /*
2 * $Id: PdfIndirectReference.java 3912 2009-04-26 08:38:15Z blowagie $
3 *
4 * Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
5 *
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * (the "License"); you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the License.
13 *
14 * The Original Code is 'iText, a free JAVA-PDF library'.
15 *
16 * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
17 * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
18 * All Rights Reserved.
19 * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
20 * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
21 *
22 * Contributor(s): all the names of the contributors are added in the source code
23 * where applicable.
24 *
25 * Alternatively, the contents of this file may be used under the terms of the
26 * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
27 * provisions of LGPL are applicable instead of those above. If you wish to
28 * allow use of your version of this file only under the terms of the LGPL
29 * License and not to allow others to use your version of this file under
30 * the MPL, indicate your decision by deleting the provisions above and
31 * replace them with the notice and other provisions required by the LGPL.
32 * If you do not delete the provisions above, a recipient may use your version
33 * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
34 *
35 * This library is free software; you can redistribute it and/or modify it
36 * under the terms of the MPL as stated above or under the terms of the GNU
37 * Library General Public License as published by the Free Software Foundation;
38 * either version 2 of the License, or any later version.
39 *
40 * This library is distributed in the hope that it will be useful, but WITHOUT
41 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
42 * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
43 * details.
44 *
45 * If you didn't download this code from the following link, you should check if
46 * you aren't using an obsolete version:
47 * http://www.lowagie.com/iText/
48 */
49
50 package com.lowagie.text.pdf;
51
52 /**
53 * <CODE>PdfIndirectReference</CODE> contains a reference to a <CODE>PdfIndirectObject</CODE>.
54 * <P>
55 * Any object used as an element of an array or as a value in a dictionary may be specified
56 * by either a direct object of an indirect reference. An <I>indirect reference</I> is a reference
57 * to an indirect object, and consists of the indirect object's object number, generation number
58 * and the <B>R</B> keyword.<BR>
59 * This object is described in the 'Portable Document Format Reference Manual version 1.3'
60 * section 4.11 (page 54).
61 *
62 * @see PdfObject
63 * @see PdfIndirectObject
64 */
65
66 public class PdfIndirectReference extends PdfObject {
67
68 // membervariables
69
70 /** the object number */
71 protected int number;
72
73 /** the generation number */
74 protected int generation = 0;
75
76 // constructors
77
78 protected PdfIndirectReference() {
79 super(0);
80 }
81
82 /**
83 * Constructs a <CODE>PdfIndirectReference</CODE>.
84 *
85 * @param type the type of the <CODE>PdfObject</CODE> that is referenced to
86 * @param number the object number.
87 * @param generation the generation number.
88 */
89
90 PdfIndirectReference(int type, int number, int generation) {
91 super(0, new StringBuffer().append(number).append(" ").append(generation).append(" R").toString());
92 this.number = number;
93 this.generation = generation;
94 }
95
96 /**
97 * Constructs a <CODE>PdfIndirectReference</CODE>.
98 *
99 * @param type the type of the <CODE>PdfObject</CODE> that is referenced to
100 * @param number the object number.
101 */
102
103 PdfIndirectReference(int type, int number) {
104 this(type, number, 0);
105 }
106
107 // methods
108
109 /**
110 * Returns the number of the object.
111 *
112 * @return a number.
113 */
114
115 public int getNumber() {
116 return number;
117 }
118
119 /**
120 * Returns the generation of the object.
121 *
122 * @return a number.
123 */
124
125 public int getGeneration() {
126 return generation;
127 }
128
129 public String toString() {
130 return new StringBuffer().append(number).append(" ").append(generation).append(" R").toString();
131 }
132 }