ottlinger commented on code in PR #233:
URL: https://github.com/apache/creadur-rat/pull/233#discussion_r1564235828
##########
apache-rat-core/src/main/java/org/apache/rat/license/ILicense.java:
##########
@@ -22,42 +22,58 @@
import java.util.Objects;
import java.util.SortedSet;
+import org.apache.rat.ConfigurationException;
import org.apache.rat.analysis.IHeaderMatcher;
/**
* The definition of a License.
*/
public interface ILicense extends IHeaderMatcher, Comparable<ILicense> {
/**
+ * Gets the license family.
* @return the ILicenseFamily implementation for this license.
*/
ILicenseFamily getLicenseFamily();
/**
- * @return the notes associated with this license. May be null or empty.
+ * Gets the notes associated with the license.
+ * @return the notes associated with this license. May be null or empty.
*/
String getNotes();
/**
- * @return the id of a license that this license is derived from. May be
null.
- */
- String derivedFrom();
-
- /**
- * Returns the name of this license. If no name was specified then the
name of the family is returned.
+ * Returns the name of this license. If no name was specified then the
name of
+ * the family is returned.
+ *
* @return the name of this license.
*/
String getName();
/**
+ * Gets the name of the family that this license if part of.
+ * @return the name of the license family that this license is part of.
+ */
+ default String getFamilyName() {
+ return getLicenseFamily().getFamilyName();
+ }
+
+ /**
+ * Get the header matcher for this license.
+ * @return the header matcher for this license.
+ */
+ IHeaderMatcher getMatcher();
+
+ /**
+ * Gets a builder for licenses.
* @return An ILicense.Builder instance.
*/
static ILicense.Builder builder() {
return new Builder();
}
/**
- * @return The comparator for used to sort Licenses.
+ * Gets the comparator for comparing licenses.
+ * @return The comparator for used to sort Licenses.
Review Comment:
The comparator that is used for sorting licenses.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
