com.phloc.commons.thirdparty

Class ThirdPartyModule

java.lang.Object

com.phloc.commons.thirdparty.ThirdPartyModule

All Implemented Interfaces:

IHasDisplayName, IThirdPartyModule, IHasVersion

@Immutable
public final class ThirdPartyModule
extends Object
implements IThirdPartyModule

The default implementation of the IThirdPartyModule interface.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_OPTIONAL By default a third-party module is not optional

Constructor Summary

Constructors

Constructor and Description
ThirdPartyModule(IThirdPartyModule aOther, boolean bOptional)
ThirdPartyModule(String sDisplayName, String sCopyrightOwner, ILicense aLicense)
ThirdPartyModule(String sDisplayName, String sCopyrightOwner, ILicense aLicense, boolean bOptional)
ThirdPartyModule(String sDisplayName, String sCopyrightOwner, ILicense aLicense, Version aVersion, String sWebsiteURL)
ThirdPartyModule(String sDisplayName, String sCopyrightOwner, ILicense aLicense, Version aVersion, String sWebsiteURL, boolean bOptional)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
ThirdPartyModule	getAsNonOptionalCopy()
ThirdPartyModule	getAsOptionalCopy()
String	getCopyrightOwner()
String	getDisplayName()
ILicense	getLicense()
Version	getVersion()
String	getWebSiteURL()
int	hashCode()
boolean	isOptional()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OPTIONAL

public static final boolean DEFAULT_OPTIONAL

By default a third-party module is not optional

See Also:

Constant Field Values

Constructor Detail

ThirdPartyModule

public ThirdPartyModule(@Nonnull
                IThirdPartyModule aOther,
                boolean bOptional)

ThirdPartyModule

public ThirdPartyModule(@Nonnull@Nonempty
                String sDisplayName,
                @Nonnull@Nonempty
                String sCopyrightOwner,
                @Nonnull
                ILicense aLicense)

ThirdPartyModule

public ThirdPartyModule(@Nonnull@Nonempty
                String sDisplayName,
                @Nonnull@Nonempty
                String sCopyrightOwner,
                @Nonnull
                ILicense aLicense,
                boolean bOptional)

ThirdPartyModule

public ThirdPartyModule(@Nonnull@Nonempty
                String sDisplayName,
                @Nonnull@Nonempty
                String sCopyrightOwner,
                @Nonnull
                ILicense aLicense,
                @Nullable
                Version aVersion,
                @Nullable
                String sWebsiteURL)

ThirdPartyModule

public ThirdPartyModule(@Nonnull@Nonempty
                String sDisplayName,
                @Nonnull@Nonempty
                String sCopyrightOwner,
                @Nonnull
                ILicense aLicense,
                @Nullable
                Version aVersion,
                @Nullable
                String sWebsiteURL,
                boolean bOptional)

Method Detail

getDisplayName

@Nonnull
@Nonempty
public String getDisplayName()

Specified by:

getDisplayName in interface IHasDisplayName

Returns:

The display name of this object. Should never be null.

getCopyrightOwner

@Nonnull
@Nonempty
public String getCopyrightOwner()

Specified by:

getCopyrightOwner in interface IThirdPartyModule

Returns:

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

getLicense

@Nonnull
public ILicense getLicense()

Specified by:

getLicense in interface IThirdPartyModule

Returns:

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

getVersion

@Nullable
public Version getVersion()

Specified by:

getVersion in interface IThirdPartyModule

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
public String getWebSiteURL()

Specified by:

getWebSiteURL in interface IThirdPartyModule

Returns:

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

isOptional

public boolean isOptional()

Specified by:

isOptional in interface IThirdPartyModule

Returns:

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

getAsOptionalCopy

@Nonnull
public ThirdPartyModule getAsOptionalCopy()

Specified by:

getAsOptionalCopy in interface IThirdPartyModule

Returns:

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

getAsNonOptionalCopy

@Nonnull
public ThirdPartyModule getAsNonOptionalCopy()

Specified by:

getAsNonOptionalCopy in interface IThirdPartyModule

Returns:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object