01: /*
02: * Copyright (c) 2007, intarsys consulting GmbH
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * - Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
10: * - 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: *
14: * - Neither the name of intarsys nor the names of its contributors may be used
15: * to endorse or promote products derived from this software without specific
16: * prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28: * POSSIBILITY OF SUCH DAMAGE.
29: */
30: package de.intarsys.pdf.content;
31:
32: import java.util.Map;
33: import de.intarsys.pdf.pd.PDResources;
34:
35: /**
36: * An interpreter for {@link CSContent} PDF graphics streams. Indirect
37: * references are resolved using <code>resources</code>.
38: * <code>resources</code> may be null if not needed.
39: *
40: */
41: public interface ICSInterpreter {
42: /**
43: * Process <code>content</code> using <code>resources</code> if needed.
44: * <p>
45: * This method may be called reentrant when a form XObject is encountered.
46: *
47: * @param content
48: * The PDF content stream to be interpreted.
49: *
50: * @param resources
51: * The {@link PDResources} repository for the content stream
52: */
53: public void process(CSContent content, PDResources resources);
54:
55: /**
56: * Transparent options used by the interpreter implementation. The method
57: * may return <code>null</code>.
58: *
59: * @return Transparent options used by the interpreter implementation.
60: */
61: public Map getOptions();
62:
63: /**
64: * The currently active {@link ICSExceptionHandler} for the interpreter.
65: * <p>
66: * The {@link ICSExceptionHandler} is responsible for acting on the
67: * {@link CSException} instances thrwoed while processing a
68: * {@link CSContent}.
69: *
70: * @return The currently active {@link ICSExceptionHandler} for the
71: * interpreter.
72: */
73: public ICSExceptionHandler getExceptionHandler();
74:
75: /**
76: * Assign the {@link ICSExceptionHandler} for the interpreter.
77: *
78: * @param errorHandler
79: * The new {@link ICSExceptionHandler}.
80: */
81: public void setExceptionHandler(ICSExceptionHandler errorHandler);
82: }
|