com.phloc.commons.thirdparty

Interface IThirdPartyModule

All Superinterfaces:

IHasDisplayName, IHasVersion

All Known Implementing Classes:

ThirdPartyModule

public interface IThirdPartyModule
extends IHasDisplayName, IHasVersion

Represents meta information for a single third-party module (aka JAR file).

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
IThirdPartyModule	getAsNonOptionalCopy()
IThirdPartyModule	getAsOptionalCopy()
String	getCopyrightOwner()
ILicense	getLicense()
Version	getVersion()
String	getWebSiteURL()
boolean	isOptional()

Methods inherited from interface com.phloc.commons.name.IHasDisplayName

getDisplayName

Method Detail

getCopyrightOwner

@Nonnull
String getCopyrightOwner()

Returns:

The copyright owner of this module. May not be null.

getLicense

@Nonnull
ILicense getLicense()

Returns:

The license used by this module. May not be null.

getVersion

@Nullable
Version getVersion()

Specified by:

getVersion in interface IHasVersion

Returns:

The optional version of this product. May be null because this means another place where the version number needs to be maintained.

getWebSiteURL

@Nullable
String getWebSiteURL()

Returns:

The optional web site of the module. May be null.

isOptional

boolean isOptional()

Returns:

true if this is an optional thirdparty module, false if it is required.

getAsOptionalCopy

@Nonnull
IThirdPartyModule getAsOptionalCopy()

Returns:

A copy of this module but being optional. If this module is already optional, this is returned.

getAsNonOptionalCopy

@Nonnull
IThirdPartyModule getAsNonOptionalCopy()

Returns:

A copy of this module but without being optional. If this module is not optional, this is returned.