KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > cos > COSBase


1 /**
2  * Copyright (c) 2003-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.cos;
32
33 import org.pdfbox.filter.FilterManager;
34 import org.pdfbox.pdmodel.common.COSObjectable;
35
36 import org.pdfbox.exceptions.COSVisitorException;
37
38 /**
39  * The base object that all objects in the PDF document will extend.
40  *
41  * @author <a HREF="ben@benlitchfield.com">Ben Litchfield</a>
42  * @version $Revision: 1.14 $
43  */
44 public abstract class COSBase implements COSObjectable
45 {
46     /**
47      * Constructor.
48      */
49     public COSBase()
50     {
51     }
52
53     /**
54      * This will get the filter manager to use to filter streams.
55      *
56      * @return The filter manager.
57      */
58     public FilterManager getFilterManager()
59     {
60         /**
61          * @todo move this to PDFdocument or something better
62          */
63         return new FilterManager();
64     }
65     
66     /**
67      * Convert this standard java object to a COS object.
68      *
69      * @return The cos object that matches this Java object.
70      */
71     public COSBase getCOSObject()
72     {
73         return this;
74     }
75
76
77
78     /**
79      * visitor pattern double dispatch method.
80      *
81      * @param visitor The object to notify when visiting this object.
82      * @return any object, depending on the visitor implementation, or null
83      * @throws COSVisitorException If an error occurs while visiting this object.
84      */
85     public abstract Object JavaDoc accept(ICOSVisitor visitor) throws COSVisitorException;
86 }
Popular Tags