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