org.apache.creadur.whisker.model

Class License

java.lang.Object

org.apache.creadur.whisker.model.License

All Implemented Interfaces:

Comparable<License>

public class License
extends Object
implements Comparable<License>

Describes a software license.

Constructor Summary

Constructors

Constructor and Description
License(boolean isSourceRequired, String baseText, Collection<String> expectedParameters, String id, String url, String name) Constructs meta-data for a family of licenses.

Method Summary

Modifier and Type	Method and Description
int	compareTo(License other)
boolean	equals(Object obj)
Collection<String>	getExpectedParameters() Gets parameters required by the template to generate a instance of this license family.
String	getId() Gets the unique identifier for this license.
String	getName() Gets a name for this license suitable for display.
String	getText() Gets legal text expressing this license.
String	getText(Map<String,String> parameters) Gets legal text expressing this license,
String	getURL() Gets a locator for this license.
int	hashCode()
boolean	isSourceRequired() Is source information inclusion required by this license?
License	storeIn(Map<String,License> map) Stores the license by its id.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

License

public License(boolean isSourceRequired,
               String baseText,
               Collection<String> expectedParameters,
               String id,
               String url,
               String name)

Constructs meta-data for a family of licenses.

Parameters:

isSourceRequired - true if this license requires information about source distribution to be included within the distribution

baseText - a template for the legal text, not null

expectedParameters - not null

id - not null

url - not null

name - not null

Method Detail

isSourceRequired

public boolean isSourceRequired()

Is source information inclusion required by this license?

Returns:

true when information about the source should be included, false otherwise

getText

public String getText()
               throws LicenseTemplateException

Gets legal text expressing this license.

Returns:

not null

Throws:

LicenseTemplateException - when the text cannot be created from the template

getText

public String getText(Map<String,String> parameters)
               throws LicenseTemplateException

Gets legal text expressing this license,

Parameters:

parameters - possibly null

Returns:

not null

Throws:

LicenseTemplateException - when the text cannot be created from the template

getExpectedParameters

public Collection<String> getExpectedParameters()

Gets parameters required by the template to generate a instance of this license family.

Returns:

not null, possibly empty

storeIn

public License storeIn(Map<String,License> map)

Stores the license by its id.

Parameters:

map - not null

Returns:

the license stored

getId

public String getId()

Gets the unique identifier for this license.

Returns:

not null

getURL

public String getURL()

Gets a locator for this license.

Returns:

not null

getName

public String getName()

Gets a name for this license suitable for display.

Returns:

not null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

compareTo

public int compareTo(License other)

Specified by:

compareTo in interface Comparable<License>

See Also:

Comparable.compareTo(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object