org.codehaus.mojo.license.model

Class License

java.lang.Object

org.codehaus.mojo.license.model.License

public class License
extends Object

The model of a license.

Since:

1.0

Author:

tchemit

Field Summary

Fields

Modifier and Type	Field and Description
protected URL	baseURL base url of license (directory where to find license files).
protected String	description the description of the license.
protected URL	headerURL url of the license header's content.
static String	LICENSE_CONTENT_FILE
static String	LICENSE_HEADER_FILE
protected URL	licenseURL url of the license's content.
protected String	name the name of the licenses (ex lgpl-3.0).
static String	TEMPLATE_SUFFIX

Constructor Summary

Constructors

Constructor and Description
License()

Method Summary

Methods

Modifier and Type	Method and Description
URL	getBaseURL()
String	getDescription()
String	getHeaderContent(String encoding)
URL	getHeaderURL()
String	getLicenseContent(String encoding)
URL	getLicenseURL()
String	getName()
boolean	isHeaderContentTemplateAware()
boolean	isLicenseContentTemplateAware()
void	setBaseURL(URL baseURL)
void	setDescription(String description)
void	setHeaderURL(URL headerURL)
void	setLicenseURL(URL licenseURL)
void	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LICENSE_HEADER_FILE

public static final String LICENSE_HEADER_FILE

See Also:

Constant Field Values

LICENSE_CONTENT_FILE

public static final String LICENSE_CONTENT_FILE

See Also:

Constant Field Values

TEMPLATE_SUFFIX

public static final String TEMPLATE_SUFFIX

See Also:

Constant Field Values

baseURL

protected URL baseURL

base url of license (directory where to find license files).

name

protected String name

the name of the licenses (ex lgpl-3.0).

description

protected String description

the description of the license.

licenseURL

protected URL licenseURL

url of the license's content.

headerURL

protected URL headerURL

url of the license header's content.

Constructor Detail

License

public License()

Method Detail

getName

public String getName()

getLicenseURL

public URL getLicenseURL()

getHeaderURL

public URL getHeaderURL()

getDescription

public String getDescription()

getBaseURL

public URL getBaseURL()

isHeaderContentTemplateAware

public boolean isHeaderContentTemplateAware()

isLicenseContentTemplateAware

public boolean isLicenseContentTemplateAware()

getLicenseContent

public String getLicenseContent(String encoding)
                         throws IOException

Throws:

IOException

getHeaderContent

public String getHeaderContent(String encoding)
                        throws IOException

Throws:

IOException

setName

public void setName(String name)

setDescription

public void setDescription(String description)

setBaseURL

public void setBaseURL(URL baseURL)

setLicenseURL

public void setLicenseURL(URL licenseURL)

setHeaderURL

public void setHeaderURL(URL headerURL)

toString

public String toString()

Overrides:

toString in class Object