01: /*---------------------------------------------------------------------------*\
02: $Id: PostOutputHandlerFlushPlugIn.java 7041 2007-09-09 01:04:47Z bmc $
03: ---------------------------------------------------------------------------
04: This software is released under a BSD-style license:
05:
06: Copyright (c) 2004-2007 Brian M. Clapper. All rights reserved.
07:
08: Redistribution and use in source and binary forms, with or without
09: modification, are permitted provided that the following conditions are
10: met:
11:
12: 1. Redistributions of source code must retain the above copyright notice,
13: this list of conditions and the following disclaimer.
14:
15: 2. The end-user documentation included with the redistribution, if any,
16: must include the following acknowlegement:
17:
18: "This product includes software developed by Brian M. Clapper
19: (bmc@clapper.org, http://www.clapper.org/bmc/). That software is
20: copyright (c) 2004-2007 Brian M. Clapper."
21:
22: Alternately, this acknowlegement may appear in the software itself,
23: if wherever such third-party acknowlegements normally appear.
24:
25: 3. Neither the names "clapper.org", "curn", nor any of the names of the
26: project contributors may be used to endorse or promote products
27: derived from this software without prior written permission. For
28: written permission, please contact bmc@clapper.org.
29:
30: 4. Products derived from this software may not be called "curn", nor may
31: "clapper.org" appear in their names without prior written permission
32: of Brian M. Clapper.
33:
34: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
36: MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
37: NO EVENT SHALL BRIAN M. CLAPPER BE LIABLE FOR ANY DIRECT, INDIRECT,
38: INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
39: NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
40: DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
41: THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42: (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43: THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44: \*---------------------------------------------------------------------------*/
45:
46: package org.clapper.curn;
47:
48: /**
49: * This interface defines the methods that must be supported by plug-ins
50: * that wish to be notified after <i>curn</i> sends a parsed feed to an
51: * {@link OutputHandler}.
52: *
53: * @see PlugIn
54: * @see MetaPlugIn
55: * @see PreFeedOutputPlugIn
56: * @see PostFeedOutputPlugIn
57: * @see Curn
58: *
59: * @version <tt>$Revision: 7041 $</tt>
60: */
61: public interface PostOutputHandlerFlushPlugIn extends PlugIn {
62: /*----------------------------------------------------------------------*\
63: Public Methods
64: \*----------------------------------------------------------------------*/
65:
66: /**
67: * Called immediately after an output handler is flushed (i.e., after
68: * it has been called to process all feeds and its output has been
69: * written to a temporary file), but before that output is displayed,
70: * emailed, etc.
71: *
72: * @param outputHandler the {@link OutputHandler} that is about to be
73: * called. This object is read-only.
74: *
75: * @return <tt>true</tt> if <i>curn</i> should process the output,
76: * <tt>false</tt> to skip the output from the handler.
77: *
78: * @throws CurnException on error
79: *
80: * @see OutputHandler
81: */
82: public boolean runPostOutputHandlerFlushPlugIn(
83: OutputHandler outputHandler) throws CurnException;
84: }
|