Package com.helger.base.thirdparty

Class ThirdPartyModule

java.lang.Object

com.helger.base.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	Description
static final boolean	DEFAULT_OPTIONAL	By default a third-party module is not optional

Constructor Summary

Constructors

Constructor	Description
ThirdPartyModule(@NonNull IThirdPartyModule aOther, boolean bOptional)	Constructor copying from another third party module with a different optional flag.
ThirdPartyModule(@NonNull @Nonempty String sDisplayName, @NonNull @Nonempty String sCopyrightOwner, @NonNull ILicense aLicense)	Constructor with required fields and default optional flag.
ThirdPartyModule(@NonNull @Nonempty String sDisplayName, @NonNull @Nonempty String sCopyrightOwner, @NonNull ILicense aLicense, boolean bOptional)	Constructor with required fields and optional flag.
ThirdPartyModule(@NonNull @Nonempty String sDisplayName, @NonNull @Nonempty String sCopyrightOwner, @NonNull ILicense aLicense, @Nullable Version aVersion, @Nullable String sWebsiteURL)	Constructor with all fields except optional flag.
ThirdPartyModule(@NonNull @Nonempty String sDisplayName, @NonNull @Nonempty String sCopyrightOwner, @NonNull ILicense aLicense, @Nullable Version aVersion, @Nullable String sWebsiteURL, boolean bOptional)	Full constructor with all fields.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_OPTIONAL

public static final boolean DEFAULT_OPTIONAL

By default a third-party module is not optional

See Also:

• Constant Field Values

Constructor Details

ThirdPartyModule

public ThirdPartyModule(@NonNull IThirdPartyModule aOther,
 boolean bOptional)

Constructor copying from another third party module with a different optional flag.

Parameters:

aOther - The third party module to copy from. May not be null.

bOptional - true if the module is optional, false otherwise.

ThirdPartyModule

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

Constructor with required fields and default optional flag.

Parameters:

sDisplayName - The display name. Neither null nor empty.

sCopyrightOwner - The copyright owner. Neither null nor empty.

aLicense - The license. May not be null.

ThirdPartyModule

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

Constructor with required fields and optional flag.

Parameters:

sDisplayName - The display name. Neither null nor empty.

sCopyrightOwner - The copyright owner. Neither null nor empty.

aLicense - The license. May not be null.

bOptional - true if the module is optional, false otherwise.

ThirdPartyModule

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

Constructor with all fields except optional flag.

Parameters:

sDisplayName - The display name. Neither null nor empty.

sCopyrightOwner - The copyright owner. Neither null nor empty.

aLicense - The license. May not be null.

aVersion - The version. May be null.

sWebsiteURL - The website URL. May be null.

ThirdPartyModule

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

Full constructor with all fields.

Parameters:

sDisplayName - The display name. Neither null nor empty.

sCopyrightOwner - The copyright owner. Neither null nor empty.

aLicense - The license. May not be null.

aVersion - The version. May be null.

sWebsiteURL - The website URL. May be null.

bOptional - true if the module is optional, false otherwise.

Method Details

getDisplayName

@Nonempty
public @NonNull @Nonempty String getDisplayName()

Specified by:

getDisplayName in interface IHasDisplayName

Returns:

The display name of this module. Neither null nor empty.

getCopyrightOwner

@Nonempty
public @NonNull @Nonempty String getCopyrightOwner()

Specified by:

getCopyrightOwner in interface IThirdPartyModule

Returns:

The copyright owner of this module. Neither null nor empty.

getLicense

public @NonNull ILicense getLicense()

Specified by:

getLicense in interface IThirdPartyModule

Returns:

The license of this module. Never null.

getVersion

public @Nullable Version getVersion()

Specified by:

getVersion in interface IHasVersion

Specified by:

getVersion in interface IThirdPartyModule

Returns:

The version of this module. May be null.

getWebSiteURL

public @Nullable String getWebSiteURL()

Specified by:

getWebSiteURL in interface IThirdPartyModule

Returns:

The website URL of this module. May be null.

isOptional

public boolean isOptional()

Specified by:

isOptional in interface IThirdPartyModule

Returns:

true if this module is optional, false otherwise.

getAsOptionalCopy

public @NonNull ThirdPartyModule getAsOptionalCopy()

Specified by:

getAsOptionalCopy in interface IThirdPartyModule

Returns:

A copy of this module with the optional flag set to true. If already optional, this is returned. Never null.

getAsNonOptionalCopy

public @NonNull ThirdPartyModule getAsNonOptionalCopy()

Specified by:

getAsNonOptionalCopy in interface IThirdPartyModule

Returns:

A copy of this module with the optional flag set to false. If already non-optional, this is returned. Never null.

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