com.sun.syndication.feed.synd
Interface Converter

All Known Implementing Classes:
ConverterForAtom03, ConverterForRSS090

public interface Converter

Interface that defines the functionality to convert a SyndFeed 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.

Author:
Alejandro Abdelnur

Method Summary
 void copyInto(AbstractFeed feed, SyndFeedI syndFeed)
          Makes a deep copy/conversion of the values of a real feed into a SyndFeed.
 AbstractFeed createRealFeed(SyndFeedI syndFeed)
          Creates real feed with a deep copy/conversion of the values of a SyndFeed.
 java.lang.String getType()
          Returns the type (version) of the real feed this converter handles.
 

Method Detail

getType

public java.lang.String getType()
Returns the type (version) of the real feed this converter handles.

Returns:
the real feed type.
See Also:
for details on the format of this string.


copyInto

public void copyInto(AbstractFeed feed,
                     SyndFeedI syndFeed)
Makes a deep copy/conversion of the values of a real feed into a SyndFeed.

It assumes the given SyndFeed has no properties set.

Parameters:
feed - real feed to copy/convert.
syndFeed - the SyndFeed that will contain the copied/converted values of the real feed.

createRealFeed

public AbstractFeed createRealFeed(SyndFeedI syndFeed)
Creates real feed with a deep copy/conversion of the values of a SyndFeed.

Parameters:
syndFeed - SyndFeed to copy/convert value from.
Returns:
a real feed with copied/converted values of the SyndFeed.


Copyright © 2004 Sun Microsystems. All Rights Reserved.