You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2015/12/19 11:30:30 UTC
svn commit: r1720892 - in
/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src:
main/java/org/apache/maven/doxia/siterenderer/
test/java/org/apache/maven/doxia/siterenderer/
Author: hboutemy
Date: Sat Dec 19 10:30:30 2015
New Revision: 1720892
URL: http://svn.apache.org/viewvc?rev=1720892&view=rev
Log:
[DOXIASITETOOLS-127] renamed Renderer (with RendererException) interface to SiteRenderer
Added:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaModuleReference.java
- copied, changed from r1720858, maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java
- copied, changed from r1720858, maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRendererException.java
- copied, changed from r1720858, maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RendererException.java
Removed:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RendererException.java
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java?rev=1720892&r1=1720891&r2=1720892&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java Sat Dec 19 10:30:30 2015
@@ -92,10 +92,10 @@ import org.codehaus.plexus.velocity.Velo
* @version $Id$
* @since 1.0
*/
-@Component( role = Renderer.class )
+@Component( role = SiteRenderer.class )
public class DefaultSiteRenderer
extends AbstractLogEnabled
- implements Renderer
+ implements SiteRenderer
{
// ----------------------------------------------------------------------
// Requirements
@@ -126,150 +126,136 @@ public class DefaultSiteRenderer
/** {@inheritDoc} */
public Map<String, DocumentRenderer> locateDocumentFiles( SiteRenderingContext siteRenderingContext )
- throws IOException, RendererException
+ throws IOException, SiteRendererException
{
Map<String, DocumentRenderer> files = new LinkedHashMap<String, DocumentRenderer>();
Map<String, String> moduleExcludes = siteRenderingContext.getModuleExcludes();
+ // look in every site directory (in general src/site or target/generated-site)
for ( File siteDirectory : siteRenderingContext.getSiteDirectories() )
{
if ( siteDirectory.exists() )
{
Collection<ParserModule> modules = parserModuleManager.getParserModules();
+ // use every Doxia parser module
for ( ParserModule module : modules )
{
File moduleBasedir = new File( siteDirectory, module.getSourceDirectory() );
- if ( moduleExcludes != null && moduleExcludes.containsKey( module.getParserId() ) )
- {
- addModuleFiles( moduleBasedir, module, moduleExcludes.get( module.getParserId() ),
- files );
- }
- else
- {
- addModuleFiles( moduleBasedir, module, null, files );
- }
+ String excludes = ( moduleExcludes == null ) ? null : moduleExcludes.get( module.getParserId() );
+
+ addDoxiaModuleFiles( moduleBasedir, module, excludes, files );
}
}
}
- for ( ModuleReference module : siteRenderingContext.getModules() )
+ // look in specific modules directories (used for old Maven 1.x site layout: xdoc and fml
+ for ( DoxiaModuleReference module : siteRenderingContext.getModules() )
{
try
{
- if ( moduleExcludes != null && moduleExcludes.containsKey( module.getParserId() ) )
- {
- addModuleFiles( module.getBasedir(), parserModuleManager.getParserModule( module.getParserId() ),
- moduleExcludes.get( module.getParserId() ), files );
- }
- else
- {
- addModuleFiles( module.getBasedir(), parserModuleManager.getParserModule( module.getParserId() ),
- null, files );
- }
+ ParserModule parserModule = parserModuleManager.getParserModule( module.getParserId() );
+
+ String excludes = ( moduleExcludes == null ) ? null : moduleExcludes.get( module.getParserId() );
+
+ addDoxiaModuleFiles( module.getBasedir(), parserModule, excludes, files );
}
catch ( ParserModuleNotFoundException e )
{
- throw new RendererException( "Unable to find module: " + e.getMessage(), e );
+ throw new SiteRendererException( "Unable to find module: " + e.getMessage(), e );
}
}
return files;
}
- private void addModuleFiles( File moduleBasedir, ParserModule module, String excludes,
- Map<String, DocumentRenderer> files )
- throws IOException, RendererException
+ private List<String> filterExtensionIgnoreCase( List<String> fileNames, String extension )
{
- if ( moduleBasedir.exists() )
+ List<String> filtered = new LinkedList<String>( fileNames );
+ for ( Iterator<String> it = filtered.iterator(); it.hasNext(); )
{
- List<String> allFiles = FileUtils.getFileNames( moduleBasedir, "**/*.*", excludes, false );
- if ( !ArrayUtils.isEmpty( module.getExtensions() ) )
+ String name = it.next();
+
+ // Take care of extension case
+ if ( !endsWithIgnoreCase( name, extension ) )
{
- for ( String extension : module.getExtensions() )
- {
+ it.remove();
+ }
+ }
+ return filtered;
+ }
- String fullExtension = "." + extension;
- List<String> docs = new LinkedList<String>( allFiles );
- // Take care of extension case
- for ( Iterator<String> it = docs.iterator(); it.hasNext(); )
- {
- String name = it.next();
+ private void addDoxiaModuleFiles( File moduleBasedir, ParserModule module, String excludes,
+ Map<String, DocumentRenderer> files )
+ throws IOException, SiteRendererException
+ {
+ if ( !moduleBasedir.exists() || ArrayUtils.isEmpty( module.getExtensions() ) )
+ {
+ return;
+ }
- if ( !endsWithIgnoreCase( name, fullExtension ) )
- {
- it.remove();
- }
- }
+ List<String> allFiles = FileUtils.getFileNames( moduleBasedir, "**/*.*", excludes, false );
- List<String> velocityFiles = new LinkedList<String>( allFiles );
- // *.xml.vm
- fullExtension += ".vm";
- for ( Iterator<String> it = velocityFiles.iterator(); it.hasNext(); )
- {
- String name = it.next();
+ for ( String extension : module.getExtensions() )
+ {
+ String fullExtension = "." + extension;
- if ( !endsWithIgnoreCase( name, fullExtension ) )
- {
- it.remove();
- }
- }
- docs.addAll( velocityFiles );
+ List<String> docs = filterExtensionIgnoreCase( allFiles, fullExtension );
- for ( String doc : docs )
- {
- RenderingContext context =
- new RenderingContext( moduleBasedir, doc, module.getParserId(), extension );
+ // *.<extension>.vm
+ List<String> velocityFiles = filterExtensionIgnoreCase( allFiles, fullExtension + ".vm" );
- // TODO: DOXIA-111: we need a general filter here that knows how to alter the context
- if ( doc.substring( doc.length() - 3 ).equalsIgnoreCase( ".vm" ) )
- {
- context.setAttribute( "velocity", "true" );
- }
+ docs.addAll( velocityFiles );
- String key = context.getOutputName();
- key = StringUtils.replace( key, "\\", "/" );
+ for ( String doc : docs )
+ {
+ RenderingContext context = new RenderingContext( moduleBasedir, doc, module.getParserId(), extension );
- if ( files.containsKey( key ) )
- {
- DocumentRenderer renderer = files.get( key );
+ // TODO: DOXIA-111: we need a general filter here that knows how to alter the context
+ if ( endsWithIgnoreCase( doc, ".vm" ) )
+ {
+ context.setAttribute( "velocity", "true" );
+ }
- RenderingContext originalContext = renderer.getRenderingContext();
+ String key = context.getOutputName();
+ key = StringUtils.replace( key, "\\", "/" );
- File originalDoc = new File( originalContext.getBasedir(), originalContext.getInputName() );
+ if ( files.containsKey( key ) )
+ {
+ DocumentRenderer renderer = files.get( key );
- throw new RendererException( "File '" + module.getSourceDirectory() + File.separator + doc
- + "' clashes with existing '" + originalDoc + "'." );
- }
- // -----------------------------------------------------------------------
- // Handle key without case differences
- // -----------------------------------------------------------------------
- for ( Map.Entry<String, DocumentRenderer> entry : files.entrySet() )
+ RenderingContext originalContext = renderer.getRenderingContext();
+
+ File originalDoc = new File( originalContext.getBasedir(), originalContext.getInputName() );
+
+ throw new SiteRendererException( "File '" + module.getSourceDirectory() + File.separator + doc
+ + "' clashes with existing '" + originalDoc + "'." );
+ }
+ // -----------------------------------------------------------------------
+ // Handle key without case differences
+ // -----------------------------------------------------------------------
+ for ( Map.Entry<String, DocumentRenderer> entry : files.entrySet() )
+ {
+ if ( entry.getKey().equalsIgnoreCase( key ) )
+ {
+ RenderingContext originalContext = entry.getValue().getRenderingContext();
+
+ File originalDoc = new File( originalContext.getBasedir(), originalContext.getInputName() );
+
+ if ( Os.isFamily( Os.FAMILY_WINDOWS ) )
{
- if ( entry.getKey().equalsIgnoreCase( key ) )
- {
- RenderingContext originalContext = entry.getValue().getRenderingContext();
-
- File originalDoc = new File( originalContext.getBasedir(),
- originalContext.getInputName() );
-
- if ( Os.isFamily( Os.FAMILY_WINDOWS ) )
- {
- throw new RendererException( "File '" + module.getSourceDirectory() + File.separator
- + doc + "' clashes with existing '" + originalDoc + "'." );
- }
-
- if ( getLogger().isWarnEnabled() )
- {
- getLogger().warn(
- "File '" + module.getSourceDirectory() + File.separator + doc
- + "' could clash with existing '" + originalDoc + "'." );
- }
- }
+ throw new SiteRendererException( "File '" + module.getSourceDirectory() + File.separator
+ + doc + "' clashes with existing '" + originalDoc + "'." );
}
- files.put( key, new DoxiaDocumentRenderer( context ) );
+ if ( getLogger().isWarnEnabled() )
+ {
+ getLogger().warn( "File '" + module.getSourceDirectory() + File.separator + doc
+ + "' could clash with existing '" + originalDoc + "'." );
+ }
}
}
+
+ files.put( key, new DoxiaDocumentRenderer( context ) );
}
}
}
@@ -277,7 +263,7 @@ public class DefaultSiteRenderer
/** {@inheritDoc} */
public void render( Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext,
File outputDirectory )
- throws RendererException, IOException
+ throws SiteRendererException, IOException
{
for ( DocumentRenderer docRenderer : documents )
{
@@ -328,7 +314,7 @@ public class DefaultSiteRenderer
/** {@inheritDoc} */
public void renderDocument( Writer writer, RenderingContext renderingContext, SiteRenderingContext siteContext )
- throws RendererException, FileNotFoundException, UnsupportedEncodingException
+ throws SiteRendererException, FileNotFoundException, UnsupportedEncodingException
{
SiteRendererSink sink = new SiteRendererSink( renderingContext );
@@ -394,22 +380,22 @@ public class DefaultSiteRenderer
if ( reader == null ) // can happen if velocity throws above
{
- throw new RendererException( "Error getting a parser for '" + doc + "'" );
+ throw new SiteRendererException( "Error getting a parser for '" + doc + "'" );
}
doxia.parse( reader, renderingContext.getParserId(), sink );
}
catch ( ParserNotFoundException e )
{
- throw new RendererException( "Error getting a parser for '" + doc + "': " + e.getMessage(), e );
+ throw new SiteRendererException( "Error getting a parser for '" + doc + "': " + e.getMessage(), e );
}
catch ( ParseException e )
{
- throw new RendererException( "Error parsing '"
+ throw new SiteRendererException( "Error parsing '"
+ doc + "': line [" + e.getLineNumber() + "] " + e.getMessage(), e );
}
catch ( IOException e )
{
- throw new RendererException( "IOException when processing '" + doc + "'", e );
+ throw new SiteRendererException( "IOException when processing '" + doc + "'", e );
}
finally
{
@@ -564,7 +550,7 @@ public class DefaultSiteRenderer
/** {@inheritDoc} */
public void generateDocument( Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext )
- throws RendererException
+ throws SiteRendererException
{
Context context = createVelocityContext( sink, siteRenderingContext );
@@ -572,7 +558,7 @@ public class DefaultSiteRenderer
}
private void writeTemplate( Writer writer, Context context, SiteRenderingContext siteContext )
- throws RendererException
+ throws SiteRendererException
{
ClassLoader old = null;
@@ -606,7 +592,7 @@ public class DefaultSiteRenderer
* @noinspection OverlyBroadCatchBlock,UnusedCatchParameter
*/
private void processTemplate( String templateName, Context context, Writer writer )
- throws RendererException
+ throws SiteRendererException
{
Template template;
@@ -616,7 +602,7 @@ public class DefaultSiteRenderer
}
catch ( Exception e )
{
- throw new RendererException( "Could not find the template '" + templateName, e );
+ throw new SiteRendererException( "Could not find the template '" + templateName, e );
}
try
@@ -625,12 +611,12 @@ public class DefaultSiteRenderer
}
catch ( Exception e )
{
- throw new RendererException( "Error while generating code.", e );
+ throw new SiteRendererException( "Error while generating code.", e );
}
}
/** {@inheritDoc} */
- public SiteRenderingContext createContextForSkin( File skinFile, Map<String, ?> attributes,
+ public SiteRenderingContext createSiteContextForSkin( File skinFile, Map<String, ?> attributes,
DecorationModel decoration, String defaultWindowTitle,
Locale locale )
throws IOException
@@ -689,10 +675,10 @@ public class DefaultSiteRenderer
}
/** {@inheritDoc} */
- public SiteRenderingContext createContextForTemplate( File templateFile, File skinFile, Map<String, ?> attributes,
- DecorationModel decoration, String defaultWindowTitle,
- Locale locale )
- throws MalformedURLException
+ public SiteRenderingContext createSiteContextForTemplate( File templateFile, File skinFile,
+ Map<String, ?> attributes, DecorationModel decoration,
+ String defaultWindowTitle, Locale locale )
+ throws MalformedURLException
{
SiteRenderingContext context = new SiteRenderingContext();
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java?rev=1720892&r1=1720891&r2=1720892&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java Sat Dec 19 10:30:30 2015
@@ -37,12 +37,12 @@ public interface DocumentRenderer
* @param writer the Writer.
* @param renderer the Renderer.
* @param siteRenderingContext the SiteRenderingContext.
- * @throws org.apache.maven.doxia.siterenderer.RendererException if it bombs.
+ * @throws org.apache.maven.doxia.siterenderer.SiteRendererException if it bombs.
* @throws java.io.FileNotFoundException if it bombs.
* @throws java.io.UnsupportedEncodingException if it bombs.
*/
- void renderDocument( Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext )
- throws RendererException, FileNotFoundException, UnsupportedEncodingException;
+ void renderDocument( Writer writer, SiteRenderer renderer, SiteRenderingContext siteRenderingContext )
+ throws SiteRendererException, FileNotFoundException, UnsupportedEncodingException;
/**
* The name of the output document.
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java?rev=1720892&r1=1720891&r2=1720892&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java Sat Dec 19 10:30:30 2015
@@ -45,8 +45,8 @@ public class DoxiaDocumentRenderer
}
/** {@inheritDoc} */
- public void renderDocument( Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext )
- throws RendererException, FileNotFoundException, UnsupportedEncodingException
+ public void renderDocument( Writer writer, SiteRenderer renderer, SiteRenderingContext siteRenderingContext )
+ throws SiteRendererException, FileNotFoundException, UnsupportedEncodingException
{
renderer.renderDocument( writer, renderingContext, siteRenderingContext );
}
Copied: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaModuleReference.java (from r1720858, maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java)
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaModuleReference.java?p2=maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaModuleReference.java&p1=maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java&r1=1720858&r2=1720892&rev=1720892&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaModuleReference.java Sat Dec 19 10:30:30 2015
@@ -26,13 +26,13 @@ import java.io.File;
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*/
-class ModuleReference
+class DoxiaModuleReference
{
private final String parserId;
private final File basedir;
- ModuleReference( String parserId, File basedir )
+ DoxiaModuleReference( String parserId, File basedir )
{
this.parserId = parserId;
this.basedir = basedir;
Copied: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java (from r1720858, maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java)
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java?p2=maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java&p1=maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java&r1=1720858&r2=1720892&rev=1720892&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java Sat Dec 19 10:30:30 2015
@@ -33,44 +33,40 @@ import org.apache.maven.doxia.site.decor
import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
/**
- * <p>Renderer interface.</p>
+ * <p>Site Renderer interface: render a collection of documents into a site, ie decored with a site template
+ * (eventually packaged as skin).</p>
*
* @author <a href="mailto:evenisse@codehaus.org">Emmanuel Venisse</a>
* @version $Id$
*/
-public interface Renderer
+public interface SiteRenderer
{
/**
- * Plexus lookup role.
- */
- String ROLE = Renderer.class.getName();
-
- /**
- * Render a collection of documents.
+ * Render a collection of documents into a site.
*
* @param documents the documents to render.
* @param siteRenderingContext the SiteRenderingContext to use.
* @param outputDirectory the output directory to write results.
- * @throws org.apache.maven.doxia.siterenderer.RendererException if it bombs.
+ * @throws org.apache.maven.doxia.siterenderer.SiteRendererException if it bombs.
* @throws java.io.IOException if it bombs.
*/
void render( Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext,
File outputDirectory )
- throws RendererException, IOException;
+ throws SiteRendererException, IOException;
/**
- * Generate a document.
+ * Generate a document output from a SiteRenderer Sink.
*
* @param writer the Writer to use.
- * @param sink the Sink to receive the events.
+ * @param sink the Site Renderer Sink to receive the events.
* @param siteRenderingContext the SiteRenderingContext to use.
- * @throws org.apache.maven.doxia.siterenderer.RendererException if it bombs.
+ * @throws SiteRendererException if it bombs.
*/
void generateDocument( Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext )
- throws RendererException;
+ throws SiteRendererException;
/**
- * Return a SiteRenderingContext for a site using a skin.
+ * Create a Site Rendering Context for a site using a skin.
*
* @param skinFile
* @param attributes
@@ -80,12 +76,12 @@ public interface Renderer
* @return a SiteRenderingContext.
* @throws java.io.IOException if it bombs.
*/
- SiteRenderingContext createContextForSkin( File skinFile, Map<String, ?> attributes, DecorationModel decoration,
- String defaultWindowTitle, Locale locale )
+ SiteRenderingContext createSiteContextForSkin( File skinFile, Map<String, ?> attributes, DecorationModel decoration,
+ String defaultWindowTitle, Locale locale )
throws IOException;
/**
- * Return a SiteRenderingContext for a site using a local template.
+ * Create a Site Rendering Context for a site using a local template.
*
* @param templateFile
* @param skinFile
@@ -96,9 +92,9 @@ public interface Renderer
* @return a SiteRenderingContext.
* @throws java.net.MalformedURLException if it bombs.
*/
- SiteRenderingContext createContextForTemplate( File templateFile, File skinFile, Map<String, ?> attributes,
- DecorationModel decoration, String defaultWindowTitle,
- Locale locale )
+ SiteRenderingContext createSiteContextForTemplate( File templateFile, File skinFile, Map<String, ?> attributes,
+ DecorationModel decoration, String defaultWindowTitle,
+ Locale locale )
throws MalformedURLException;
/**
@@ -125,15 +121,15 @@ public interface Renderer
throws IOException;
/**
- * Return the document files in a Map.
+ * Locate Doxia document source files in the site source context.
*
* @param siteRenderingContext
- * @return the document files in a Map.
+ * @return the Doxia document renderers in a Map keyed by output file name.
* @throws java.io.IOException if it bombs.
- * @throws org.apache.maven.doxia.siterenderer.RendererException if it bombs.
+ * @throws SiteRendererException if it bombs.
*/
Map<String, DocumentRenderer> locateDocumentFiles( SiteRenderingContext siteRenderingContext )
- throws IOException, RendererException;
+ throws IOException, SiteRendererException;
/**
* Render a document written in a Doxia markup language.
@@ -141,10 +137,10 @@ public interface Renderer
* @param writer the writer to render the document to.
* @param renderingContext the document's rendering context
* @param siteContext the site's rendering context
- * @throws RendererException if it bombs.
+ * @throws SiteRendererException if it bombs.
* @throws FileNotFoundException if it bombs.
* @throws UnsupportedEncodingException if it bombs.
*/
void renderDocument( Writer writer, RenderingContext renderingContext, SiteRenderingContext siteContext )
- throws RendererException, FileNotFoundException, UnsupportedEncodingException;
+ throws SiteRendererException, FileNotFoundException, UnsupportedEncodingException;
}
Copied: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRendererException.java (from r1720858, maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RendererException.java)
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRendererException.java?p2=maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRendererException.java&p1=maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RendererException.java&r1=1720858&r2=1720892&rev=1720892&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RendererException.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRendererException.java Sat Dec 19 10:30:30 2015
@@ -25,7 +25,7 @@ package org.apache.maven.doxia.siterende
* @author Emmanuel Venisse
* @version $Id$
*/
-public class RendererException
+public class SiteRendererException
extends Exception
{
@@ -36,7 +36,7 @@ public class RendererException
*
* @param message a custom message.
*/
- public RendererException( String message )
+ public SiteRendererException( String message )
{
super( message );
}
@@ -47,7 +47,7 @@ public class RendererException
* @param message a custom message.
* @param t the cause.
*/
- public RendererException( String message, Throwable t )
+ public SiteRendererException( String message, Throwable t )
{
super( message, t );
}
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java?rev=1720892&r1=1720891&r2=1720892&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java Sat Dec 19 10:30:30 2015
@@ -65,7 +65,7 @@ public class SiteRenderingContext
private Map<String, String> moduleExcludes;
- private List<ModuleReference> modules = new ArrayList<ModuleReference>();
+ private List<DoxiaModuleReference> modules = new ArrayList<DoxiaModuleReference>();
private boolean validate;
@@ -293,7 +293,7 @@ public class SiteRenderingContext
*/
public void addModuleDirectory( File moduleBasedir, String moduleParserId )
{
- this.modules.add( new ModuleReference( moduleParserId, moduleBasedir ) );
+ this.modules.add( new DoxiaModuleReference( moduleParserId, moduleBasedir ) );
}
/**
@@ -311,7 +311,7 @@ public class SiteRenderingContext
*
* @return a {@link java.util.List} object.
*/
- public List<ModuleReference> getModules()
+ public List<DoxiaModuleReference> getModules()
{
return modules;
}
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java?rev=1720892&r1=1720891&r2=1720892&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java Sat Dec 19 10:30:30 2015
@@ -70,7 +70,7 @@ public class DefaultSiteRendererTest
/**
* The renderer used to produce output.
*/
- private Renderer renderer;
+ private SiteRenderer renderer;
/**
* The locale before executing tests.
@@ -89,7 +89,7 @@ public class DefaultSiteRendererTest
{
super.setUp();
- renderer = (Renderer) lookup( Renderer.ROLE );
+ renderer = (SiteRenderer) lookup( SiteRenderer.class );
// copy the default-site.vm
InputStream is =
@@ -225,7 +225,7 @@ public class DefaultSiteRendererTest
Map<String, ?> attributes = Collections.emptyMap();
SiteRenderingContext siteRenderingContext =
- renderer.createContextForTemplate( templateFile, null, attributes, new DecorationModel(),
+ renderer.createSiteContextForTemplate( templateFile, null, attributes, new DecorationModel(),
"defaultWindowTitle", Locale.ENGLISH );
RenderingContext context = new RenderingContext( new File( "" ), "document.html" );
SiteRendererSink sink = new SiteRendererSink( context );
@@ -244,7 +244,7 @@ public class DefaultSiteRendererTest
File skinFile = skinJar;
Map<String, ?> attributes = Collections.emptyMap();
SiteRenderingContext siteRenderingContext =
- renderer.createContextForSkin( skinFile, attributes, new DecorationModel(), "defaultWindowTitle",
+ renderer.createSiteContextForSkin( skinFile, attributes, new DecorationModel(), "defaultWindowTitle",
Locale.ENGLISH );
RenderingContext context = new RenderingContext( new File( "" ), "document.html" );
SiteRendererSink sink = new SiteRendererSink( context );