Package com.parasoft.findings.jenkins.coverage.api.metrics.color

Class ColorProvider

java.lang.Object

com.parasoft.findings.jenkins.coverage.api.metrics.color.ColorProvider

public class ColorProvider
extends Object

Loads a color palette and provides these colors and operations on them. The colors are provided as a tuple of fill color and line color, mapped by the id of the fill color.

Author:

Florian Orendi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ColorProvider.DisplayColors	Wraps the fill color and the line color that should be used in order to visualize coverage values.

Field Summary

Fields

Modifier and Type	Field	Description
static ColorProvider.DisplayColors	DEFAULT_COLOR	Default color that is provided if no color is found in order to guarantee a proper colorization.

Method Summary

Modifier and Type	Method	Description
static Color	blendColors(Color color1, Color color2)	Blends two colors.
static Color	blendWeightedColors(Color color1, Color color2, double weight1, double weight2)	Blends two colors using weights that have to be greater then zero.
static String	colorAsRGBAHex(Color color, int alpha)	Provides the RGBA hex string of the passed color.
static String	colorAsRGBHex(Color color)	Provides the RGB hex string of the passed color.
boolean	containsColorId(ColorId colorId)	Checks whether the provider contains display colors for the passed id.
ColorProvider.DisplayColors	getBlendedDisplayColors(double weightFirst, double weightSecond, ColorId first, ColorId second)	Gets the blended display colors in dependence of the passed weights for each colors.
ColorProvider.DisplayColors	getDisplayColorsOf(ColorId colorId)	Returns the display colors for the passed id.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COLOR

public static final ColorProvider.DisplayColors DEFAULT_COLOR

Default color that is provided if no color is found in order to guarantee a proper colorization.

Method Detail

blendColors

public static Color blendColors(Color color1,
                                Color color2)

Blends two colors.

Parameters:

color1 - The first color

color2 - The second color

Returns:

the blended color

blendWeightedColors

public static Color blendWeightedColors(@NonNull
                                        Color color1,
                                        @NonNull
                                        Color color2,
                                        double weight1,
                                        double weight2)

Blends two colors using weights that have to be greater then zero.

Parameters:

color1 - The first color

color2 - The second color

weight1 - The weight of the first color

weight2 - The weight of the second color

Returns:

the blended color

colorAsRGBAHex

public static String colorAsRGBAHex(Color color,
                                    int alpha)

Provides the RGBA hex string of the passed color.

Parameters:

color - The Color

alpha - The alpha value within the range [0;255]

Returns:

the color as a hex string

colorAsRGBHex

public static String colorAsRGBHex(Color color)

Provides the RGB hex string of the passed color.

Parameters:

color - The Color

Returns:

the color as a hex string

getDisplayColorsOf

public ColorProvider.DisplayColors getDisplayColorsOf(ColorId colorId)

Returns the display colors for the passed id.

Parameters:

colorId - The ID of the fill color

Returns:

the display colors or the default color if no color has been found

containsColorId

public boolean containsColorId(ColorId colorId)

Checks whether the provider contains display colors for the passed id.

Parameters:

colorId - The color id that should be checked

Returns:

true whether the id is available, else false

getBlendedDisplayColors

public ColorProvider.DisplayColors getBlendedDisplayColors(double weightFirst,
                                                           double weightSecond,
                                                           ColorId first,
                                                           ColorId second)

Gets the blended display colors in dependence of the passed weights for each colors.

Parameters:

weightFirst - The weight of the first colors

weightSecond - The weight of the second colors

first - The first display colors

second - The second display colors

Returns:

the blended display colors or the DEFAULT_COLOR if one color has not been found