Package io.jenkins.plugins.coverage.metrics.color

Class ColorProviderFactory

java.lang.Object

io.jenkins.plugins.coverage.metrics.color.ColorProviderFactory

public final class ColorProviderFactory
extends Object

Provides factory methods for creating different color providers.

Author:

Florian Orendi

Method Summary

Modifier and Type	Method	Description
static ColorProvider	createColorProvider(Map<String,String> colors)	Creates a color provider which uses the set Jenkins colors.
static ColorProvider	createDefaultColorProvider()	Creates a color provider which uses the internal color palette.

Methods inherited from class java.lang.Object

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

Method Details

createDefaultColorProvider

public static ColorProvider createDefaultColorProvider()

Creates a color provider which uses the internal color palette.

Returns:

the created color provider

createColorProvider

public static ColorProvider createColorProvider(Map<String,String> colors)

Creates a color provider which uses the set Jenkins colors. Required color keys are: '--green', '--light-green', '--yellow', '--light-yellow', '--orange', '--light-orange', '--red', '--light-red' - see CoverageColorJenkinsId. If colors are missing, the internal default colors are used - see CoverageColorPalette.

Parameters:

colors - Maps jenkins color IDs

Returns:

the created color provider