KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > examples > AbstractExample


1 /**
2  * Copyright (c) 2003, www.pdfbox.org
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * 3. Neither the name of pdfbox; nor the names of its
14  * contributors may be used to endorse or promote products derived from this
15  * software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * http://www.pdfbox.org
29  *
30  */
31 package org.pdfbox.examples;
32
33 import java.io.IOException JavaDoc;
34 import java.io.InputStream JavaDoc;
35 import java.io.OutputStream JavaDoc;
36
37 import org.pdfbox.cos.COSDocument;
38
39 import org.pdfbox.pdmodel.PDDocument;
40
41 import org.pdfbox.pdfwriter.COSWriter;
42
43 /**
44  * A simple class which has some methods used by all examples.
45  *
46  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
47  * @version $Revision: 1.4 $
48  */
49 public abstract class AbstractExample
50 {
51     /**
52      * Close the stream.
53      *
54      * @param stream The stream to close.
55      *
56      * @throws IOException If there is an error closing the stream.
57      */
58     public void close( InputStream JavaDoc stream ) throws IOException JavaDoc
59     {
60         if( stream != null )
61         {
62             stream.close();
63         }
64     }
65
66     /**
67      * Close the stream.
68      *
69      * @param stream The stream to close.
70      *
71      * @throws IOException If there is an error closing the stream.
72      */
73     public void close( OutputStream JavaDoc stream ) throws IOException JavaDoc
74     {
75         if( stream != null )
76         {
77             stream.close();
78         }
79     }
80
81     /**
82      * Close the document.
83      *
84      * @param doc The doc to close.
85      *
86      * @throws IOException If there is an error closing the document.
87      */
88     public void close( COSDocument doc ) throws IOException JavaDoc
89     {
90         if( doc != null )
91         {
92             doc.close();
93         }
94     }
95
96     /**
97      * Close the document.
98      *
99      * @param doc The doc to close.
100      *
101      * @throws IOException If there is an error closing the document.
102      */
103     public void close( PDDocument doc ) throws IOException JavaDoc
104     {
105         if( doc != null )
106         {
107             doc.close();
108         }
109     }
110
111     /**
112      * Close the writer.
113      *
114      * @param writer The writer to close.
115      *
116      * @throws IOException If there is an error closing the writer.
117      */
118     public static void close( COSWriter writer ) throws IOException JavaDoc
119     {
120         if( writer != null )
121         {
122             writer.close();
123         }
124     }
125 }
Popular Tags