KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > common > PDMetadata


1 /**
2  * Copyright (c) 2005, 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.pdmodel.common;
32
33 import java.io.IOException JavaDoc;
34 import java.io.InputStream JavaDoc;
35
36 import org.pdfbox.cos.COSStream;
37
38 import org.pdfbox.pdmodel.PDDocument;
39
40 /**
41  * This class represents metadata for various objects in a PDF document.
42  *
43  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
44  * @version $Revision: 1.2 $
45  */
46 public class PDMetadata extends PDStream
47 {
48     
49     /**
50      * This will create a new PDMetadata object.
51      *
52      * @param document The document that the stream will be part of.
53      */
54     public PDMetadata( PDDocument document )
55     {
56         super( document );
57         getStream().setName( "Type", "Metadata" );
58         getStream().setName( "Subtype", "XML" );
59     }
60     
61     /**
62      * Constructor. Reads all data from the input stream and embeds it into the
63      * document, this will close the InputStream.
64      *
65      * @param doc The document that will hold the stream.
66      * @param str The stream parameter.
67      * @param filtered True if the stream already has a filter applied.
68      * @throws IOException If there is an error creating the stream in the document.
69      */
70     public PDMetadata( PDDocument doc, InputStream JavaDoc str, boolean filtered ) throws IOException JavaDoc
71     {
72         super( doc, str, filtered );
73         getStream().setName( "Type", "Metadata" );
74         getStream().setName( "Subtype", "XML" );
75     }
76
77     /**
78      * Constructor.
79      *
80      * @param str The stream parameter.
81      */
82     public PDMetadata( COSStream str )
83     {
84         super( str );
85     }
86
87 }
Popular Tags