Package org.apache.rat

Class ReportConfiguration

  • public class ReportConfiguration
extends java.lang.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.

    • Field Detail

      • addingLicenses

        private boolean addingLicenses

      • addingLicensesForced

        private boolean addingLicensesForced

      • copyrightMessage

        private java.lang.String copyrightMessage

      • approveDefaultLicenses

        private boolean approveDefaultLicenses

    • Constructor Detail

      • ReportConfiguration

        public ReportConfiguration()

    • 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()