com.puresoltechnologies.maven.plugins.license.parameter

Class KnownLicense

java.lang.Object

com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

All Implemented Interfaces:

Serializable

public class KnownLicense
extends Object
implements Serializable

This class contains a single known license. This license knowledge is used to be mapped to a dependency or artifact for reporting in a normalized form and with license text attached.

Author:

Rick-Rainer Ludwig

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KnownLicense()
KnownLicense(String name, URL url, boolean valid, Set<String> aliases, Set<String> approvedDependencies)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Set<String>	getAliases() Returns the aliases Set.
Set<String>	getApprovedDependencies() Returns the approvedDependencies Set.
String	getName() This method returns the license name.
URL	getUrl() Returns the URL to the license text.
int	hashCode()
boolean	isValid() Set returns the valid flag.
void	setAliases(Set<String> aliases) Sets a new aliases Set.
void	setApprovedDependencies(Set<String> approvedDependencies) Sets a new approvedDependencies Set.
void	setName(String name) This method sets the license's name.
void	setUrl(URL url) This method sets a URL to the full license text.
void	setValid(boolean valid)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

KnownLicense

public KnownLicense()

KnownLicense

public KnownLicense(String name,
                    URL url,
                    boolean valid,
                    Set<String> aliases,
                    Set<String> approvedDependencies)

Method Detail

setName

public void setName(String name)

This method sets the license's name.

Parameters:

name - is set to name.

getName

public String getName()

This method returns the license name.

Returns:

Returns name as String.

getUrl

public URL getUrl()

Returns the URL to the license text.

Returns:

The url is returned.

setUrl

public void setUrl(URL url)

This method sets a URL to the full license text.

Parameters:

url - is the URL to be set to url.

isValid

public boolean isValid()

Set returns the valid flag.

Returns:

true is returned if the license is valid. false is returned otherwise.

setValid

public void setValid(boolean valid)

getAliases

public Set<String> getAliases()

Returns the aliases Set.

Returns:

A Set of String is returned containing the alias names.

setAliases

public void setAliases(Set<String> aliases)

Sets a new aliases Set.

Parameters:

aliases - is a Set of String containing aliases for the license.

getApprovedDependencies

public Set<String> getApprovedDependencies()

Returns the approvedDependencies Set.

Returns:

A Set of String is returned containing names of dependencies which are approved.

setApprovedDependencies

public void setApprovedDependencies(Set<String> approvedDependencies)

Sets a new approvedDependencies Set.

Parameters:

approvedDependencies - is a Set of String which contains dependencies which are approved.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object