com.atlassian.bamboo.clover
Class CloverPluginHelper

java.lang.Object
  com.atlassian.bamboo.clover.CloverPluginHelper

public class CloverPluginHelper
extends java.lang.Object

Field Summary

static java.lang.String

BANDANA_KEY_GLOBAL_LICENSE_KEY

Constructor Summary

CloverPluginHelper()

Method Summary

static com.atlassian.extras.api.ProductLicense	getCloverProductLicense(java.lang.String licenseKey)
static java.lang.String	getGlobalLicenseKey(com.atlassian.bandana.BandanaManager bandanaManager) Retrieve global Clover license key
static java.lang.String	getLocalLicenseKey(BuildConfiguration config) Retrieve local Clover license key
static boolean	hasGlobalLicenseKey(com.atlassian.bandana.BandanaManager bandanaManager) Check if global Clover license has been defined
static boolean	hasValidGlobalLicenseKey(com.atlassian.bandana.BandanaManager bandanaManager) Check if global Clover license has been defined and is valid
static boolean	isAutoIntegrate(BuildConfiguration config) Test if Build Configuration says "Automatically integrate Clover into build"
static boolean	isAutoIntegrate(java.util.Map<java.lang.String,java.lang.String> config) Test if parameter map says "Automatically integrate Clover into build"
static boolean	isCloverOn(BuildConfiguration config)
static boolean	isCloverOn(java.util.Map<java.lang.String,java.lang.String> config)
static boolean	isUseLocalLicenseKey(BuildConfiguration config) Check if plan configuration makes use of locally defined license
static boolean	isValidLicenseKey(java.lang.String licenseKey) Test if provided Clover license key is valid
static void	setGlobalLicenseKey(com.atlassian.bandana.BandanaManager bandanaManager, java.lang.String globalLicenseKey) Set global Clover license

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BANDANA_KEY_GLOBAL_LICENSE_KEY

public static final java.lang.String BANDANA_KEY_GLOBAL_LICENSE_KEY

See Also:

Constant Field Values

Constructor Detail

CloverPluginHelper

public CloverPluginHelper()

Method Detail

isAutoIntegrate

public static boolean isAutoIntegrate(@Nullable
                                      BuildConfiguration config)

Test if Build Configuration says "Automatically integrate Clover into build"

Parameters:

config - BuildConfiguration object

Returns:

True if BuildConfiguration enables Clover auto configuration

isAutoIntegrate

public static boolean isAutoIntegrate(@Nullable
                                      java.util.Map<java.lang.String,java.lang.String> config)

Test if parameter map says "Automatically integrate Clover into build"

Parameters:

config - Parameter map

Returns:

True if parameter map enables Clover auto configuration

isCloverOn

public static boolean isCloverOn(@Nullable
                                 BuildConfiguration config)

isCloverOn

public static boolean isCloverOn(@Nullable
                                 java.util.Map<java.lang.String,java.lang.String> config)

isUseLocalLicenseKey

public static boolean isUseLocalLicenseKey(@Nullable
                                           BuildConfiguration config)

Check if plan configuration makes use of locally defined license

Parameters:

config -

Returns:

hasGlobalLicenseKey

public static boolean hasGlobalLicenseKey(@NotNull
                                          com.atlassian.bandana.BandanaManager bandanaManager)

Check if global Clover license has been defined

Parameters:

bandanaManager - BandanaManager object

Returns:

True if global Clover license has been defined

hasValidGlobalLicenseKey

public static boolean hasValidGlobalLicenseKey(@NotNull
                                               com.atlassian.bandana.BandanaManager bandanaManager)

Check if global Clover license has been defined and is valid

Parameters:

bandanaManager - BandanaManager object

Returns:

True if global Clover license has been defined

isValidLicenseKey

public static boolean isValidLicenseKey(java.lang.String licenseKey)

Test if provided Clover license key is valid

Parameters:

licenseKey - Clover license key

Returns:

True if license key is valid

getCloverProductLicense

@Nullable
public static com.atlassian.extras.api.ProductLicense getCloverProductLicense(java.lang.String licenseKey)

getGlobalLicenseKey

@NotNull
public static java.lang.String getGlobalLicenseKey(@NotNull
                                                           com.atlassian.bandana.BandanaManager bandanaManager)

Retrieve global Clover license key

Parameters:

bandanaManager - BandanaManager object

Returns:

Global Clover license or empty string if not defined.

setGlobalLicenseKey

public static void setGlobalLicenseKey(@NotNull
                                       com.atlassian.bandana.BandanaManager bandanaManager,
                                       @NotNull
                                       java.lang.String globalLicenseKey)

Set global Clover license

Parameters:

bandanaManager - BandanaManager object

globalLicenseKey - Clover global license key to be stored

getLocalLicenseKey

@Nullable
public static java.lang.String getLocalLicenseKey(@Nullable
                                                           BuildConfiguration config)

Retrieve local Clover license key

Parameters:

config - BuildConfiguration object

Returns:

Local Clover license or null if not defined.