KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > pdf > PDFObject


1 /*
2  * $Id: PDFObject.java,v 1.10.2.1 2003/02/25 14:29:37 jeremias Exp $
3  * ============================================================================
4  * The Apache Software License, Version 1.1
5  * ============================================================================
6  *
7  * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without modifica-
10  * tion, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if any, must
20  * include the following acknowledgment: "This product includes software
21  * developed by the Apache Software Foundation (http://www.apache.org/)."
22  * Alternately, this acknowledgment may appear in the software itself, if
23  * and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. The names "FOP" and "Apache Software Foundation" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * apache@apache.org.
29  *
30  * 5. Products derived from this software may not be called "Apache", nor may
31  * "Apache" appear in their name, without prior written permission of the
32  * Apache Software Foundation.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  * ============================================================================
45  *
46  * This software consists of voluntary contributions made by many individuals
47  * on behalf of the Apache Software Foundation and was originally created by
48  * James Tauber <jtauber@jtauber.com>. For more information on the Apache
49  * Software Foundation, please see <http://www.apache.org/>.
50  */
51 package org.apache.fop.pdf;
52
53 // Java
54 import java.io.IOException JavaDoc;
55 import java.io.OutputStream JavaDoc;
56
57 /**
58  * generic PDF object.
59  *
60  * A PDF Document is essentially a collection of these objects. A PDF
61  * Object has a number and a generation (although the generation will always
62  * be 0 in new documents).
63  */
64 public abstract class PDFObject {
65
66     /**
67      * the object's number
68      */
69     protected int number;
70
71     /**
72      * the object's generation (0 in new documents)
73      */
74     protected int generation = 0;
75
76     /**
77      * create an empty object
78      *
79      * @param number the object's number
80      */
81     public PDFObject(int number) {
82         this.number = number;
83     }
84
85     public PDFObject() {
86         // do nothing
87 }
88
89     /**
90      * @return the PDF Object number
91      */
92     public int getNumber() {
93         return this.number;
94     }
95
96     /**
97      * write the PDF represention of this object
98      *
99      * @param stream the stream to write the PDF to
100      * @return the number of bytes written
101      */
102     protected int output(OutputStream JavaDoc stream) throws IOException JavaDoc {
103         byte[] pdf = this.toPDF();
104         stream.write(pdf);
105         return pdf.length;
106     }
107
108     /**
109      * the PDF representation of a reference to this object
110      *
111      * @return the reference string
112      */
113     public String JavaDoc referencePDF() {
114         String JavaDoc p = this.number + " " + this.generation + " R";
115         return p;
116     }
117
118     /**
119      * represent object as PDF
120      *
121      * @return PDF string
122      */
123     abstract byte[] toPDF();
124 }
125
Popular Tags