2013-09-27 00:12:22 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< HTML >
< HEAD >
2013-09-27 00:40:14 +02:00
<!-- Generated by javadoc (build 1.6.0_45) on Fri Sep 27 00:38:35 CEST 2013 -->
2013-09-27 00:12:22 +02:00
< META http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< TITLE >
ModuleGenerator (ROME, RSS and atOM utilitiEs for Java 1.1-SNAPSHOT API)
< / TITLE >
< META NAME = "date" CONTENT = "2013-09-27" >
< LINK REL = "stylesheet" TYPE = "text/css" HREF = "../../../../stylesheet.css" TITLE = "Style" >
< SCRIPT type = "text/javascript" >
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ModuleGenerator (ROME, RSS and atOM utilitiEs for Java 1.1-SNAPSHOT API)";
}
}
< / SCRIPT >
< NOSCRIPT >
< / NOSCRIPT >
< / HEAD >
< BODY BGCOLOR = "white" onload = "windowTitle();" >
< HR >
<!-- ========= START OF TOP NAVBAR ======= -->
< A NAME = "navbar_top" > <!-- --> < / A >
< A HREF = "#skip-navbar_top" title = "Skip navigation links" > < / A >
< TABLE BORDER = "0" WIDTH = "100%" CELLPADDING = "1" CELLSPACING = "0" SUMMARY = "" >
< TR >
< TD COLSPAN = 2 BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" >
< A NAME = "navbar_top_firstrow" > <!-- --> < / A >
< TABLE BORDER = "0" CELLPADDING = "0" CELLSPACING = "3" SUMMARY = "" >
< TR ALIGN = "center" VALIGN = "top" >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../overview-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Overview< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Package< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#FFFFFF" CLASS = "NavBarCell1Rev" > < FONT CLASS = "NavBarFont1Rev" > < B > Class< / B > < / FONT > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "class-use/ModuleGenerator.html" > < FONT CLASS = "NavBarFont1" > < B > Use< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-tree.html" > < FONT CLASS = "NavBarFont1" > < B > Tree< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../deprecated-list.html" > < FONT CLASS = "NavBarFont1" > < B > Deprecated< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../index-all.html" > < FONT CLASS = "NavBarFont1" > < B > Index< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../help-doc.html" > < FONT CLASS = "NavBarFont1" > < B > Help< / B > < / FONT > < / A > < / TD >
< / TR >
< / TABLE >
< / TD >
< TD ALIGN = "right" VALIGN = "top" ROWSPAN = 3 > < EM >
< / EM >
< / TD >
< / TR >
< TR >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
< A HREF = "../../../../com/sun/syndication/io/FeedException.html" title = "class in com.sun.syndication.io" > < B > PREV CLASS< / B > < / A >
< A HREF = "../../../../com/sun/syndication/io/ModuleParser.html" title = "interface in com.sun.syndication.io" > < B > NEXT CLASS< / B > < / A > < / FONT > < / TD >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
< A HREF = "../../../../index.html?com/sun/syndication/io/ModuleGenerator.html" target = "_top" > < B > FRAMES< / B > < / A >
< A HREF = "ModuleGenerator.html" target = "_top" > < B > NO FRAMES< / B > < / A >
< SCRIPT type = "text/javascript" >
<!--
if(window==top) {
document.writeln('< A HREF = "../../../../allclasses-noframe.html" > < B > All Classes< / B > < / A > ');
}
//-->
< / SCRIPT >
< NOSCRIPT >
< A HREF = "../../../../allclasses-noframe.html" > < B > All Classes< / B > < / A >
< / NOSCRIPT >
< / FONT > < / TD >
< / TR >
< TR >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
SUMMARY: NESTED | FIELD | CONSTR | < A HREF = "#method_summary" > METHOD< / A > < / FONT > < / TD >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
DETAIL: FIELD | CONSTR | < A HREF = "#method_detail" > METHOD< / A > < / FONT > < / TD >
< / TR >
< / TABLE >
< A NAME = "skip-navbar_top" > < / A >
<!-- ========= END OF TOP NAVBAR ========= -->
< HR >
<!-- ======== START OF CLASS DATA ======== -->
< H2 >
< FONT SIZE = "-1" >
com.sun.syndication.io< / FONT >
< BR >
Interface ModuleGenerator< / H2 >
< DL >
< DT > < B > All Known Subinterfaces:< / B > < DD > < A HREF = "../../../../com/sun/syndication/io/DelegatingModuleGenerator.html" title = "interface in com.sun.syndication.io" > DelegatingModuleGenerator< / A > < / DD >
< / DL >
< DL >
< DT > < B > All Known Implementing Classes:< / B > < DD > < A HREF = "../../../../com/sun/syndication/io/impl/DCModuleGenerator.html" title = "class in com.sun.syndication.io.impl" > DCModuleGenerator< / A > , < A HREF = "../../../../com/sun/syndication/io/impl/SyModuleGenerator.html" title = "class in com.sun.syndication.io.impl" > SyModuleGenerator< / A > < / DD >
< / DL >
< HR >
< DL >
< DT > < PRE > public interface < B > ModuleGenerator< / B > < / DL >
< / PRE >
< P >
Injects module metadata into a XML node (JDOM element).
< p >
ModuleGenerator instances must thread safe.
< p >
TODO: explain how developers can plugin their own implementations.
< p >
< P >
< P >
< DL >
< DT > < B > Author:< / B > < / DT >
< DD > Alejandro Abdelnur< / DD >
< / DL >
< HR >
< P >
<!-- ========== METHOD SUMMARY =========== -->
< A NAME = "method_summary" > <!-- --> < / A >
< TABLE BORDER = "1" WIDTH = "100%" CELLPADDING = "3" CELLSPACING = "0" SUMMARY = "" >
< TR BGCOLOR = "#CCCCFF" CLASS = "TableHeadingColor" >
< TH ALIGN = "left" COLSPAN = "2" > < FONT SIZE = "+2" >
< B > Method Summary< / B > < / FONT > < / TH >
< / TR >
< TR BGCOLOR = "white" CLASS = "TableRowColor" >
< TD ALIGN = "right" VALIGN = "top" WIDTH = "1%" > < FONT SIZE = "-1" >
< CODE > void< / CODE > < / FONT > < / TD >
< TD > < CODE > < B > < A HREF = "../../../../com/sun/syndication/io/ModuleGenerator.html#generate(com.sun.syndication.feed.module.Module, org.jdom.Element)" > generate< / A > < / B > (< A HREF = "../../../../com/sun/syndication/feed/module/Module.html" title = "interface in com.sun.syndication.feed.module" > Module< / A > module,
org.jdom.Element element)< / CODE >
< BR >
Generates and injects module metadata into an XML node (JDOM element).< / TD >
< / TR >
< TR BGCOLOR = "white" CLASS = "TableRowColor" >
< TD ALIGN = "right" VALIGN = "top" WIDTH = "1%" > < FONT SIZE = "-1" >
< CODE > < A HREF = "http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true" title = "class or interface in java.util" > Set< / A > < / CODE > < / FONT > < / TD >
< TD > < CODE > < B > < A HREF = "../../../../com/sun/syndication/io/ModuleGenerator.html#getNamespaces()" > getNamespaces< / A > < / B > ()< / CODE >
< BR >
Returns a set with all the URIs (JDOM Namespace elements) this module generator uses.< / TD >
< / TR >
< TR BGCOLOR = "white" CLASS = "TableRowColor" >
< TD ALIGN = "right" VALIGN = "top" WIDTH = "1%" > < FONT SIZE = "-1" >
< CODE > < A HREF = "http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title = "class or interface in java.lang" > String< / A > < / CODE > < / FONT > < / TD >
< TD > < CODE > < B > < A HREF = "../../../../com/sun/syndication/io/ModuleGenerator.html#getNamespaceUri()" > getNamespaceUri< / A > < / B > ()< / CODE >
< BR >
Returns the namespace URI this generator handles.< / TD >
< / TR >
< / TABLE >
< P >
<!-- ============ METHOD DETAIL ========== -->
< A NAME = "method_detail" > <!-- --> < / A >
< TABLE BORDER = "1" WIDTH = "100%" CELLPADDING = "3" CELLSPACING = "0" SUMMARY = "" >
< TR BGCOLOR = "#CCCCFF" CLASS = "TableHeadingColor" >
< TH ALIGN = "left" COLSPAN = "1" > < FONT SIZE = "+2" >
< B > Method Detail< / B > < / FONT > < / TH >
< / TR >
< / TABLE >
< A NAME = "getNamespaceUri()" > <!-- --> < / A > < H3 >
getNamespaceUri< / H3 >
< PRE >
< A HREF = "http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title = "class or interface in java.lang" > String< / A > < B > getNamespaceUri< / B > ()< / PRE >
< DL >
< DD > Returns the namespace URI this generator handles.
< p >
< P >
< DD > < DL >
< DT > < B > Returns:< / B > < DD > the namespace URI.< / DL >
< / DD >
< / DL >
< HR >
< A NAME = "getNamespaces()" > <!-- --> < / A > < H3 >
getNamespaces< / H3 >
< PRE >
< A HREF = "http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true" title = "class or interface in java.util" > Set< / A > < B > getNamespaces< / B > ()< / PRE >
< DL >
< DD > Returns a set with all the URIs (JDOM Namespace elements) this module generator uses.
< p / >
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).
< p / >
< P >
< DD > < DL >
< DT > < B > Returns:< / B > < DD > a set with all the URIs (JDOM Namespace elements) this module generator uses.< / DL >
< / DD >
< / DL >
< HR >
< A NAME = "generate(com.sun.syndication.feed.module.Module, org.jdom.Element)" > <!-- --> < / A > < H3 >
generate< / H3 >
< PRE >
void < B > generate< / B > (< A HREF = "../../../../com/sun/syndication/feed/module/Module.html" title = "interface in com.sun.syndication.feed.module" > Module< / A > module,
org.jdom.Element element)< / PRE >
< DL >
< DD > Generates and injects module metadata into an XML node (JDOM element).
< p >
< P >
< DD > < DL >
< DT > < B > Parameters:< / B > < DD > < CODE > module< / CODE > - the module to inject into the XML node (JDOM element).< DD > < CODE > element< / CODE > - the XML node into which module meta-data will be injected.< / DL >
< / DD >
< / DL >
<!-- ========= END OF CLASS DATA ========= -->
< HR >
<!-- ======= START OF BOTTOM NAVBAR ====== -->
< A NAME = "navbar_bottom" > <!-- --> < / A >
< A HREF = "#skip-navbar_bottom" title = "Skip navigation links" > < / A >
< TABLE BORDER = "0" WIDTH = "100%" CELLPADDING = "1" CELLSPACING = "0" SUMMARY = "" >
< TR >
< TD COLSPAN = 2 BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" >
< A NAME = "navbar_bottom_firstrow" > <!-- --> < / A >
< TABLE BORDER = "0" CELLPADDING = "0" CELLSPACING = "3" SUMMARY = "" >
< TR ALIGN = "center" VALIGN = "top" >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../overview-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Overview< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Package< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#FFFFFF" CLASS = "NavBarCell1Rev" > < FONT CLASS = "NavBarFont1Rev" > < B > Class< / B > < / FONT > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "class-use/ModuleGenerator.html" > < FONT CLASS = "NavBarFont1" > < B > Use< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-tree.html" > < FONT CLASS = "NavBarFont1" > < B > Tree< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../deprecated-list.html" > < FONT CLASS = "NavBarFont1" > < B > Deprecated< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../index-all.html" > < FONT CLASS = "NavBarFont1" > < B > Index< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../help-doc.html" > < FONT CLASS = "NavBarFont1" > < B > Help< / B > < / FONT > < / A > < / TD >
< / TR >
< / TABLE >
< / TD >
< TD ALIGN = "right" VALIGN = "top" ROWSPAN = 3 > < EM >
< / EM >
< / TD >
< / TR >
< TR >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
< A HREF = "../../../../com/sun/syndication/io/FeedException.html" title = "class in com.sun.syndication.io" > < B > PREV CLASS< / B > < / A >
< A HREF = "../../../../com/sun/syndication/io/ModuleParser.html" title = "interface in com.sun.syndication.io" > < B > NEXT CLASS< / B > < / A > < / FONT > < / TD >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
< A HREF = "../../../../index.html?com/sun/syndication/io/ModuleGenerator.html" target = "_top" > < B > FRAMES< / B > < / A >
< A HREF = "ModuleGenerator.html" target = "_top" > < B > NO FRAMES< / B > < / A >
< SCRIPT type = "text/javascript" >
<!--
if(window==top) {
document.writeln('< A HREF = "../../../../allclasses-noframe.html" > < B > All Classes< / B > < / A > ');
}
//-->
< / SCRIPT >
< NOSCRIPT >
< A HREF = "../../../../allclasses-noframe.html" > < B > All Classes< / B > < / A >
< / NOSCRIPT >
< / FONT > < / TD >
< / TR >
< TR >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
SUMMARY: NESTED | FIELD | CONSTR | < A HREF = "#method_summary" > METHOD< / A > < / FONT > < / TD >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
DETAIL: FIELD | CONSTR | < A HREF = "#method_detail" > METHOD< / A > < / FONT > < / TD >
< / TR >
< / TABLE >
< A NAME = "skip-navbar_bottom" > < / A >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< HR >
Copyright © 2004-2013 < a href = "http://www.rometools.org" > ROME Project< / a > . All Rights Reserved.
< / BODY >
< / HTML >
