Package eu.bandm.tools.util3

Class ApiDocWarningsFilter

java.lang.Object

eu.bandm.tools.util3.ApiDocWarningsFilter

public class ApiDocWarningsFilter
extends Object

Takes the output protocol of javadoc and filters, counts, and re-arranges the warning messages. Because a larger project as metatools can have 40_000 warnings, the warnings of the most important categories are extracted and presented as a survey.

Storing and presenting is as follows:

  "warning:noMainDescription"\
                              V
  "warning:noComment" ----> methodTextMissing --> methodTextMissingByPackage

  "warning: no @param"  --> detailTextMissing --> detailTextMissingByPackage
  "warning: no @throws" ----^       ^                   ^
  "warning: no @return" --/       /                    /
  "warning: no description for " /                    /
                                                     /
  "warning: use of default constructor"---> defaultConstructor
  

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final SortedSet<String>	defaultConstructor
(package private) final SortedSet<String>	detailTextMissing
(package private) final SortedMap<String,Integer>	detailTextMissingByPackage	Includes the "defaultConstructor" warnings.
(package private) LineNumberReader	lnr
(package private) final SortedSet<String>	methodTextMissing
(package private) final SortedMap<String,Integer>	methodTextMissingByPackage
static final String	TOOLS_ROOT

Constructor Summary

Constructors

Constructor	Description
ApiDocWarningsFilter()

Method Summary

Modifier and Type	Method	Description
(package private) String	extractFilename(String line)
(package private) String	extractPackage(String line)
static void	main(String[] args)
(package private) void	nonStaticMain(String[] args)
(package private) void	putAndSkip(SortedSet<String> set, String file)	Store the file name in the given set.

Methods inherited from class java.lang.Object

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

Field Details

TOOLS_ROOT

public static final String TOOLS_ROOT

See Also:

• Constant Field Values

methodTextMissingByPackage

final SortedMap<String,Integer> methodTextMissingByPackage

detailTextMissingByPackage

final SortedMap<String,Integer> detailTextMissingByPackage

Includes the "defaultConstructor" warnings.

methodTextMissing

final SortedSet<String> methodTextMissing

detailTextMissing

final SortedSet<String> detailTextMissing

defaultConstructor

final SortedSet<String> defaultConstructor

lnr

LineNumberReader lnr

Constructor Details

ApiDocWarningsFilter

public ApiDocWarningsFilter()

Method Details

extractFilename

String extractFilename(String line)

extractPackage

String extractPackage(String line)

putAndSkip

void putAndSkip(SortedSet<String> set,
 String file)
         throws IOException

Store the file name in the given set. Read three lines of the input, discarding the detail inforamtion. Extract the package and increment the corresponding counter.

Throws:

IOException

main

public static void main(String[] args)
                 throws IOException

Parameters:

args - [0] = input file [1] = output file.

Throws:

IOException

nonStaticMain

void nonStaticMain(String[] args)
            throws IOException

Throws:

IOException