Top Description Methods
com.rometools.rome.feed.synd

public Interface Converter

Known Direct Implementers
com.rometools.rome.feed.synd.impl.ConverterForAtom03, com.rometools.rome.feed.synd.impl.ConverterForAtom10, com.rometools.rome.feed.synd.impl.ConverterForRSS090
Imports
com.rometools.rome.feed.WireFeed
Interface that defines the functionality to convert a SyndFeedImpl to a real feed (RSS or Atom) and vice versa.

Each implementation knows how to deal with a specific type (version) of a real feed.

Implementations must be thread safe.

Todo

explain how developers can plugin their own implementations.

Method Summary

Modifier and TypeMethod and Description
public void
copyInto(WireFeed
real feed to copy/convert.
feed, SyndFeed
the SyndFeedImpl that will contain the copied/converted values of the real feed.
syndFeed)

Makes a deep copy/conversion of the values of a real feed into a SyndFeedImpl.

public WireFeed

Returns:

a real feed with copied/converted values of the SyndFeedImpl.
createRealFeed(SyndFeed
SyndFeedImpl to copy/convert value from.
syndFeed)

Creates real feed with a deep copy/conversion of the values of a SyndFeedImpl.

public String

Returns:

the real feed type.
getType()

Returns the type (version) of the real feed this converter handles.

Method Detail

copyIntoback to summary
public void copyInto(WireFeed feed, SyndFeed syndFeed)

Makes a deep copy/conversion of the values of a real feed into a SyndFeedImpl.

It assumes the given SyndFeedImpl has no properties set.

Parameters
feed:WireFeed

real feed to copy/convert.

syndFeed:SyndFeed

the SyndFeedImpl that will contain the copied/converted values of the real feed.

createRealFeedback to summary
public WireFeed createRealFeed(SyndFeed syndFeed)

Creates real feed with a deep copy/conversion of the values of a SyndFeedImpl.

Parameters
syndFeed:SyndFeed

SyndFeedImpl to copy/convert value from.

Returns:WireFeed

a real feed with copied/converted values of the SyndFeedImpl.

getTypeback to summary
public String getType()

Returns the type (version) of the real feed this converter handles.

Returns:String

the real feed type.

See Also
{@link WireFeed} for details on the format of this string.