Package org.apache.rat.documentation.velocity

Class License

java.lang.Object

org.apache.rat.documentation.velocity.License

public final class License
extends Object

The License representation for documentation.

Method Summary

Modifier and Type	Method	Description
String	family()	Gets the family name of this license.
Matcher	getMatcher()	Gets the matcher associated with this license.
MatcherTree	getMatcherTree()	Gets the matcher tree associated with this license.
String	id()	Gets the id for this license if it is not a system generated one.
String	name()	Gets the name of this license.
String	note()	Gets the space normalized note for the license.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

name

public String name()

Gets the name of this license.

Returns:

the name of this license.

family

public String family()

Gets the family name of this license.

Returns:

the family name of this license.

note

public String note()

Gets the space normalized note for the license.

Returns:

the space normalized note for the license. May be null.

See Also:

• StringUtils

id

public String id()

Gets the id for this license if it is not a system generated one.

Returns:

the id for this license. May be null.

getMatcher

public Matcher getMatcher()

Gets the matcher associated with this license.

Returns:

the matcher associated with this license.

getMatcherTree

public MatcherTree getMatcherTree()

Gets the matcher tree associated with this license.

Returns:

the matcher tree associated with this license.