Package org.apache.rat.license

Interface ILicenseFamily

All Superinterfaces:
Comparable<ILicenseFamily>
public interface ILicenseFamily extends Comparable<ILicenseFamily>
The definition of the license family.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    ILicenseFamily.Builder
    The definition of an ILicenseFamily builder.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static ILicenseFamily
    UNKNOWN
    The license family for unknown licenses

  • Method Summary

    Modifier and Type
    Method
    Description
    static ILicenseFamily.Builder
    builder()
    Gets the Builder for license families.
    default int
    compareTo​(ILicenseFamily other)
     
    String
    getFamilyCategory()
    Gets the family category.
    String
    getFamilyName()
    Gets the family name.
    static String
    makeCategory​(String cat)
    Convert a potential category string into a category string of exactly 5 characters either by truncating the string or appending spaces as necessary.

  • Field Details

    • UNKNOWN

      static final ILicenseFamily UNKNOWN
      The license family for unknown licenses

  • Method Details

    • getFamilyName

      String getFamilyName()
      Gets the family name.
      Returns:
      the license family name.

    • getFamilyCategory

      String getFamilyCategory()
      Gets the family category.
      Returns:
      the license family category.

    • builder

      static ILicenseFamily.Builder builder()
      Gets the Builder for license families.
      Returns:
      A builder for an ILicenseFamily.

    • makeCategory

      static String makeCategory​(String cat)
      Convert a potential category string into a category string of exactly 5 characters either by truncating the string or appending spaces as necessary.
      Parameters:
      cat - the string to convert.
      Returns:
      a string of exactly 5 characters.

    • compareTo

      default int compareTo​(ILicenseFamily other)
      Specified by:
      compareTo in interface Comparable<ILicenseFamily>