net.sourceforge.pmd.renderers

Class TextPadRenderer

java.lang.Object

net.sourceforge.pmd.renderers.AbstractRenderer

net.sourceforge.pmd.renderers.OnTheFlyRenderer

net.sourceforge.pmd.renderers.TextPadRenderer

All Implemented Interfaces:

Renderer

public class TextPadRenderer
extends OnTheFlyRenderer

A Renderer for running PMD via a TextPad 'tool'. TextPad is a text editor by Helios Software Solutions.

Output lines are in the form:

pathtojavafile(line#, NameOfRule): Specific rule violation message

For example:

D:\java\pmd\src\src\net\sourceforge\pmd\renderers\TextPadRenderer.java(24, AtLeastOneConstructor): Each class should declare at least one constructor
D:\java\pmd\src\src\net\sourceforge\pmd\renderers\TextPadRenderer.java(26, VariableNamingConventionsRule): Variables should start with a lowercase character
D:\java\pmd\src\src\net\sourceforge\pmd\renderers\TextPadRenderer.java(31, ShortVariable): Avoid variables with short names

Author:

Jeff Epstein, based upon EmacsRenderer, Tuesday, September 23, 2003

Field Summary

Fields inherited from class net.sourceforge.pmd.renderers.OnTheFlyRenderer

errors, suppressed

Fields inherited from class net.sourceforge.pmd.renderers.AbstractRenderer

showSuppressedViolations

Constructor Summary

Constructors

Constructor and Description
TextPadRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
void	end()
void	renderFileViolations(java.util.Iterator<IRuleViolation> violations)
void	start()

Methods inherited from class net.sourceforge.pmd.renderers.OnTheFlyRenderer

render, renderFileReport

Methods inherited from class net.sourceforge.pmd.renderers.AbstractRenderer

getWriter, render, setWriter, showSuppressedViolations, startFileAnalysis

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextPadRenderer

public TextPadRenderer()

Method Detail

start

public void start()
           throws java.io.IOException

Specified by:

start in interface Renderer

Specified by:

start in class OnTheFlyRenderer

Throws:

java.io.IOException

renderFileViolations

public void renderFileViolations(java.util.Iterator<IRuleViolation> violations)
                          throws java.io.IOException

Specified by:

renderFileViolations in class OnTheFlyRenderer

Throws:

java.io.IOException

end

public void end()
         throws java.io.IOException

Specified by:

end in interface Renderer

Specified by:

end in class OnTheFlyRenderer

Throws:

java.io.IOException