Color (JBotSim Project documentation)

java.lang.Object
- io.jbotsim.core.Color

```
public class Color
extends Object
```
JBotSim's Color representation.

Note: This class is strongly inspired from Java AWT's. Indeed, it is a remnant from JBotSim's pre-1.0.0 tight coupling to Java AWT/Spring.

Field Summary

Fields
Modifier and Type	Field and Description
`static Color`	`black`
`static Color`	`BLACK`
`static Color`	`blue`
`static Color`	`BLUE`
`static Color`	`cyan`
`static Color`	`CYAN`
`static Color`	`DARK_GRAY`
`static Color`	`darkGray`
`static Color`	`gray`
`static Color`	`GRAY`
`static Color`	`green`
`static Color`	`GREEN`
`static Color`	`LIGHT_GRAY`
`static Color`	`lightGray`
`static Color`	`magenta`
`static Color`	`MAGENTA`
`static Color`	`orange`
`static Color`	`ORANGE`
`static Color`	`pink`
`static Color`	`PINK`
`static Color`	`red`
`static Color`	`RED`
`static Color`	`white`
`static Color`	`WHITE`
`static Color`	`yellow`
`static Color`	`YELLOW`

Constructor Summary

Constructors
Constructor and Description
`Color(Color color)` Copy constructor.
`Color(int value)` Creates an opaque RGB (no alpha component) color from the provided integer representation.
`Color(int value, boolean hasalpha)` Creates a RGB color from the provided integer representation.
`Color(int r, int g, int b)` Creates an opaque RGB (no alpha component) color from the provided integer representation.
`Color(int r, int g, int b, int a)` Creates a RGBA color from the provided integer representation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Color`	`brighter()` Creates a new `Color` that is a brighter version of this `Color`.
`Color`	`darker()` Creates a new `Color` that is a darker version of this `Color`.
`static Color`	`decode(String colorValue)` Converts a `String` to an integer and returns the specified opaque `Color`.
`boolean`	`equals(Object obj)`
`int`	`getAlpha()` Gets the alpha component.
`int`	`getBlue()` Gets the blue component in the default sRGB space.
`static Color`	`getColor(String name)` Finds a RGB color in the system properties.
`static Color`	`getColor(String name, Color defaultValue)` Finds a RGB color in the system properties.
`static Color`	`getColor(String name, int defaultValue)` Finds a RGB color in the system properties.
`static Color`	`getColorAt(Integer colorIndex)` Returns the `Color` associated to the provided index.
`int`	`getGreen()` Gets the green component in the default sRGB space.
`static List<Color>`	`getIndexedColors()` Returns the list of currently indexed `Color`s.
`static Color`	`getRandomColor()` Returns a randomly generated `Color` object.
`static Color`	`getRandomColor(Random random)` Returns a `Color` object generated using 3 calls to the provided `Random` object.
`int`	`getRed()` Gets the red component in the default sRGB space.
`int`	`getRGB()` Gets the RGB value representing the color.
`int`	`hashCode()`
`static int`	`indexOf(Color color)` Searches for the color index associated with the current `Color`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - white
```
public static final Color white
```
  - WHITE
```
public static final Color WHITE
```
  - lightGray
```
public static final Color lightGray
```
  - LIGHT_GRAY
```
public static final Color LIGHT_GRAY
```
  - gray
```
public static final Color gray
```
  - GRAY
```
public static final Color GRAY
```
  - darkGray
```
public static final Color darkGray
```
  - DARK_GRAY
```
public static final Color DARK_GRAY
```
  - black
```
public static final Color black
```
  - BLACK
```
public static final Color BLACK
```
  - red
```
public static final Color red
```
  - RED
```
public static final Color RED
```
  - pink
```
public static final Color pink
```
  - PINK
```
public static final Color PINK
```
  - orange
```
public static final Color orange
```
  - ORANGE
```
public static final Color ORANGE
```
  - yellow
```
public static final Color yellow
```
  - YELLOW
```
public static final Color YELLOW
```
  - green
```
public static final Color green
```
  - GREEN
```
public static final Color GREEN
```
  - magenta
```
public static final Color magenta
```
  - MAGENTA
```
public static final Color MAGENTA
```
  - cyan
```
public static final Color cyan
```
  - CYAN
```
public static final Color CYAN
```
  - blue
```
public static final Color blue
```
  - BLUE
```
public static final Color BLUE
```
- Constructor Detail
  - Color
```
public Color(int r,
             int g,
             int b,
             int a)
```
    Creates a RGBA color from the provided integer representation.
    
    Parameters:
    
    r - value of the red component, as a [0,255] integer.
    
    g - value of the green component, as a [0,255] integer.
    
    b - value of the blue component, as a [0,255] integer.
    
    a - value of the alpha component, as a [0,255] integer.
  - Color
```
public Color(int r,
             int g,
             int b)
```
    Creates an opaque RGB (no alpha component) color from the provided integer representation.
    
    Parameters:
    
    r - value of the red component, as a [0,255] integer.
    
    g - value of the green component, as a [0,255] integer.
    
    b - value of the blue component, as a [0,255] integer.
  - Color
```
public Color(int value)
```
    Creates an opaque RGB (no alpha component) color from the provided integer representation.
    
    Parameters:
    
    value - the combined RGB component, as an integer.
  - Color
```
public Color(int value,
             boolean hasalpha)
```
    Creates a RGB color from the provided integer representation.
    
    Parameters:
    
    value - the combined RGBA component, as an integer.
    
    hasalpha - true if the alpha component should be taken into account.
  - Color
```
public Color(Color color)
```
    Copy constructor.
    
    Parameters:
    
    color - the Color to be copied.
- Method Detail
  - getRed
```
public int getRed()
```
    Gets the red component in the default sRGB space.
    
    Returns:
    
    the red component, a [0,255] integer.
  - getGreen
```
public int getGreen()
```
    Gets the green component in the default sRGB space.
    
    Returns:
    
    the green component, a [0,255] integer.
  - getBlue
```
public int getBlue()
```
    Gets the blue component in the default sRGB space.
    
    Returns:
    
    the blue component, a [0,255] integer.
  - getAlpha
```
public int getAlpha()
```
    Gets the alpha component.
    
    Returns:
    
    the alpha component, a [0,255] integer.
  - getRGB
```
public int getRGB()
```
    Gets the RGB value representing the color.
    
    Returns:
    
    the RGB value.
  - getIndexedColors
```
public static List<Color> getIndexedColors()
```
    Returns the list of currently indexed Colors.
    
    Returns:
    
    the list of currently indexed Colors.
    
    See Also:
    
    indexOf(Color), getColorAt(Integer)
  - decode
```
public static Color decode(String colorValue)
                    throws NumberFormatException
```
    Converts a String to an integer and returns the specified opaque Color.
    
    This method handles string formats that are used to represent octal and hexadecimal numbers.
    
    Parameters:
    
    colorValue - a String that represents an opaque color as a 24-bit integer
    
    Returns:
    
    the new Color object.
    
    Throws:
    
    NumberFormatException - if the specified string cannot be interpreted as a decimal, octal, or hexadecimal integer.
    
    See Also:
    
    Integer.decode(java.lang.String)
  - getColor
```
public static Color getColor(String name)
```
    Finds a RGB color in the system properties.
    
    The argument is treated as the name of a system property to be obtained. The string value of this property is then interpreted as an integer which is then converted to a Color object.
    
    If the specified property is not found or could not be parsed as an integer then null is returned.
    
    Parameters:
    
    name - the name of the color property.
    
    Returns:
    
    the Color converted from the system property.
    
    See Also:
    
    System.getProperty(java.lang.String), Integer.getInteger(java.lang.String), Color(int)
  - getColor
```
public static Color getColor(String name,
                             Color defaultValue)
```
    Finds a RGB color in the system properties.
    
    The first argument is treated as the name of a system property to be obtained. The string value of this property is then interpreted as an integer which is then converted to a Color object.
    
    If the specified property is not found or could not be parsed as an integer then the Color defaultValue is used instead.
    
    Parameters:
    
    name - the name of the color property.
    
    defaultValue - the default color value, a Color object.
    
    Returns:
    
    the Color converted from the system property or the Color converted from the specified integer.
    
    See Also:
    
    System.getProperty(java.lang.String), Integer.getInteger(java.lang.String), Color(int)
  - getColor
```
public static Color getColor(String name,
                             int defaultValue)
```
    Finds a RGB color in the system properties.
    
    The first argument is treated as the name of a system property to be obtained. The string value of this property is then interpreted as an integer which is then converted to a Color object.
    
    If the specified property is not found or could not be parsed as an integer then the integer value defaultValue is used instead, and is converted to a Color object.
    
    Parameters:
    
    name - the name of the color property
    
    defaultValue - the default color value, as an integer
    
    Returns:
    
    the Color converted from the system property or the Color converted from the specified integer.
    
    See Also:
    
    System.getProperty(java.lang.String), Integer.getInteger(java.lang.String), Color(int)
  - brighter
```
public Color brighter()
```
    Creates a new Color that is a brighter version of this Color.
    
    This method applies an arbitrary scale factor to each of the three RGB components of this Color to create a brighter version of this Color. The alpha value is preserved.
    
    Although brighter() and darker() are inverse operations, the results of a series of invocations of these two methods might be inconsistent because of rounding errors.
    
    Returns:
    
    a new Color object that is a brighter version of this Color with the same alpha value.
    
    See Also:
    
    darker()
  - darker
```
public Color darker()
```
    Creates a new Color that is a darker version of this Color.
    
    This method applies an arbitrary scale factor to each of the three RGB components of this Color to create a darker version of this Color. The alpha value is preserved.
    
    Although brighter() and darker() are inverse operations, the results of a series of invocations of these two methods might be inconsistent because of rounding errors.
    
    Returns:
    
    a new Color object that is a darker version of this Color with the same alpha value.
    
    See Also:
    
    brighter()
  - getColorAt
```
public static Color getColorAt(Integer colorIndex)
```
    Returns the Color associated to the provided index.
    
    The Color returned for a specific index will remain the same across instances.
    
    This method is typically used to associate a Color to an identifier. Missing Colors are thus generated (from 0 to intColor) on demand, and stored for later use.
    
    Parameters:
    
    colorIndex - the index of the Color.
    
    Returns:
    
    the Color associated to the provided index.
    
    See Also:
    
    indexOf(Color), getIndexedColors()
  - indexOf
```
public static int indexOf(Color color)
```
    Searches for the color index associated with the current Color.
    
    Only already generated and indexed Colors can be found.
    
    Parameters:
    
    color - the Color to be searched for.
    
    Returns:
    
    the associated color index. -1 if not found.
    
    See Also:
    
    getColorAt(Integer), getIndexedColors()
  - getRandomColor
```
public static Color getRandomColor(Random random)
```
    Returns a Color object generated using 3 calls to the provided Random object.
    
    If the provided random is null, the result of getRandomColor() is returned.
    
    Parameters:
    
    random - a Random object to be used. Can be null.
    
    Returns:
    
    the generated Color object.
    
    See Also:
    
    getRandomColor()
  - getRandomColor
```
public static Color getRandomColor()
```
    Returns a randomly generated Color object.
    
    The Color is created by using 3 calls to Math.random().
    
    Returns:
    
    the generated Color object.
    
    See Also:
    
    getRandomColor(Random)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Color

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

white

WHITE

lightGray

LIGHT_GRAY

gray

GRAY

darkGray

DARK_GRAY

black

BLACK

red

RED

pink

PINK

orange

ORANGE

yellow

YELLOW

green

GREEN

magenta

MAGENTA

cyan

CYAN

blue

BLUE

Constructor Detail

Color

Color

Color

Color

Color

Method Detail

getRed

getGreen

getBlue

getAlpha

getRGB

getIndexedColors

decode

getColor

getColor

getColor

brighter

darker

getColorAt

indexOf

getRandomColor

getRandomColor

hashCode

equals