Package net.sourceforge.pmd.renderers
Class EmptyRenderer
- java.lang.Object
-
- net.sourceforge.pmd.properties.AbstractPropertySource
-
- net.sourceforge.pmd.renderers.AbstractRenderer
-
- net.sourceforge.pmd.renderers.EmptyRenderer
-
- All Implemented Interfaces:
PropertySource
,Renderer
public class EmptyRenderer extends AbstractRenderer
An empty renderer, for when you really don't want a report.
-
-
Field Summary
Fields Modifier and Type Field Description static String
NAME
-
Fields inherited from class net.sourceforge.pmd.renderers.AbstractRenderer
description, name, showSuppressedViolations, writer
-
Fields inherited from class net.sourceforge.pmd.properties.AbstractPropertySource
propertyDescriptors, propertyValuesByDescriptor
-
-
Constructor Summary
Constructors Constructor Description EmptyRenderer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
defaultFileExtension()
Return the default filename extension to use.void
end()
This method is at the very end of the Rendering process, afterRenderer.renderFileReport(Report)
.void
renderFileReport(Report report)
Render the given file Report.void
start()
This method is called before any source files are processed.void
startFileAnalysis(TextFile dataSource)
This method is called each time a source file is processed.-
Methods inherited from class net.sourceforge.pmd.renderers.AbstractRenderer
determineFileName, flush, getDescription, getName, getPropertySourceType, getWriter, isShowSuppressedViolations, setDescription, setName, setReportFile, setShowSuppressedViolations, setWriter
-
Methods inherited from class net.sourceforge.pmd.properties.AbstractPropertySource
copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty, setProperty
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sourceforge.pmd.properties.PropertySource
definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty, setProperty
-
Methods inherited from interface net.sourceforge.pmd.renderers.Renderer
newListener
-
-
-
-
Field Detail
-
NAME
public static final String NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
defaultFileExtension
public String defaultFileExtension()
Description copied from interface:Renderer
Return the default filename extension to use.- Returns:
- String
-
start
public void start() throws IOException
Description copied from interface:Renderer
This method is called before any source files are processed. The Renderer will have been fully initialized by the time this method is called, so the Writer and other state will be available.- Throws:
IOException
-
startFileAnalysis
public void startFileAnalysis(TextFile dataSource)
Description copied from interface:Renderer
This method is called each time a source file is processed. It is called afterRenderer.start()
, but beforeRenderer.renderFileReport(Report)
andRenderer.end()
. This method may be invoked by different threads which are processing files independently. Therefore, any non-trivial implementation of this method needs to be thread-safe.- Parameters:
dataSource
- The source file.
-
renderFileReport
public void renderFileReport(Report report) throws IOException
Description copied from interface:Renderer
Render the given file Report. There may be multiple Report instances which need to be rendered if produced by different threads. It is called afterRenderer.start()
andRenderer.startFileAnalysis(TextFile)
, but beforeRenderer.end()
.- Parameters:
report
- A file Report.- Throws:
IOException
- See Also:
Report
-
end
public void end() throws IOException
Description copied from interface:Renderer
This method is at the very end of the Rendering process, afterRenderer.renderFileReport(Report)
.- Throws:
IOException
-
-