com.sun.syndication.io

Interface WireFeedGenerator

public interface WireFeedGenerator

Generates an XML document (JDOM) out of a feed for a specific real feed type.

WireFeedGenerator instances must thread safe.

TODO: explain how developers can plugin their own implementations.

Author: Alejandro Abdelnur

Method Summary
Documentgenerate(WireFeed feed)
Creates an XML document (JDOM) for the given feed bean.
StringgetType()
Returns the type of feed the generator creates.

Method Detail

generate

public Document generate(WireFeed feed)
Creates an XML document (JDOM) for the given feed bean.

Parameters: feed the feed bean to generate the XML document from.

Returns: the generated XML document (JDOM).

Throws: IllegalArgumentException thrown if the type of the given feed bean does not match with the type of the WireFeedGenerator. FeedException thrown if the XML Document could not be created.

getType

public String getType()
Returns the type of feed the generator creates.

Returns: the type of feed the generator creates.

See Also: for details on the format of this string.

Copyright © Sun Microsystems. All Rights Reserved.