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
 void generate(Module module, org.jdom.Element element)
          Generates and injectts module metadata in a XML node (JDOM element).
 java.util.Set getNamespaces()
          Returns a set with all the URIs (JDOM Namespace elements) this module generator uses.
 java.lang.String getNamespaceUri()
          Returns the namespace URI this generator handles.
 

Method Detail

getNamespaceUri

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

Returns:
the namespace URI.

getNamespaces

public java.util.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.

generate

public void generate(Module module,
                     org.jdom.Element element)
Generates and injectts module metadata in a XML node (JDOM element).

Parameters:
module - the module to inject into the XML node (JDOM element).
element - the XML node to inject the module metadata to.


Copyright © 2004-2005 Sun Microsystems. All Rights Reserved.