KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > pdf > PdfIndirectReference


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