KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > common > filespecification > PDFileSpecification


1 /**
2  * Copyright (c) 2004, 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.filespecification;
32
33 import java.io.IOException JavaDoc;
34
35 import org.pdfbox.cos.COSBase;
36 import org.pdfbox.cos.COSDictionary;
37 import org.pdfbox.cos.COSString;
38
39 import org.pdfbox.pdmodel.common.COSObjectable;
40
41 /**
42  * This represents a file specification.
43  *
44  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
45  * @version $Revision: 1.4 $
46  */
47 public abstract class PDFileSpecification implements COSObjectable
48 {
49
50     /**
51      * A file specfication can either be a COSString or a COSDictionary. This
52      * will create the file specification either way.
53      *
54      * @param base The cos object that describes the fs.
55      *
56      * @return The file specification for the COSBase object.
57      *
58      * @throws IOException If there is an error creating the file spec.
59      */
60     public static PDFileSpecification createFS( COSBase base ) throws IOException JavaDoc
61     {
62         PDFileSpecification retval = null;
63         if( base == null )
64         {
65             //then simply return null
66 }
67         else if( base instanceof COSString )
68         {
69             retval = new PDSimpleFileSpecification( (COSString)base );
70         }
71         else if( base instanceof COSDictionary )
72         {
73             retval = new PDComplexFileSpecification( (COSDictionary)base );
74         }
75         else
76         {
77             throw new IOException JavaDoc( "Error: Unknown file specification " + base );
78         }
79         return retval;
80     }
81
82     /**
83      * This will get the file name.
84      *
85      * @return The file name.
86      */
87     public abstract String JavaDoc getFile();
88
89     /**
90      * This will set the file name.
91      *
92      * @param file The name of the file.
93      */
94     public abstract void setFile( String JavaDoc file );
95 }
Popular Tags