All Superinterfaces:

Comparable, Destroyable, OptionHandler

All Known Subinterfaces:

ColorGradientGeneratorWithFixedNumberOfColors

All Known Implementing Classes:

AbstractColorGradientGenerator, BiColorGenerator, ColorProviderBasedColorGradientGenerator, ConfusionMatrixColorGenerator, MultiColorGenerator
```
public interface ColorGradientGenerator
extends OptionHandler, Comparable
```
Interface for classes that generate color gradients.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`compareTo(Object o)`	Compares this object with the specified object for order.
`boolean`	`equals(Object o)`	Returns whether the two objects are the same.
`Color[]`	`generate()`	Generates the color gradients.
`ColorGradientGenerator`	`shallowCopy()`	Returns a shallow copy of itself, i.e., based on the commandline options.
`ColorGradientGenerator`	`shallowCopy(boolean expand)`	Returns a shallow copy of itself, i.e., based on the commandline options.

Methods inherited from interface adams.core.Destroyable
destroy

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

- Method Detail
  - generate
```
Color[] generate()
```
    Generates the color gradients.
    
    Returns:
    
    the colors
  - compareTo
```
int compareTo(Object o)
```
    Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    Only compares the commandlines of the two objects.
    
    Specified by:
    
    compareTo in interface Comparable
    
    Parameters:
    
    o - the object to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    Throws:
    
    ClassCastException - if the specified object's type prevents it from being compared to this object.
  - equals
```
boolean equals(Object o)
```
    Returns whether the two objects are the same.
    
    Only compares the commandlines of the two objects.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the object to be compared
    
    Returns:
    
    true if the object is the same as this one
  - shallowCopy
```
ColorGradientGenerator shallowCopy()
```
    Returns a shallow copy of itself, i.e., based on the commandline options.
    
    Returns:
    
    the shallow copy
  - shallowCopy
```
ColorGradientGenerator shallowCopy(boolean expand)
```
    Returns a shallow copy of itself, i.e., based on the commandline options.
    
    Parameters:
    
    expand - whether to expand variables to their current values
    
    Returns:
    
    the shallow copy

Interface ColorGradientGenerator

Method Summary

Methods inherited from interface adams.core.Destroyable

Methods inherited from interface adams.core.option.OptionHandler

Method Detail

generate

compareTo

equals

shallowCopy

shallowCopy