Package org.apache.rat
Class ReportConfiguration
- java.lang.Object
-
- org.apache.rat.ReportConfiguration
-
public class ReportConfiguration extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
addingLicenses
private boolean
addingLicensesForced
private boolean
approveDefaultLicenses
private ILicenseFamily[]
approvedLicenseNames
private java.lang.String
copyrightMessage
private IHeaderMatcher
headerMatcher
-
Constructor Summary
Constructors Constructor Description ReportConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ILicenseFamily[]
getApprovedLicenseNames()
Returns the set of approved license names.java.lang.String
getCopyrightMessage()
IHeaderMatcher
getHeaderMatcher()
Returns the header matcher.boolean
isAddingLicenses()
boolean
isAddingLicensesForced()
boolean
isApproveDefaultLicenses()
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
setApproveDefaultLicenses(boolean approveDefaultLicenses)
void
setApprovedLicenseNames(java.util.List<ILicenseFamily> approvedLicenseNames)
Sets the set of approved license names (convenience).void
setApprovedLicenseNames(ILicenseFamily[] approvedLicenseNames)
Sets the set of approved license names.void
setCopyrightMessage(java.lang.String copyrightMessage)
If Rat is adding license headers: Sets the optional copyright message.void
setHeaderMatcher(IHeaderMatcher headerMatcher)
Sets the header matcher.
-
-
-
Field Detail
-
headerMatcher
private IHeaderMatcher headerMatcher
-
approvedLicenseNames
private ILicenseFamily[] approvedLicenseNames
-
addingLicenses
private boolean addingLicenses
-
addingLicensesForced
private boolean addingLicensesForced
-
copyrightMessage
private java.lang.String copyrightMessage
-
approveDefaultLicenses
private boolean approveDefaultLicenses
-
-
Method Detail
-
isApproveDefaultLicenses
public boolean isApproveDefaultLicenses()
- Returns:
- whether default licenses shall be approved by default.
-
setApproveDefaultLicenses
public void setApproveDefaultLicenses(boolean approveDefaultLicenses)
-
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.
-
setApprovedLicenseNames
public void setApprovedLicenseNames(java.util.List<ILicenseFamily> approvedLicenseNames)
Sets the set of approved license names (convenience).- Parameters:
approvedLicenseNames
- set of approved license names.
-
getCopyrightMessage
public java.lang.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(java.lang.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
- enables/disables adding of licenses.- See Also:
setAddingLicensesForced(boolean)
,setCopyrightMessage(String)
-
-