org.apache.maven.model

Class License

java.lang.Object

org.apache.maven.model.License

All Implemented Interfaces:

Serializable, Cloneable, InputLocationTracker

public class License
extends Object
implements Serializable, Cloneable, InputLocationTracker

Describes the licenses for this project. This is used to generate the license page of the project's web site, as well as being taken into consideration in other reporting and validation. The licenses listed for the project are that of the project itself, and not of dependencies.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
License()

Method Summary

Modifier and Type	Method and Description
License	clone() Method clone.
String	getComments() Get addendum information pertaining to this license.
String	getDistribution() Get the primary method by which this project may be distributed.
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
String	getName() Get the full legal name of the license.
String	getUrl() Get the official url for the license text.
void	setComments(String comments) Set addendum information pertaining to this license.
void	setDistribution(String distribution) Set the primary method by which this project may be distributed.
void	setLocation(Object key, InputLocation location) Sets the location of the specified field.
void	setName(String name) Set the full legal name of the license.
void	setOtherLocation(Object key, InputLocation location)
void	setUrl(String url) Set the official url for the license text.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

License

public License()

Method Detail

clone

public License clone()

Method clone.

Overrides:

clone in class Object

Returns:

License

getComments

public String getComments()

Get addendum information pertaining to this license.

Returns:

String

getDistribution

public String getDistribution()

Get the primary method by which this project may be distributed.

repo

may be downloaded from the Maven repository

manual

user must manually download and install the dependency.

Returns:

String

getLocation

public InputLocation getLocation(Object key)

Description copied from interface: InputLocationTracker

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

Parameters:

key -

Returns:

InputLocation

getName

public String getName()

Get the full legal name of the license.

Returns:

String

setLocation

public void setLocation(Object key,
                        InputLocation location)

Description copied from interface: InputLocationTracker

Sets the location of the specified field.

Specified by:

setLocation in interface InputLocationTracker

Parameters:

key -

location -

setOtherLocation

public void setOtherLocation(Object key,
                             InputLocation location)

Parameters:

key -

location -

getUrl

public String getUrl()

Get the official url for the license text.

Returns:

String

setComments

public void setComments(String comments)

Set addendum information pertaining to this license.

Parameters:

comments -

setDistribution

public void setDistribution(String distribution)

Set the primary method by which this project may be distributed.

repo

may be downloaded from the Maven repository

manual

user must manually download and install the dependency.

Parameters:

distribution -

setName

public void setName(String name)

Set the full legal name of the license.

Parameters:

name -

setUrl

public void setUrl(String url)

Set the official url for the license text.

Parameters:

url -

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()