Package org.apache.maven.model
Class License
java.lang.Object
org.apache.maven.model.License
- All Implemented Interfaces:
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Addendum information pertaining to this license.private InputLocation
Field commentsLocation.private String
The primary method by which this project may be distributed.private InputLocation
Field distributionLocation.private InputLocation
Field location.private Map<Object,
InputLocation> Field locations.private String
The full legal name of the license.private InputLocation
Field nameLocation.private String
The official url for the license text.private InputLocation
Field urlLocation. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Method clone.Get addendum information pertaining to this license.Get the primary method by which this project may be distributed.getLocation
(Object key) Gets the location of the specified field in the input source.getName()
Get the full legal name of the license.private InputLocation
getOtherLocation
(Object key) 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
Set the full legal name of the license.void
setOtherLocation
(Object key, InputLocation location) void
Set the official url for the license text.toString()
-
Field Details
-
name
The full legal name of the license. -
url
The official url for the license text. -
distribution
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.
-
comments
Addendum information pertaining to this license. -
locations
Field locations. -
location
Field location. -
nameLocation
Field nameLocation. -
urlLocation
Field urlLocation. -
distributionLocation
Field distributionLocation. -
commentsLocation
Field commentsLocation.
-
-
Constructor Details
-
License
public License()
-
-
Method Details
-
clone
Method clone. -
getComments
Get addendum information pertaining to this license.- Returns:
- 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
Description copied from interface:InputLocationTracker
Gets the location of the specified field in the input source.- Specified by:
getLocation
in interfaceInputLocationTracker
- Parameters:
key
- a key object.- Returns:
- InputLocation
-
getName
Get the full legal name of the license.- Returns:
- String
-
setLocation
Description copied from interface:InputLocationTracker
Sets the location of the specified field.- Specified by:
setLocation
in interfaceInputLocationTracker
- Parameters:
key
- a key object.location
- a location object.
-
setOtherLocation
- Parameters:
key
- a key object.location
- a location object.
-
getOtherLocation
- Parameters:
key
- a key object.- Returns:
- InputLocation
-
getUrl
Get the official url for the license text.- Returns:
- String
-
setComments
Set addendum information pertaining to this license.- Parameters:
comments
- a comments object.
-
setDistribution
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
- a distribution object.
-
setName
Set the full legal name of the license.- Parameters:
name
- a name object.
-
setUrl
Set the official url for the license text.- Parameters:
url
- a url object.
-
toString
-