org.apache.commons.feedparser
Interface FeedParserListener

All Superinterfaces:

FeedLifecycleListener

All Known Subinterfaces:

FeedDirectoryParserListener

All Known Implementing Classes:

CaptureOutputFeedParserListener, DebugFeedParserListener, DefaultFeedDirectoryParserListener, DefaultFeedParserListener, RSS10_OutputFeedParserListener, Test

public interface FeedParserListener
extends FeedLifecycleListener

Version:

$Id: FeedParserListener.java 373614 2006-01-30 22:31:21Z mvdb $

Author:

Kevin A. Burton (burtonator)

Method Summary

void	onChannel(FeedParserState state, String title, String link, String description) Called when a channel item is found.
void	onChannelEnd()
void	onFeedVersion(FeedVersion version) Called when we are first able to determine the feed version for this feed.
void	onImage(FeedParserState state, String title, String link, String url) Called when an RSS image is found.
void	onImageEnd()
void	onItem(FeedParserState state, String title, String link, String description, String permalink) Called when an RSS item or Atom entry is found.
void	onItemEnd()

Methods inherited from interface org.apache.commons.feedparser.FeedLifecycleListener

finished, getContext, init, setContext

Method Detail

onChannel

void onChannel(FeedParserState state,
               String title,
               String link,
               String description)
               throws FeedParserException

Called when a channel item is found.

Throws:

FeedParserException

onChannelEnd

void onChannelEnd()
                  throws FeedParserException

Throws:

FeedParserException

onImage

void onImage(FeedParserState state,
             String title,
             String link,
             String url)
             throws FeedParserException

Called when an RSS image is found.

Throws:

FeedParserException

onImageEnd

void onImageEnd()
                throws FeedParserException

Throws:

FeedParserException

onItem

void onItem(FeedParserState state,
            String title,
            String link,
            String description,
            String permalink)
            throws FeedParserException

Called when an RSS item or Atom entry is found.

Throws:

FeedParserException

onItemEnd

void onItemEnd()
               throws FeedParserException

Throws:

FeedParserException

onFeedVersion

void onFeedVersion(FeedVersion version)
                   throws FeedParserException

Called when we are first able to determine the feed version for this feed. Ideally implementations should call this BEFORE onChannel but depending on the parser infrastructure this might not be possible. Should be called before init()

Throws:

FeedParserException