com.ehsbe.commons.util
Interface VersionInfo

All Known Implementing Classes:

Version

public interface VersionInfo

License infos for about dialogs etc.

Version:

$Revision: 432 $

Author:

Jens Elkner

Method Summary

boolean	allRightsReserved() Indicate, whether the copyright owner aka vendor has reserved all rights on the software.
String	getBuildNumber() Get the build ID
String	getEndYear() Get the year of development cycle, where this package was last time maintained.
String	getFromYear() Get the year of start of the development cycle of this package.
String	getLicensePath() Get the resource path for the plain text license file.
ImageIcon	getLogo() Get the Vendor logo.
String	getProductName() Get the name of the product.
String	getProductVersion() Get the version of the product.
String	getShortLicenseName() Get the short name of the license for the software.
String	getThirdPartyInfoPath() Get the path to for third party license infos.
String	getVendorName() Get the human readable name of the vendor.
String	getVendorURL() Get the URL of the vendor for this package.
boolean	isSubjectToLicenseTerms() Check, whether a note should be printed, whether the software is subject to special license terms.
void	printVersionInfo() Print the version/copyright/vendor information for this package.

Method Detail

getProductName

String getProductName()

Get the name of the product.

Returns:

always the same value and NOT null.

getProductVersion

String getProductVersion()

Get the version of the product.

Returns:

always the same value and NOT null.

getBuildNumber

String getBuildNumber()

Get the build ID

Returns:

always the same value. Might be null.

getFromYear

String getFromYear()

Get the year of start of the development cycle of this package.

Returns:

always the same value. Might be null.

getEndYear

String getEndYear()

Get the year of development cycle, where this package was last time maintained.

Returns:

always the same value. Might be null.

getVendorName

String getVendorName()

Get the human readable name of the vendor. Should be a short as possible.

Returns:

always the same value. Should not be null but can be.

getVendorURL

String getVendorURL()

Get the URL of the vendor for this package.

Returns:

always the same value. Might be null.

printVersionInfo

void printVersionInfo()

Print the version/copyright/vendor information for this package.

isSubjectToLicenseTerms

boolean isSubjectToLicenseTerms()

Check, whether a note should be printed, whether the software is subject to special license terms.

Returns:

true if a note should be displayed.

getShortLicenseName

String getShortLicenseName()

Get the short name of the license for the software. Usually something like {code LGPL (GNU Lesser General Public License)} or null if there is no special name.

Returns:

null if not applicable, the short name of the license otherwise.

allRightsReserved

boolean allRightsReserved()

Indicate, whether the copyright owner aka vendor has reserved all rights on the software.

Returns:

true if the vendor/copyright owner reserved all rights.

getLicensePath

String getLicensePath()

Get the resource path for the plain text license file.

Returns:

a resource path to the plain text formatted license file for this software. Should not be null but can be.

getThirdPartyInfoPath

String getThirdPartyInfoPath()

Get the path to for third party license infos. It must have the following format:

<info>
        <software>
                <name>Product or Software name</name>
                <version>Product/Software Version</version>
                <copyright>Copyright string</copyright>
                <type>License type</type>
                <url>URL to the product or vendor</url>
        </software>
        <software>
                ...
        </software>
</info>

E.g.:

<info>
        <software>
                <name>Swing Extensions</name>
                <version>1.0</version>
                <copyright>Copyright 2004 Sun Microsystems, Inc. All rights reserved.</copyright>
                <type>GNU Lesser General Public License (LGPL)</type>
                <url>https://swingx.dev.java.net/</url>
        </software>
</info>

Returns:

a resource path or null if no thirdparty software is used or no infos about it should be shown.

getLogo

ImageIcon getLogo()

Get the Vendor logo.

Returns:

the logo or null if not available.