org.eclipse.equinox.internal.p2.metadata

Class License

java.lang.Object

org.eclipse.equinox.internal.p2.metadata.License

All Implemented Interfaces:

ILicense

public class License
extends java.lang.Object
implements ILicense

The License class represents a software license. A license has required body text which may be the full text or an annotation. An optional URL field can be specified which links to full text. Licenses can be easily compared using their digests.

Constructor Summary

Constructors

Constructor and Description
License(java.net.URI location, java.lang.String body, java.lang.String uuid) Creates a new license object which is identified by users using the body field.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns whether this license is equal to the given object.
java.lang.String	getBody() Returns the license body.
java.net.URI	getLocation() Returns the location of a document containing the full license.
java.lang.String	getUUID() Returns the message digest of the license body.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

License

public License(java.net.URI location,
               java.lang.String body,
               java.lang.String uuid)

Creates a new license object which is identified by users using the body field. The body should contain either the full text of the license or an summary for a license fully specified in the given location.

Parameters:

location - the location of a document containing the full license, or null

body - the license body, cannot be null

Throws:

java.lang.IllegalArgumentException - when the body is null

Method Detail

getLocation

public java.net.URI getLocation()

Returns the location of a document containing the full license.

Specified by:

getLocation in interface ILicense

Returns:

the location of the license document, or null

getBody

public java.lang.String getBody()

Returns the license body.

Specified by:

getBody in interface ILicense

Returns:

the license body, never null

getUUID

public java.lang.String getUUID()

Returns the message digest of the license body. The digest is calculated on a normalized version of the license where all whitespace has been reduced to one space.

Specified by:

getUUID in interface ILicense

Returns:

the message digest as a BigInteger, never null

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: ILicense

Returns whether this license is equal to the given object. This method returns true if:

• Both this object and the given object are of type ILicense
• The result of getDigest() on both objects are equal

Specified by:

equals in interface ILicense

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object