KickJava   Java API By Example, From Geeks To Geeks.

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


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 org.pdfbox.cos.COSBase;
34 import org.pdfbox.cos.COSString;
35
36 /**
37  * A file specification that is just a string.
38  *
39  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
40  * @version $Revision: 1.2 $
41  */
42 public class PDSimpleFileSpecification extends PDFileSpecification
43 {
44     private COSString file;
45     
46     /**
47      * Constructor.
48      *
49      */
50     public PDSimpleFileSpecification()
51     {
52         file = new COSString( "" );
53     }
54
55     /**
56      * Constructor.
57      *
58      * @param fileName The file that this spec represents.
59      */
60     public PDSimpleFileSpecification( COSString fileName )
61     {
62         file = fileName;
63     }
64
65     /**
66      * This will get the file name.
67      *
68      * @return The file name.
69      */
70     public String JavaDoc getFile()
71     {
72     return file.getString();
73     }
74
75     /**
76      * This will set the file name.
77      *
78      * @param fileName The name of the file.
79      */
80     public void setFile( String JavaDoc fileName )
81     {
82     file = new COSString( fileName );
83     }
84     
85     /**
86      * Convert this standard java object to a COS object.
87      *
88      * @return The cos object that matches this Java object.
89      */
90     public COSBase getCOSObject()
91     {
92         return file;
93     }
94
95 }
96
Popular Tags