Package org.apache.rat.walker

Class IReportableListWalker

java.lang.Object

org.apache.rat.walker.IReportableListWalker

All Implemented Interfaces:

IReportable

public final class IReportableListWalker
extends Object
implements IReportable

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

builder

public static IReportableListWalker.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)
         throws RatException

Description copied from interface: IReportable

Adds the reportable to the RatReport.

Specified by:

run in interface IReportable

Parameters:

report - the report to add the results to.

Throws:

RatException - on error.

getName

public DocumentName getName()

Description copied from interface: IReportable

Returns the DocumentName for the reportable.

Specified by:

getName in interface IReportable

Returns:

the DocumentName for the reportable.