/usr/share/doc/libdoxia-sitetools-java/api/org/apache/maven/doxia/docrenderer/DocumentRenderer.html is in libdoxia-sitetools-java-doc 1.1.4-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Thu Nov 24 17:10:44 UTC 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
DocumentRenderer (Doxia Sitetools 1.1.4 API)
</TITLE>
<META NAME="date" CONTENT="2011-11-24">
<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="DocumentRenderer (Doxia Sitetools 1.1.4 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/DocumentRenderer.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="../../../../../org/apache/maven/doxia/docrenderer/DocRenderer.html" title="interface in org.apache.maven.doxia.docrenderer"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html" title="class in org.apache.maven.doxia.docrenderer"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/maven/doxia/docrenderer/DocumentRenderer.html" target="_top"><B>FRAMES</B></A>
<A HREF="DocumentRenderer.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | 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">
org.apache.maven.doxia.docrenderer</FONT>
<BR>
Interface DocumentRenderer</H2>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.html" title="interface in org.apache.maven.doxia.docrenderer.pdf">PdfRenderer</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html" title="class in org.apache.maven.doxia.docrenderer">AbstractDocumentRenderer</A>, <A HREF="../../../../../org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.html" title="class in org.apache.maven.doxia.docrenderer.pdf">AbstractPdfRenderer</A>, <A HREF="../../../../../org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.html" title="class in org.apache.maven.doxia.docrenderer.pdf.fo">FoPdfRenderer</A>, <A HREF="../../../../../org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.html" title="class in org.apache.maven.doxia.docrenderer.pdf.itext">ITextPdfRenderer</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>DocumentRenderer</B></DL>
</PRE>
<P>
Base interface for rendering documents from a set of input files.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
<DT><B>Version:</B></DT>
<DD>$Id: DocumentRenderer.java 800802 2009-08-04 14:02:47Z vsiveton $</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>, ltheussl</DD>
</DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html#ROLE">ROLE</A></B></CODE>
<BR>
Plexus lookup role.</TD>
</TR>
</TABLE>
<!-- ========== 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> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html#getOutputExtension()">getOutputExtension</A></B>()</CODE>
<BR>
Get the output extension associated with this DocumentRenderer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> org.apache.maven.doxia.document.DocumentModel</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html#readDocumentModel(java.io.File)">readDocumentModel</A></B>(java.io.File documentDescriptor)</CODE>
<BR>
Read a document model from a file.</TD>
</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="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html#render(java.util.Collection, java.io.File, org.apache.maven.doxia.document.DocumentModel)">render</A></B>(java.util.Collection files,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel)</CODE>
<BR>
Render a document from a set of files, depending on a rendering context.</TD>
</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="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html#render(java.io.File, java.io.File, org.apache.maven.doxia.document.DocumentModel)">render</A></B>(java.io.File baseDirectory,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel)</CODE>
<BR>
Render a document from the files found in a source directory, depending on a rendering context.</TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ROLE"><!-- --></A><H3>
ROLE</H3>
<PRE>
static final java.lang.String <B>ROLE</B></PRE>
<DL>
<DD>Plexus lookup role.
<P>
<DL>
</DL>
</DL>
<!-- ============ 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="render(java.util.Collection, java.io.File, org.apache.maven.doxia.document.DocumentModel)"><!-- --></A><H3>
render</H3>
<PRE>
void <B>render</B>(java.util.Collection files,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Render a document from a set of files, depending on a rendering context.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>files</CODE> - the path name Strings (relative to a common base directory)
of files to include in the document generation.<DD><CODE>outputDirectory</CODE> - the output directory where the document should be generated.<DD><CODE>documentModel</CODE> - the document model, containing all the metadata, etc.
If the model contains a TOC, only the files found in this TOC are rendered,
otherwise all files from the Collection of files will be processed.
If the model is null, render all files individually.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any.
<DD><CODE>java.io.IOException</CODE> - if any.</DL>
</DD>
</DL>
<HR>
<A NAME="render(java.io.File, java.io.File, org.apache.maven.doxia.document.DocumentModel)"><!-- --></A><H3>
render</H3>
<PRE>
void <B>render</B>(java.io.File baseDirectory,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Render a document from the files found in a source directory, depending on a rendering context.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>baseDirectory</CODE> - the directory containing the source files.
This should follow the standard Maven convention, ie containing all the site modules.<DD><CODE>outputDirectory</CODE> - the output directory where the document should be generated.<DD><CODE>documentModel</CODE> - the document model, containing all the metadata, etc.
If the model contains a TOC, only the files found in this TOC are rendered,
otherwise all files found under baseDirectory will be processed.
If the model is null, render all files from baseDirectory individually.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any
<DD><CODE>java.io.IOException</CODE> - if any
// * @deprecated since 1.1.2, use <CODE>#render(File, File, DocumentModel, DocumentRendererContext)</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="readDocumentModel(java.io.File)"><!-- --></A><H3>
readDocumentModel</H3>
<PRE>
org.apache.maven.doxia.document.DocumentModel <B>readDocumentModel</B>(java.io.File documentDescriptor)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Read a document model from a file.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>documentDescriptor</CODE> - a document descriptor file that contains the document model.
<DT><B>Returns:</B><DD>the document model, containing all the metadata, etc.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any
<DD><CODE>java.io.IOException</CODE> - if any</DL>
</DD>
</DL>
<HR>
<A NAME="getOutputExtension()"><!-- --></A><H3>
getOutputExtension</H3>
<PRE>
java.lang.String <B>getOutputExtension</B>()</PRE>
<DL>
<DD>Get the output extension associated with this DocumentRenderer.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the ouput extension.</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/DocumentRenderer.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="../../../../../org/apache/maven/doxia/docrenderer/DocRenderer.html" title="interface in org.apache.maven.doxia.docrenderer"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html" title="class in org.apache.maven.doxia.docrenderer"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/maven/doxia/docrenderer/DocumentRenderer.html" target="_top"><B>FRAMES</B></A>
<A HREF="DocumentRenderer.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2005-2011. All Rights Reserved.
</BODY>
</HTML>
|