ColorProvider (adams-pom 25.12.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, OptionHandler, ShallowCopySupporter<ColorProvider>

All Known Subinterfaces:

ColorProviderWithNameSupport

All Known Implementing Classes:

AbstractColorProvider, AbstractCustomColorProvider, ColorBlind12Provider, ColorBlind15Provider, ColorBlind24Provider, ColorBlind8Provider, CustomColorProvider, DefaultColorProvider, FluoroColorProvider, GradientColorProvider, PeriodicityColorProvider, RegExpColorProvider, RgbInNameColorProvider, TranslucentColorProvider, X11ColorProvider
```
public interface ColorProvider
extends OptionHandler, ShallowCopySupporter<ColorProvider>
```
Interface for color providing classes.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`exclude(Color c)`	"Excludes" the specified colors, i.e., makes it unavailable for future use.
`Color[]`	`generate(int numColors)`	Generates the specified number of colors.
`Color`	`next()`	Returns the next color.
`void`	`recycle(Color c)`	"Recycles" the specified colors, i.e., makes it available for future use.
`void`	`resetColors()`	Resets the colors.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.ShallowCopySupporter
shallowCopy, shallowCopy

- Method Detail
  - next
```
Color next()
```
    Returns the next color.
    
    Returns:
    
    the next color
  - resetColors
```
void resetColors()
```
    Resets the colors.
  - recycle
```
void recycle(Color c)
```
    "Recycles" the specified colors, i.e., makes it available for future use.
    
    Parameters:
    
    c - the color to re-use
  - exclude
```
void exclude(Color c)
```
    "Excludes" the specified colors, i.e., makes it unavailable for future use.
    
    Parameters:
    
    c - the color to exclude
  - generate
```
Color[] generate(int numColors)
```
    Generates the specified number of colors.
    
    Parameters:
    
    numColors - the number of colors
    
    Returns:
    
    the colors