Uses of Interface
org.apache.rat.license.ILicenseFamily
Packages that use ILicenseFamily
Package
Description
The base package for the RAT tool.
Classes that perform analyses of files.
Classes to process configuration information from/to files.
Classes describing licenses
-
Uses of ILicenseFamily in org.apache.rat
Methods in org.apache.rat that return types with arguments of type ILicenseFamilyModifier and TypeMethodDescriptionReportConfiguration.getLicenseFamilies(LicenseSetFactory.LicenseFilter filter)
Gets a sorted set of ILicenseFamily objects based onfilter
. if filter is set:all
- All licenses families will be returned.approved
- Only approved license families will be returnednone
- No license families will be returnedBuilderParams.licenseFamilies()
Gets a sorted set of registered license families.Methods in org.apache.rat with parameters of type ILicenseFamilyModifier and TypeMethodDescriptionvoid
ReportConfiguration.addApprovedLicenseCategory(ILicenseFamily approvedILicenseFamily)
Adds an ILicenseFamily to the list of approved licenses.void
ReportConfiguration.addFamily(ILicenseFamily family)
Adds a license family to the list of families.Method parameters in org.apache.rat with type arguments of type ILicenseFamilyModifier and TypeMethodDescriptionvoid
ReportConfiguration.addFamilies(Collection<ILicenseFamily> families)
Adds multiple families to the list of license families. -
Uses of ILicenseFamily in org.apache.rat.analysis
Methods in org.apache.rat.analysis that return ILicenseFamily -
Uses of ILicenseFamily in org.apache.rat.analysis.license
Methods in org.apache.rat.analysis.license that return ILicenseFamilyModifier and TypeMethodDescriptionBaseLicense.getLicenseFamily()
Deprecated.DeprecatedConfig.getLicenseFamily()
Deprecated. -
Uses of ILicenseFamily in org.apache.rat.configuration
Methods in org.apache.rat.configuration that return types with arguments of type ILicenseFamilyModifier and TypeMethodDescriptionLicenseReader.readFamilies()
Reads the configuration and extracts instances of ILicenseFamily.XMLConfigurationReader.readFamilies()
-
Uses of ILicenseFamily in org.apache.rat.license
Fields in org.apache.rat.license declared as ILicenseFamilyModifier and TypeFieldDescriptionstatic ILicenseFamily
ILicenseFamily.UNKNOWN
The license family for unknown licensesMethods in org.apache.rat.license that return ILicenseFamilyModifier and TypeMethodDescriptionILicenseFamily.Builder.build()
Builds the defined license family.static ILicenseFamily
LicenseSetFactory.familySearch(String target, SortedSet<ILicenseFamily> licenseFamilies)
Search a SortedSet of ILicenseFamily instances looking for a matching instance.static ILicenseFamily
LicenseSetFactory.familySearch(ILicenseFamily target, SortedSet<ILicenseFamily> licenseFamilies)
Search a SortedSet of ILicenseFamily instances looking for a matching instance.ILicense.getLicenseFamily()
Gets the license family.SimpleLicense.getLicenseFamily()
Methods in org.apache.rat.license that return types with arguments of type ILicenseFamilyModifier and TypeMethodDescriptionLicenseSetFactory.getLicenseFamilies(LicenseSetFactory.LicenseFilter filter)
Gets the LicenseFamily objects based on the filter.Methods in org.apache.rat.license with parameters of type ILicenseFamilyModifier and TypeMethodDescriptionvoid
LicenseSetFactory.addFamily(ILicenseFamily family)
Adds a license family to the list of families.default int
ILicenseFamily.compareTo(ILicenseFamily other)
static ILicenseFamily
LicenseSetFactory.familySearch(ILicenseFamily target, SortedSet<ILicenseFamily> licenseFamilies)
Search a SortedSet of ILicenseFamily instances looking for a matching instance.Method parameters in org.apache.rat.license with type arguments of type ILicenseFamilyModifier and TypeMethodDescriptionstatic ILicenseFamily
LicenseSetFactory.familySearch(String target, SortedSet<ILicenseFamily> licenseFamilies)
Search a SortedSet of ILicenseFamily instances looking for a matching instance.static ILicenseFamily
LicenseSetFactory.familySearch(ILicenseFamily target, SortedSet<ILicenseFamily> licenseFamilies)
Search a SortedSet of ILicenseFamily instances looking for a matching instance.ILicense.Builder.setLicenseFamilies(SortedSet<ILicenseFamily> licenseFamilies)
Sets the set of license families to use during build.SimpleLicense.Builder.setLicenseFamilies(SortedSet<ILicenseFamily> licenseFamilies)