org.pentaho.reporting.libraries.base.versioning

Class DependencyInformation

public class DependencyInformation extends Object

An data-structure documenting external dependencies. Use this in your ProjectInformation implementation to tell users what other libraries you use to give them proper credit.

Author: : Thomas Morgner

Constructor Summary
DependencyInformation(String name)
Creates a minimal dependency information object for the library with the given name.
DependencyInformation(String name, String version, String licenseName, String info)
Creates a minimal dependency information object for the library with the given name.
Method Summary
booleanequals(Object o)
Tests this object for equality.
StringgetInfo()
Returns the extra information.
StringgetLicenseName()
Returns the name of the license of this dependency.
StringgetName()
Returns the name of the dependency, which is never null.
StringgetVersion()
Returns the version number.
inthashCode()
Computes a hashcode based on the name of the dependency.

Constructor Detail

DependencyInformation

public DependencyInformation(String name)
Creates a minimal dependency information object for the library with the given name.

Parameters: name the name of the library, never null.

DependencyInformation

public DependencyInformation(String name, String version, String licenseName, String info)
Creates a minimal dependency information object for the library with the given name. All properties but the name are optional.

Parameters: name the name of the library, never null. version The version of the library, if known. licenseName The license the library is distributed under. info Some more information, liek a web-site or comment.

Method Detail

equals

public boolean equals(Object o)
Tests this object for equality. The object is equal if the name matches, the extra information is ignored.

Parameters: o the other object.

Returns: true, if the dependency information given denotes the same library as this dependency information.

getInfo

public String getInfo()
Returns the extra information.

Returns: the text information, or null if no extra information is known.

getLicenseName

public String getLicenseName()
Returns the name of the license of this dependency.

Returns: the license name.

getName

public String getName()
Returns the name of the dependency, which is never null.

Returns: the name.

getVersion

public String getVersion()
Returns the version number.

Returns: the version information, or null if no version information is known.

hashCode

public int hashCode()
Computes a hashcode based on the name of the dependency.

Returns: the hashcode.