01: /*---------------------------------------------------------------------------*\
02: $Id: PreFeedOutputPlugIn.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: import org.clapper.curn.parser.RSSChannel;
49:
50: /**
51: * This interface defines the methods that must be supported by plug-ins
52: * that wish to be notified just before <i>curn</i> sends a parsed feed to an
53: * {@link OutputHandler}.
54: *
55: * @see PlugIn
56: * @see MetaPlugIn
57: * @see PostFeedOutputPlugIn
58: * @see PostOutputHandlerFlushPlugIn
59: * @see Curn
60: *
61: * @version <tt>$Revision: 7041 $</tt>
62: */
63: public interface PreFeedOutputPlugIn extends PlugIn {
64: /*----------------------------------------------------------------------*\
65: Public Methods
66: \*----------------------------------------------------------------------*/
67:
68: /**
69: * Called immediately before a parsed feed is passed to an output
70: * handler. This method cannot affect the feed's processing. (The time
71: * to stop the processing of a feed is in one of the other, preceding
72: * phases.) This method will be called multiple times for each feed if
73: * there are multiple output handlers.
74: *
75: * @param feedInfo the {@link FeedInfo} object for the feed that
76: * has been downloaded and parsed.
77: * @param channel the parsed channel data. The plug-in is free
78: * to edit this data; it's receiving a copy
79: * that's specific to the output handler.
80: * @param outputHandler the {@link OutputHandler} that is about to be
81: * called. This object is read-only.
82: *
83: * @throws CurnException on error
84: *
85: * @see RSSChannel
86: * @see FeedInfo
87: */
88: public void runPreFeedOutputPlugIn(FeedInfo feedInfo,
89: RSSChannel channel, OutputHandler outputHandler)
90: throws CurnException;
91: }
|