Class ReportableListWalker

java.lang.Object

org.apache.rat.walker.ReportableListWalker

All Implemented Interfaces:

Reportable

public final class ReportableListWalker
extends Object
implements Reportable

A Reportable that walks a list of Reportables and executes the run on each.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ReportableListWalker.Builder	A Builder for the ListWalker.

Method Summary

Modifier and Type	Method	Description
static ReportableListWalker.Builder	builder(DocumentName name)	Create a builder for the list walker.
DocumentName	name()	Returns the DocumentName for the reportable.
void	run(RatReport report)	Adds the reportable to the RatReport.

Methods inherited from class Object

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

Method Details

builder

public static ReportableListWalker.Builder builder(DocumentName name)

Create a builder for the list walker.

Parameters:

name - the name of the walker.

Returns:

the builder.

run

public void run(RatReport report)

Description copied from interface: Reportable

Adds the reportable to the RatReport.

Specified by:

run in interface Reportable

Parameters:

report - the report to add the results to.

name

public DocumentName name()

Description copied from interface: Reportable

Returns the DocumentName for the reportable.

Specified by:

name in interface Reportable

Returns:

the DocumentName for the reportable.