Package org.apache.rat.testhelpers

Class TestingLicense

java.lang.Object

org.apache.rat.testhelpers.TestingLicense

All Implemented Interfaces:

Comparable<ILicense>, IHeaderMatcher, ILicense

public class TestingLicense
extends Object
implements ILicense

A class to quickly build testing licenses.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.rat.license.ILicense

ILicense.Builder

Constructor Summary

Constructors

Constructor	Description
TestingLicense(String id)	Creates a testing license with the specified id and a default TestingMatcher
TestingLicense(String family, String id)	Creates a testing license with the specified id and a default TestingMatcher
TestingLicense(String family, String id, IHeaderMatcher matcher)	Creates a testing license with the specified id and matcher.
TestingLicense(String id, IHeaderMatcher matcher, ILicenseFamily family)	Creates a testing license with the specified matcher and family.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ILicenseFamily	getFamily()	Gets the family from the license.
String	getId()
ILicenseFamily	getLicenseFamily()
IHeaderMatcher	getMatcher()	Gets the matcher from the license.
String	getName()
String	getNote()
int	hashCode()
boolean	matches(IHeaders line)
void	reset()
void	setName(String name)	Sets the name from value for this license.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.rat.analysis.IHeaderMatcher

getDescription

Methods inherited from interface org.apache.rat.license.ILicense

compareTo, getFamilyName

Constructor Details

TestingLicense

public TestingLicense(String id)

Creates a testing license with the specified id and a default TestingMatcher

Parameters:

id - the id to use.

See Also:

• TestingMatcher

TestingLicense

public TestingLicense(String family,
 String id)

Creates a testing license with the specified id and a default TestingMatcher

Parameters:

family - the Family id.

id - the id to use.

See Also:

• TestingMatcher

TestingLicense

public TestingLicense(String family,
 String id,
 IHeaderMatcher matcher)

Creates a testing license with the specified id and matcher.

Parameters:

id - the id to use.

matcher - the matcher to execute.

TestingLicense

public TestingLicense(String id,
 IHeaderMatcher matcher,
 ILicenseFamily family)

Creates a testing license with the specified matcher and family.

Parameters:

id - the license id to use.

matcher - the matcher to use.

family - the family for this license.

Method Details

getFamily

public ILicenseFamily getFamily()

Gets the family from the license.

Returns:

the license family.

getMatcher

public IHeaderMatcher getMatcher()

Gets the matcher from the license.

Specified by:

getMatcher in interface ILicense

Returns:

the matcher.

setName

public void setName(String name)

Sets the name from value for this license.

Parameters:

name - the name of this license.

getId

public String getId()

Specified by:

getId in interface IHeaderMatcher

reset

public void reset()

Specified by:

reset in interface IHeaderMatcher

matches

public boolean matches(IHeaders line)

Specified by:

matches in interface IHeaderMatcher

getLicenseFamily

public ILicenseFamily getLicenseFamily()

Specified by:

getLicenseFamily in interface ILicense

getNote

public String getNote()

Specified by:

getNote in interface ILicense

getName

public String getName()

Specified by:

getName in interface ILicense

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object