You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by mi...@apache.org on 2021/12/10 20:55:52 UTC
svn commit: r1895793 [20/39] - in /maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST: ./ apidocs/ apidocs/org/apache/maven/doxia/docrenderer/ apidocs/org/apache/maven/doxia/docrenderer/class-use/ apidocs/org/apache/maven/do...
Modified: maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocRenderer.html
==============================================================================
--- maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocRenderer.html (original)
+++ maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocRenderer.html Fri Dec 10 20:55:46 2021
@@ -36,41 +36,42 @@
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:vincent.siveton@gmail.com" target="alexandria_uri">mailto:vincent.siveton@gmail.com</a>">Vincent Siveton</a></em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * @deprecated Since 1.1, use {@link DocumentRenderer} instead.</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocRenderer.html">DocRenderer</a>
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> {
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment">/** Plexus lookup. */</em>
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> String ROLE = DocRenderer.<strong class="jxr_keyword">class</strong>.getName();
-<a class="jxr_linenumber" name="L35" href="#L35">35</a>
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * Render all files from a site directory to an output directory</em>
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * @param siteDirectory the input directory contains files to be generated</em>
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * @param outputDirectory the output directory where files are generated</em>
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any</em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if any</em>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">void</strong> render( File siteDirectory, File outputDirectory )
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException;
-<a class="jxr_linenumber" name="L46" href="#L46">46</a>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * Render a document depending a context and a document descriptor</em>
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @param siteDirectory the input directory contains files to be generated</em>
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @param outputDirectory the output directory where file are generated</em>
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @param documentDescriptor the document descriptor</em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any</em>
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if any</em>
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">void</strong> render( File siteDirectory, File outputDirectory, File documentDescriptor )
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException;
-<a class="jxr_linenumber" name="L58" href="#L58">58</a>
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * Get the output extension supported</em>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @return the ouput extension supported</em>
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L64" href="#L64">64</a> String getOutputExtension();
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> }
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> @Deprecated
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocRenderer.html">DocRenderer</a>
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> {
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/** Plexus lookup. */</em>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> String ROLE = DocRenderer.<strong class="jxr_keyword">class</strong>.getName();
+<a class="jxr_linenumber" name="L36" href="#L36">36</a>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * Render all files from a site directory to an output directory</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * @param siteDirectory the input directory contains files to be generated</em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @param outputDirectory the output directory where files are generated</em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if any</em>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">void</strong> render( File siteDirectory, File outputDirectory )
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException;
+<a class="jxr_linenumber" name="L47" href="#L47">47</a>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * Render a document depending a context and a document descriptor</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @param siteDirectory the input directory contains files to be generated</em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @param outputDirectory the output directory where file are generated</em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @param documentDescriptor the document descriptor</em>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any</em>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if any</em>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">void</strong> render( File siteDirectory, File outputDirectory, File documentDescriptor )
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException;
+<a class="jxr_linenumber" name="L59" href="#L59">59</a>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Get the output extension supported</em>
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @return the ouput extension supported</em>
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> String getOutputExtension();
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2005–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
Modified: maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocumentRenderer.html
==============================================================================
--- maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocumentRenderer.html (original)
+++ maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocumentRenderer.html Fri Dec 10 20:55:46 2021
@@ -40,80 +40,81 @@
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * @author ltheussl</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * @since 1.1</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html">DocumentRenderer</a>
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> {
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/** Plexus lookup role. */</em>
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> String ROLE = DocumentRenderer.<strong class="jxr_keyword">class</strong>.getName();
-<a class="jxr_linenumber" name="L39" href="#L39">39</a>
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * Render a document from a set of files, depending on a rendering context.</em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @param files the path name Strings (relative to a common base directory)</em>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * of files to include in the document generation.</em>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @param outputDirectory the output directory where the document should be generated.</em>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @param documentModel the document model, containing all the metadata, etc.</em>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * If the model contains a TOC, only the files found in this TOC are rendered,</em>
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * otherwise all files from the Collection of files will be processed.</em>
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * If the model is null, render all files individually.</em>
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any.</em>
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if any.</em>
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">void</strong> render( Collection<String> files, File outputDirectory, DocumentModel documentModel )
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException;
-<a class="jxr_linenumber" name="L55" href="#L55">55</a>
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * Render a document from the files found in a source directory, depending on a rendering context.</em>
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @param baseDirectory the directory containing the source files.</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * This should follow the standard Maven convention, ie containing all the site modules.</em>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * @param outputDirectory the output directory where the document should be generated.</em>
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @param documentModel the document model, containing all the metadata, etc.</em>
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * If the model contains a TOC, only the files found in this TOC are rendered,</em>
-<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * otherwise all files found under baseDirectory will be processed.</em>
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * If the model is null, render all files from baseDirectory individually.</em>
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any</em>
-<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if any</em>
-<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">void</strong> render( File baseDirectory, File outputDirectory, DocumentModel documentModel )
-<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException;
-<a class="jxr_linenumber" name="L71" href="#L71">71</a>
-<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_comment">// /**</em>
-<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_comment">// * Render a document from the files found in a source directory, depending on a rendering context.</em>
-<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_comment">// *</em>
-<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_comment">// * @param baseDirectory the directory containing the source files.</em>
-<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_comment">// * This should follow the standard Maven convention, ie containing all the site modules.</em>
-<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_comment">// * @param outputDirectory the output directory where the document should be generated.</em>
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_comment">// * @param documentModel the document model, containing all the metadata, etc.</em>
-<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_comment">// * If the model contains a TOC, only the files found in this TOC are rendered,</em>
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_comment">// * otherwise all files found under baseDirectory will be processed.</em>
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_comment">// * If the model is null, render all files from baseDirectory individually.</em>
-<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_comment">// * @param context the rendering context when processing files.</em>
-<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_comment">// * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any</em>
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_comment">// * @throws java.io.IOException if any</em>
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_comment">// * @since 1.1.2</em>
-<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_comment">// */</em>
-<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_comment">// void render( File baseDirectory, File outputDirectory, DocumentModel documentModel,</em>
-<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">// DocumentRendererContext context )</em>
-<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_comment">// throws DocumentRendererException, IOException;</em>
-<a class="jxr_linenumber" name="L90" href="#L90">90</a>
-<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * Read a document model from a file.</em>
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param documentDescriptor a document descriptor file that contains the document model.</em>
-<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @return the document model, containing all the metadata, etc.</em>
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any</em>
-<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if any</em>
-<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> DocumentModel readDocumentModel( File documentDescriptor )
-<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException;
-<a class="jxr_linenumber" name="L101" href="#L101">101</a>
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * Get the output extension associated with this DocumentRenderer.</em>
-<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @return the ouput extension.</em>
-<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L107" href="#L107">107</a> String getOutputExtension();
-<a class="jxr_linenumber" name="L108" href="#L108">108</a> }
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> @Deprecated
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html">DocumentRenderer</a>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> {
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/** Plexus lookup role. */</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> String ROLE = DocumentRenderer.<strong class="jxr_keyword">class</strong>.getName();
+<a class="jxr_linenumber" name="L40" href="#L40">40</a>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Render a document from a set of files, depending on a rendering context.</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @param files the path name Strings (relative to a common base directory)</em>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * of files to include in the document generation.</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @param outputDirectory the output directory where the document should be generated.</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @param documentModel the document model, containing all the metadata, etc.</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * If the model contains a TOC, only the files found in this TOC are rendered,</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * otherwise all files from the Collection of files will be processed.</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * If the model is null, render all files individually.</em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any.</em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if any.</em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">void</strong> render( Collection<String> files, File outputDirectory, DocumentModel documentModel )
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException;
+<a class="jxr_linenumber" name="L56" href="#L56">56</a>
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Render a document from the files found in a source directory, depending on a rendering context.</em>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @param baseDirectory the directory containing the source files.</em>
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * This should follow the standard Maven convention, ie containing all the site modules.</em>
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @param outputDirectory the output directory where the document should be generated.</em>
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @param documentModel the document model, containing all the metadata, etc.</em>
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * If the model contains a TOC, only the files found in this TOC are rendered,</em>
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * otherwise all files found under baseDirectory will be processed.</em>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * If the model is null, render all files from baseDirectory individually.</em>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any</em>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if any</em>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">void</strong> render( File baseDirectory, File outputDirectory, DocumentModel documentModel )
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException;
+<a class="jxr_linenumber" name="L72" href="#L72">72</a>
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_comment">// /**</em>
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_comment">// * Render a document from the files found in a source directory, depending on a rendering context.</em>
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_comment">// *</em>
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_comment">// * @param baseDirectory the directory containing the source files.</em>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_comment">// * This should follow the standard Maven convention, ie containing all the site modules.</em>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_comment">// * @param outputDirectory the output directory where the document should be generated.</em>
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_comment">// * @param documentModel the document model, containing all the metadata, etc.</em>
+<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_comment">// * If the model contains a TOC, only the files found in this TOC are rendered,</em>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_comment">// * otherwise all files found under baseDirectory will be processed.</em>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_comment">// * If the model is null, render all files from baseDirectory individually.</em>
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_comment">// * @param context the rendering context when processing files.</em>
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_comment">// * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any</em>
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_comment">// * @throws java.io.IOException if any</em>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_comment">// * @since 1.1.2</em>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_comment">// */</em>
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">// void render( File baseDirectory, File outputDirectory, DocumentModel documentModel,</em>
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_comment">// DocumentRendererContext context )</em>
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_comment">// throws DocumentRendererException, IOException;</em>
+<a class="jxr_linenumber" name="L91" href="#L91">91</a>
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * Read a document model from a file.</em>
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @param documentDescriptor a document descriptor file that contains the document model.</em>
+<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @return the document model, containing all the metadata, etc.</em>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any</em>
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if any</em>
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> DocumentModel readDocumentModel( File documentDescriptor )
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException;
+<a class="jxr_linenumber" name="L102" href="#L102">102</a>
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * Get the output extension associated with this DocumentRenderer.</em>
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @return the ouput extension.</em>
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> String getOutputExtension();
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2005–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
Modified: maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocumentRendererContext.html
==============================================================================
--- maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocumentRendererContext.html (original)
+++ maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocumentRendererContext.html Fri Dec 10 20:55:46 2021
@@ -38,114 +38,115 @@
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:vincent.siveton@gmail.com" target="alexandria_uri">mailto:vincent.siveton@gmail.com</a>">Vincent Siveton</a></em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * @since 1.1.2</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html">DocumentRendererContext</a>
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> {
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">private</strong> String inputEncoding = ReaderFactory.UTF_8;
-<a class="jxr_linenumber" name="L36" href="#L36">36</a>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * Storage for key/value pairs.</em>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map<String, Object> context;
-<a class="jxr_linenumber" name="L41" href="#L41">41</a>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * Default constructor.</em>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html">DocumentRendererContext</a>()
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> {
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> context = <strong class="jxr_keyword">new</strong> HashMap<String, Object>();
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> }
-<a class="jxr_linenumber" name="L49" href="#L49">49</a>
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @return The input encoding when processing files.</em>
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">public</strong> String getInputEncoding()
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> {
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">return</strong> inputEncoding;
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> }
-<a class="jxr_linenumber" name="L57" href="#L57">57</a>
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @param inputEncoding new input encoding value when processing files.</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setInputEncoding( String inputEncoding )
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> {
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">this</strong>.inputEncoding = inputEncoding;
-<a class="jxr_linenumber" name="L64" href="#L64">64</a> }
-<a class="jxr_linenumber" name="L65" href="#L65">65</a>
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * Adds a name/value pair to the context.</em>
-<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @param key The name to key the provided value with.</em>
-<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * @param value The corresponding value.</em>
-<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @return Object that was replaced in the the Context if applicable or null if not.</em>
-<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">public</strong> Object put( String key, Object value )
-<a class="jxr_linenumber" name="L74" href="#L74">74</a> {
-<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">if</strong> ( key == <strong class="jxr_keyword">null</strong> )
-<a class="jxr_linenumber" name="L76" href="#L76">76</a> {
-<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> }
-<a class="jxr_linenumber" name="L79" href="#L79">79</a>
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">return</strong> context.put( key, value );
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
-<a class="jxr_linenumber" name="L82" href="#L82">82</a>
-<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * Gets the value corresponding to the provided key from the context.</em>
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * @param key The name of the desired value.</em>
-<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * @return The value corresponding to the provided key or null if the key param is null.</em>
-<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">public</strong> Object get( String key )
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> {
-<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">if</strong> ( key == <strong class="jxr_keyword">null</strong> )
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> {
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
-<a class="jxr_linenumber" name="L95" href="#L95">95</a>
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">return</strong> context.get( key );
-<a class="jxr_linenumber" name="L97" href="#L97">97</a> }
-<a class="jxr_linenumber" name="L98" href="#L98">98</a>
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * Indicates whether the specified key is in the context.</em>
-<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @param key The key to look for.</em>
-<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @return true if the key is in the context, false if not.</em>
-<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> containsKey( Object key )
-<a class="jxr_linenumber" name="L106" href="#L106">106</a> {
-<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">if</strong> ( !( key instanceof String ) ) <em class="jxr_comment">// this includes null check</em>
-<a class="jxr_linenumber" name="L108" href="#L108">108</a> {
-<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">return</strong> false;
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> }
-<a class="jxr_linenumber" name="L111" href="#L111">111</a>
-<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">return</strong> context.containsKey( key.toString() );
-<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
-<a class="jxr_linenumber" name="L114" href="#L114">114</a>
-<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * Get all the keys for the values in the context</em>
-<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * @return Object[] of keys in the Context.</em>
-<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">public</strong> Object[] getKeys()
-<a class="jxr_linenumber" name="L121" href="#L121">121</a> {
-<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">return</strong> context.keySet().toArray();
-<a class="jxr_linenumber" name="L123" href="#L123">123</a> }
-<a class="jxr_linenumber" name="L124" href="#L124">124</a>
-<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * Removes the value associated with the specified key from the context.</em>
-<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @param key The name of the value to remove.</em>
-<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @return The value that the key was mapped to, or <code>null</code> if unmapped.</em>
-<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">public</strong> Object remove( Object key )
-<a class="jxr_linenumber" name="L132" href="#L132">132</a> {
-<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">if</strong> ( !( key instanceof String ) ) <em class="jxr_comment">// this includes null check</em>
-<a class="jxr_linenumber" name="L134" href="#L134">134</a> {
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L136" href="#L136">136</a> }
-<a class="jxr_linenumber" name="L137" href="#L137">137</a>
-<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">return</strong> context.remove( key.toString() );
-<a class="jxr_linenumber" name="L139" href="#L139">139</a> }
-<a class="jxr_linenumber" name="L140" href="#L140">140</a> }
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> @Deprecated
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html">DocumentRendererContext</a>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> {
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">private</strong> String inputEncoding = ReaderFactory.UTF_8;
+<a class="jxr_linenumber" name="L37" href="#L37">37</a>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * Storage for key/value pairs.</em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map<String, Object> context;
+<a class="jxr_linenumber" name="L42" href="#L42">42</a>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Default constructor.</em>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html">DocumentRendererContext</a>()
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> {
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> context = <strong class="jxr_keyword">new</strong> HashMap<String, Object>();
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> }
+<a class="jxr_linenumber" name="L50" href="#L50">50</a>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @return The input encoding when processing files.</em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">public</strong> String getInputEncoding()
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> {
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">return</strong> inputEncoding;
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> }
+<a class="jxr_linenumber" name="L58" href="#L58">58</a>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @param inputEncoding new input encoding value when processing files.</em>
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setInputEncoding( String inputEncoding )
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> {
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">this</strong>.inputEncoding = inputEncoding;
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> }
+<a class="jxr_linenumber" name="L66" href="#L66">66</a>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * Adds a name/value pair to the context.</em>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * @param key The name to key the provided value with.</em>
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @param value The corresponding value.</em>
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * @return Object that was replaced in the the Context if applicable or null if not.</em>
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">public</strong> Object put( String key, Object value )
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> {
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">if</strong> ( key == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> {
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
+<a class="jxr_linenumber" name="L80" href="#L80">80</a>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">return</strong> context.put( key, value );
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> }
+<a class="jxr_linenumber" name="L83" href="#L83">83</a>
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * Gets the value corresponding to the provided key from the context.</em>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * @param key The name of the desired value.</em>
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * @return The value corresponding to the provided key or null if the key param is null.</em>
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">public</strong> Object get( String key )
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> {
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">if</strong> ( key == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> {
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L95" href="#L95">95</a> }
+<a class="jxr_linenumber" name="L96" href="#L96">96</a>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">return</strong> context.get( key );
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> }
+<a class="jxr_linenumber" name="L99" href="#L99">99</a>
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * Indicates whether the specified key is in the context.</em>
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @param key The key to look for.</em>
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @return true if the key is in the context, false if not.</em>
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> containsKey( Object key )
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> {
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">if</strong> ( !( key instanceof String ) ) <em class="jxr_comment">// this includes null check</em>
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> {
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
+<a class="jxr_linenumber" name="L112" href="#L112">112</a>
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> context.containsKey( key.toString() );
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
+<a class="jxr_linenumber" name="L115" href="#L115">115</a>
+<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * Get all the keys for the values in the context</em>
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * @return Object[] of keys in the Context.</em>
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">public</strong> Object[] getKeys()
+<a class="jxr_linenumber" name="L122" href="#L122">122</a> {
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">return</strong> context.keySet().toArray();
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
+<a class="jxr_linenumber" name="L125" href="#L125">125</a>
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * Removes the value associated with the specified key from the context.</em>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @param key The name of the value to remove.</em>
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * @return The value that the key was mapped to, or <code>null</code> if unmapped.</em>
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">public</strong> Object remove( Object key )
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> {
+<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">if</strong> ( !( key instanceof String ) ) <em class="jxr_comment">// this includes null check</em>
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> {
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> }
+<a class="jxr_linenumber" name="L138" href="#L138">138</a>
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">return</strong> context.remove( key.toString() );
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> }
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2005–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
Modified: maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocumentRendererException.html
==============================================================================
--- maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocumentRendererException.html (original)
+++ maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/DocumentRendererException.html Fri Dec 10 20:55:46 2021
@@ -33,33 +33,34 @@
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:vincent.siveton@gmail.com" target="alexandria_uri">mailto:vincent.siveton@gmail.com</a>">Vincent Siveton</a></em>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * @since 1.1</em>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html">DocumentRendererException</a>
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">extends</strong> Exception
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> {
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment">/** serialVersionUID */</em>
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 295967936746221567L;
-<a class="jxr_linenumber" name="L33" href="#L33">33</a>
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Default constructor.</em>
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @param message An error message.</em>
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html">DocumentRendererException</a>( String message )
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> {
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">super</strong>( message );
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> }
-<a class="jxr_linenumber" name="L43" href="#L43">43</a>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * Other constructor.</em>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @param message An error message.</em>
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @param t The cause.</em>
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html">DocumentRendererException</a>( String message, Throwable t )
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> {
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">super</strong>( message, t );
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> }
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> }
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> @Deprecated
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html">DocumentRendererException</a>
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">extends</strong> Exception
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> {
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/** serialVersionUID */</em>
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 295967936746221567L;
+<a class="jxr_linenumber" name="L34" href="#L34">34</a>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * Default constructor.</em>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * @param message An error message.</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html">DocumentRendererException</a>( String message )
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> {
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">super</strong>( message );
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> }
+<a class="jxr_linenumber" name="L44" href="#L44">44</a>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Other constructor.</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @param message An error message.</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @param t The cause.</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html">DocumentRendererException</a>( String message, Throwable t )
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> {
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">super</strong>( message, t );
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> }
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2005–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
Modified: maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/itext/package-frame.html
==============================================================================
--- maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/itext/package-frame.html (original)
+++ maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/itext/package-frame.html Fri Dec 10 20:55:46 2021
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Doxia Sitetools :: Document Renderer 1.10 Reference Package org.apache.maven.doxia.docrenderer.itext</title>
+ <title>Doxia Sitetools :: Document Renderer 1.11 Reference Package org.apache.maven.doxia.docrenderer.itext</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/itext/package-summary.html
==============================================================================
--- maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/itext/package-summary.html (original)
+++ maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/itext/package-summary.html Fri Dec 10 20:55:46 2021
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Doxia Sitetools :: Document Renderer 1.10 Reference Package org.apache.maven.doxia.docrenderer.itext</title>
+ <title>Doxia Sitetools :: Document Renderer 1.11 Reference Package org.apache.maven.doxia.docrenderer.itext</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/package-frame.html
==============================================================================
--- maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/package-frame.html (original)
+++ maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/package-frame.html Fri Dec 10 20:55:46 2021
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Doxia Sitetools :: Document Renderer 1.10 Reference Package org.apache.maven.doxia.docrenderer</title>
+ <title>Doxia Sitetools :: Document Renderer 1.11 Reference Package org.apache.maven.doxia.docrenderer</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/package-summary.html
==============================================================================
--- maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/package-summary.html (original)
+++ maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/package-summary.html Fri Dec 10 20:55:46 2021
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Doxia Sitetools :: Document Renderer 1.10 Reference Package org.apache.maven.doxia.docrenderer</title>
+ <title>Doxia Sitetools :: Document Renderer 1.11 Reference Package org.apache.maven.doxia.docrenderer</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.html
==============================================================================
--- maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.html (original)
+++ maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.html Fri Dec 10 20:55:46 2021
@@ -42,23 +42,24 @@
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * @author ltheussl</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @since 1.1</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.html">AbstractPdfRenderer</a>
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html">AbstractDocumentRenderer</a>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.html">PdfRenderer</a>
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> {
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">public</strong> String getOutputExtension()
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> {
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"pdf"</span>;
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> }
-<a class="jxr_linenumber" name="L46" href="#L46">46</a>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em>
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> render( Map<String, ParserModule> filesToProcess, File outputDirectory, DocumentModel documentModel )
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> {
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> render( filesToProcess, outputDirectory, documentModel, <strong class="jxr_keyword">null</strong> );
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> }
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> }
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> @Deprecated
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.html">AbstractPdfRenderer</a>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html">AbstractDocumentRenderer</a>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.html">PdfRenderer</a>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> {
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">public</strong> String getOutputExtension()
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> {
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"pdf"</span>;
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> }
+<a class="jxr_linenumber" name="L47" href="#L47">47</a>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> render( Map<String, ParserModule> filesToProcess, File outputDirectory, DocumentModel documentModel )
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException, IOException
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> {
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> render( filesToProcess, outputDirectory, documentModel, <strong class="jxr_keyword">null</strong> );
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> }
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2005–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
Modified: maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.html
==============================================================================
--- maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.html (original)
+++ maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-doc-renderer/xref/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.html Fri Dec 10 20:55:46 2021
@@ -38,22 +38,23 @@
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * @author ltheussl</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * @since 1.1</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.html">PdfRenderer</a>
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html">DocumentRenderer</a>
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> {
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment">/** Plexus lookup role. */</em>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> String ROLE = PdfRenderer.<strong class="jxr_keyword">class</strong>.getName();
-<a class="jxr_linenumber" name="L38" href="#L38">38</a>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * Generate a final pdf ouput file from an intermediate format file.</em>
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @param inputFile eg a fo or an itext file.</em>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @param pdfFile the pdf file to generate.</em>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any.</em>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">void</strong> generatePdf( File inputFile, File pdfFile )
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException;
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> }
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> @Deprecated
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.html">PdfRenderer</a>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html">DocumentRenderer</a>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> {
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/** Plexus lookup role. */</em>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> String ROLE = PdfRenderer.<strong class="jxr_keyword">class</strong>.getName();
+<a class="jxr_linenumber" name="L39" href="#L39">39</a>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * Generate a final pdf ouput file from an intermediate format file.</em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @param inputFile eg a fo or an itext file.</em>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @param pdfFile the pdf file to generate.</em>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any.</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">void</strong> generatePdf( File inputFile, File pdfFile )
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">throws</strong> DocumentRendererException;
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2005–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>