Top Description Methods
com.rometools.rome.io

public Interface ModuleGenerator

Known Direct Subinterfaces
com.rometools.rome.io.DelegatingModuleGenerator
Known Direct Implementers
com.rometools.rome.io.impl.DCModuleGenerator, com.rometools.rome.io.impl.SyModuleGenerator
Imports
java.util.Set, org.jdom2.Element, .Namespace, com.rometools.rome.feed.module.Module
Injects module metadata into a XML node (JDOM element).

ModuleGenerator instances must thread safe.

Todo

explain how developers can plugin their own implementations.

Method Summary

Modifier and TypeMethod and Description
public void
generate(Module
the module to inject into the XML node (JDOM element).
module, Element
the XML node into which module meta-data will be injected.
element)

Generates and injects module metadata into an XML node (JDOM element).

public Set<Namespace>

Returns:

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

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

public String

Returns:

the namespace URI.
getNamespaceUri()

Returns the namespace URI this generator handles.

Method Detail

generateback to summary
public void generate(Module module, Element element)

Generates and injects module metadata into an XML node (JDOM element).

Parameters
module:Module

the module to inject into the XML node (JDOM element).

element:Element

the XML node into which module meta-data will be injected.

getNamespacesback to summary
public Set<Namespace> 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:Set<Namespace>

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

getNamespaceUriback to summary
public String getNamespaceUri()

Returns the namespace URI this generator handles.

Returns:String

the namespace URI.