01: /**
02: * Copyright (c) 2004, www.pdfbox.org
03: * All rights reserved.
04: *
05: * Redistribution and use in source and binary forms, with or without
06: * modification, are permitted provided that the following conditions are met:
07: *
08: * 1. Redistributions of source code must retain the above copyright notice,
09: * 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: */package org.pdfbox.pdmodel.common.filespecification;
31:
32: import java.io.IOException;
33:
34: import org.pdfbox.cos.COSBase;
35: import org.pdfbox.cos.COSDictionary;
36: import org.pdfbox.cos.COSString;
37:
38: import org.pdfbox.pdmodel.common.COSObjectable;
39:
40: /**
41: * This represents a file specification.
42: *
43: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
44: * @version $Revision: 1.4 $
45: */
46: public abstract class PDFileSpecification implements COSObjectable {
47:
48: /**
49: * A file specfication can either be a COSString or a COSDictionary. This
50: * will create the file specification either way.
51: *
52: * @param base The cos object that describes the fs.
53: *
54: * @return The file specification for the COSBase object.
55: *
56: * @throws IOException If there is an error creating the file spec.
57: */
58: public static PDFileSpecification createFS(COSBase base)
59: throws IOException {
60: PDFileSpecification retval = null;
61: if (base == null) {
62: //then simply return null
63: } else if (base instanceof COSString) {
64: retval = new PDSimpleFileSpecification((COSString) base);
65: } else if (base instanceof COSDictionary) {
66: retval = new PDComplexFileSpecification(
67: (COSDictionary) base);
68: } else {
69: throw new IOException("Error: Unknown file specification "
70: + base);
71: }
72: return retval;
73: }
74:
75: /**
76: * This will get the file name.
77: *
78: * @return The file name.
79: */
80: public abstract String getFile();
81:
82: /**
83: * This will set the file name.
84: *
85: * @param file The name of the file.
86: */
87: public abstract void setFile(String file);
88: }
|