com.sun.syndication.io

Interface ModuleGenerator

public interface ModuleGenerator

Injects module metadata into a XML node (JDOM element).

ModuleGenerator instances must thread safe.

TODO: explain how developers can plugin their own implementations.

Author: Alejandro Abdelnur

Method Summary
voidgenerate(Module module, Element element)
Generates and injects module metadata into an XML node (JDOM element).
SetgetNamespaces()
Returns a set with all the URIs (JDOM Namespace elements) this module generator uses.
StringgetNamespaceUri()
Returns the namespace URI this generator handles.

Method Detail

generate

public void generate(Module module, Element element)
Generates and injects module metadata into an XML node (JDOM element).

Parameters: module the module to inject into the XML node (JDOM element). element the XML node into which module meta-data will be injected.

getNamespaces

public Set getNamespaces()
Returns a set with all the URIs (JDOM Namespace elements) this module generator uses.

It is used by the the feed generators to add their namespace definition in the root element of the generated document (forward-missing of Java 5.0 Generics).

Returns: a set with all the URIs (JDOM Namespace elements) this module generator uses.

getNamespaceUri

public String getNamespaceUri()
Returns the namespace URI this generator handles.

Returns: the namespace URI.

Copyright © Sun Microsystems. All Rights Reserved.