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 interface	ILicenseFamily.Builder	The definition of an ILicenseFamily builder.

Method Summary

Modifier and Type	Method	Description
static ILicenseFamily.Builder	builder()
default int	compareTo(ILicenseFamily other)
String	getFamilyCategory()
String	getFamilyName()
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.

Method Details

getFamilyName

String getFamilyName()

Returns:

the license family name.

getFamilyCategory

String getFamilyCategory()

Returns:

the license family category.

builder

static ILicenseFamily.Builder builder()

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>