org.apache.maven.api.model

Class License

java.lang.Object

org.apache.maven.api.model.License

All Implemented Interfaces:

Serializable, InputLocationTracker

@Experimental
 @Generated
 @ThreadSafe
 @Immutable
public class License
extends Object
implements Serializable, 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	License.Builder Builder class used to create License instances.

Method Summary

Modifier and Type	Method and Description
String	getComments() Addendum information pertaining to this license.
String	getDistribution() 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() The full legal name of the license.
String	getUrl() The official url for the license text.
static License.Builder	newBuilder() Creates a new License builder instance.
static License.Builder	newBuilder(boolean withDefaults) Creates a new License builder instance using default values or not.
static License.Builder	newBuilder(License from) Creates a new License builder instance using the specified object as a basis.
static License.Builder	newBuilder(License from, boolean forceCopy) Creates a new License builder instance using the specified object as a basis.
static License	newInstance() Creates a new License instance.
static License	newInstance(boolean withDefaults) Creates a new License instance using default values or not.
License.Builder	with() Creates a new builder with this object as the basis.
License	withComments(String comments) Creates a new License instance using the specified comments.
License	withDistribution(String distribution) Creates a new License instance using the specified distribution.
License	withName(String name) Creates a new License instance using the specified name.
License	withUrl(String url) Creates a new License instance using the specified url.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

The full legal name of the license.

Returns:

a String

getUrl

public String getUrl()

The official url for the license text.

Returns:

a String

getDistribution

public String getDistribution()

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:

a String

getComments

public String getComments()

Addendum information pertaining to this license.

Returns:

a String

getLocation

public InputLocation getLocation(Object key)

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

Specified by:

getLocation in interface InputLocationTracker

with

@Nonnull
public License.Builder with()

Creates a new builder with this object as the basis.

Returns:

a Builder

withName

@Nonnull
public License withName(String name)

Creates a new License instance using the specified name.

Parameters:

name - the new String to use

Returns:

a License with the specified name

withUrl

@Nonnull
public License withUrl(String url)

Creates a new License instance using the specified url.

Parameters:

url - the new String to use

Returns:

a License with the specified url

withDistribution

@Nonnull
public License withDistribution(String distribution)

Creates a new License instance using the specified distribution.

Parameters:

distribution - the new String to use

Returns:

a License with the specified distribution

withComments

@Nonnull
public License withComments(String comments)

Creates a new License instance using the specified comments.

Parameters:

comments - the new String to use

Returns:

a License with the specified comments

newInstance

@Nonnull
public static License newInstance()

Creates a new License instance. Equivalent to newInstance( true ).

Returns:

a new License

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static License newInstance(boolean withDefaults)

Creates a new License instance using default values or not. Equivalent to newBuilder( withDefaults ).build().

Parameters:

withDefaults - the boolean indicating whether default values should be used

Returns:

a new License

newBuilder

@Nonnull
public static License.Builder newBuilder()

Creates a new License builder instance. Equivalent to newBuilder( true ).

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

@Nonnull
public static License.Builder newBuilder(boolean withDefaults)

Creates a new License builder instance using default values or not.

Parameters:

withDefaults - the boolean indicating whether default values should be used

Returns:

a new Builder

newBuilder

@Nonnull
public static License.Builder newBuilder(License from)

Creates a new License builder instance using the specified object as a basis. Equivalent to newBuilder( from, false ).

Parameters:

from - the License instance to use as a basis

Returns:

a new Builder

newBuilder

@Nonnull
public static License.Builder newBuilder(License from,
                                                  boolean forceCopy)

Creates a new License builder instance using the specified object as a basis.

Parameters:

from - the License instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder