ReportConfiguration (Apache Creadur Rat::Core 0.11 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.rat
Class ReportConfiguration

java.lang.Object
  org.apache.rat.ReportConfiguration

public class ReportConfiguration
extends Object
extends Object

A configuration object is used by the frontend to invoke the Report. Basically, the sole purpose of the frontends is to create the configuration and invoke the Report.

Constructor Summary
`ReportConfiguration()`

Method Summary
`ILicenseFamily[]`	`getApprovedLicenseNames()` Returns the set of approved license names.
`String`	`getCopyrightMessage()`
`IHeaderMatcher`	`getHeaderMatcher()` Returns the header matcher.
`boolean`	`isAddingLicenses()`
`boolean`	`isAddingLicensesForced()`
`void`	`setAddingLicenses(boolean addingLicenses)` Returns, whether Rat should add missing license headers.
`void`	`setAddingLicensesForced(boolean addingLicensesForced)` If Rat is adding license headers: Sets, whether adding license headers is enforced.
`void`	`setApprovedLicenseNames(ILicenseFamily[] approvedLicenseNames)` Sets the set of approved license names.
`void`	`setCopyrightMessage(String copyrightMessage)` If Rat is adding license headers: Sets the optional copyright message.
`void`	`setHeaderMatcher(IHeaderMatcher headerMatcher)` Sets the header matcher.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ReportConfiguration

public ReportConfiguration()

Method Detail

getHeaderMatcher

public IHeaderMatcher getHeaderMatcher()

Returns the header matcher.

Returns:: the header matcher.

setHeaderMatcher

public void setHeaderMatcher(IHeaderMatcher headerMatcher)

Sets the header matcher.

Parameters:: headerMatcher - header matcher.

getApprovedLicenseNames

public ILicenseFamily[] getApprovedLicenseNames()

Returns the set of approved license names.

Returns:: the set of approved license names.

setApprovedLicenseNames

public void setApprovedLicenseNames(ILicenseFamily[] approvedLicenseNames)

Sets the set of approved license names.

Parameters:: approvedLicenseNames - set of approved license names.

getCopyrightMessage

public String getCopyrightMessage()

Returns:: If Rat is adding license headers: Returns the optional copyright message. This value is ignored, if no license headers are added.
See Also:: isAddingLicenses()

setCopyrightMessage

public void setCopyrightMessage(String copyrightMessage)

If Rat is adding license headers: Sets the optional copyright message. This value is ignored, if no license headers are added.

Parameters:: copyrightMessage - message to set.
See Also:: setAddingLicenses(boolean)

isAddingLicensesForced

public boolean isAddingLicensesForced()

Returns:: If Rat is adding license headers: Returns, whether adding license headers is enforced. This value is ignored, if no license headers are added.
See Also:: isAddingLicenses()

setAddingLicensesForced

public void setAddingLicensesForced(boolean addingLicensesForced)

If Rat is adding license headers: Sets, whether adding license headers is enforced. This value is ignored, if no license headers are added.

Parameters:: addingLicensesForced - enable/disable forcibly adding licenses.
See Also:: isAddingLicenses()

isAddingLicenses

public boolean isAddingLicenses()

Returns:: Returns, whether Rat should add missing license headers.
See Also:: isAddingLicensesForced(), getCopyrightMessage()

setAddingLicenses

public void setAddingLicenses(boolean addingLicenses)

Returns, whether Rat should add missing license headers.

Parameters:: addingLicenses - enabled/disables adding of licenses.
See Also:: setAddingLicensesForced(boolean), setCopyrightMessage(String)