KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > util > operator > OperatorProcessor


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.util.operator;
32
33 import org.pdfbox.util.PDFOperator;
34 import org.pdfbox.util.PDFStreamEngine;
35 import java.util.List JavaDoc;
36 import java.io.IOException JavaDoc;
37
38 /**
39  *
40  * <p>Titre : OperatorProcessor</p>
41  * <p>Description : This class is the strategy abstract class
42  * in the strategy GOF pattern. After instancated, you must ever call
43 * the setContext method to initiamise OPeratorProcessor</p>
44  * <p>Copyright : Copyright (c) 2004</p>
45  * <p>Société : DBGS</p>
46  * @author Huault : huault@free.fr
47  * @version $Revision: 1.3 $
48  */
49 public abstract class OperatorProcessor
50 {
51
52     /**
53      * The stream engine processing context.
54      */
55     protected PDFStreamEngine context = null;
56
57     /**
58      * Constructor.
59      *
60      */
61     protected OperatorProcessor()
62     {
63     }
64
65     /**
66      * Get the context for processing.
67      *
68      * @return The processing context.
69      */
70     protected PDFStreamEngine getContext()
71     {
72         return context;
73     }
74
75     /**
76      * Set the processing context.
77      *
78      * @param ctx The context for processing.
79      */
80     public void setContext(PDFStreamEngine ctx)
81     {
82         context = ctx;
83     }
84
85     /**
86      * process the operator.
87      * @param operator The operator that is being processed.
88      * @param arguments arguments needed by this operator.
89      *
90      * @throws IOException If there is an error processing the operator.
91      */
92     public abstract void process(PDFOperator operator, List JavaDoc arguments) throws IOException JavaDoc;
93 }
94
Popular Tags