Package net.sourceforge.pmd.renderers
Class TextColorRenderer
- java.lang.Object
-
- net.sourceforge.pmd.properties.AbstractPropertySource
-
- net.sourceforge.pmd.renderers.AbstractRenderer
-
- net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
-
- net.sourceforge.pmd.renderers.TextColorRenderer
-
- All Implemented Interfaces:
PropertySource
,Renderer
public class TextColorRenderer extends AbstractAccumulatingRenderer
A console renderer with optional color support under *nix systems.
* file: ./src/gilot/Test.java src: Test.java:12 rule: AtLeastOneConstructor msg: Each class should declare at least one constructor code: public class Test * file: ./src/gilot/log/format/LogInterpreter.java src: LogInterpreter.java:317 rule: AvoidDuplicateLiterals msg: The same String literal appears 4 times in this file; the first occurrence is on line 317 code: logger.error( "missing attribute 'app_arg' in rule '" + ((Element)element.getParent()).getAttributeValue( "name" ) + "'" ); src: LogInterpreter.java:317 rule: AvoidDuplicateLiterals msg: The same String literal appears 5 times in this file; the first occurrence is on line 317 code: logger.error( "missing attribute 'app_arg' in rule '" + ((Element)element.getParent()).getAttributeValue( "name" ) + "'" ); * warnings: 3
Colorization is turned on by supplying -Dpmd.color - any value other than '0' or 'false', enables color - including an empty value (''). Nota Bene: colorization is atm only supported under *nix terminals accepting ansi escape sequences, such as xterm, rxvt et cetera.
-
-
Field Summary
Fields Modifier and Type Field Description static PropertyDescriptor<String>
COLOR
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 TextColorRenderer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
defaultFileExtension()
Return the default filename extension to use.protected Reader
getReader(String sourceFile)
void
outputReport(Report report)
Output the report, called once at the end of the analysis.-
Methods inherited from class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
end, newListener, renderFileReport, start, startFileAnalysis
-
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
-
-
-
-
Field Detail
-
NAME
public static final String NAME
- See Also:
- Constant Field Values
-
COLOR
public static final PropertyDescriptor<String> COLOR
-
-
Method Detail
-
defaultFileExtension
public String defaultFileExtension()
Description copied from interface:Renderer
Return the default filename extension to use.- Returns:
- String
-
outputReport
public void outputReport(Report report) throws IOException
Description copied from class:AbstractAccumulatingRenderer
Output the report, called once at the end of the analysis.- Specified by:
outputReport
in classAbstractAccumulatingRenderer
- Throws:
IOException
-
getReader
protected Reader getReader(String sourceFile) throws FileNotFoundException
- Throws:
FileNotFoundException
-
-