Color (JBotSim Project documentation)

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

public class Color
extends java.lang.Object

* Original code AWT

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)`
`Color(int value)`
`Color(int value, boolean hasalpha)`
`Color(int r, int g, int b)`
`Color(int r, int g, int b, int a)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Color`	`brighter()`
`Color`	`darker()`
`static Color`	`decode(java.lang.String nm)`
`boolean`	`equals(java.lang.Object obj)`
`int`	`getAlpha()`
`int`	`getBlue()`
`static Color`	`getColor(java.lang.String nm)`
`static Color`	`getColor(java.lang.String nm, Color v)`
`static Color`	`getColor(java.lang.String nm, int v)`
`static Color`	`getColorAt(java.lang.Integer colorIndex)` Returns the `Color` associated to the provided index.
`int`	`getGreen()`
`static java.util.List<Color>`	`getIndexedColors()`
`static Color`	`getRandomColor()`
`static Color`	`getRandomColor(java.util.Random random)` Returns a `Color` object generated using 3 calls to the provided `Random` object.
`int`	`getRed()`
`int`	`getRGB()`
`int`	`hashCode()`
`static int`	`indexOf(Color color)` Searches for the color index associated with the current `Color`.
`void`	`testColorValueRange(float r, float g, float b, float a)`
`void`	`testColorValueRange(int r, int g, int b, int a)`

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

Field Detail

white
```
public static Color white
```

WHITE
```
public static Color WHITE
```

lightGray
```
public static Color lightGray
```

LIGHT_GRAY
```
public static Color LIGHT_GRAY
```

gray
```
public static Color gray
```

GRAY
```
public static Color GRAY
```

darkGray
```
public static Color darkGray
```

DARK_GRAY
```
public static Color DARK_GRAY
```

black
```
public static Color black
```

BLACK
```
public static Color BLACK
```

red
```
public static Color red
```

RED
```
public static Color RED
```

pink
```
public static Color pink
```

PINK
```
public static Color PINK
```

orange
```
public static Color orange
```

ORANGE
```
public static Color ORANGE
```

yellow
```
public static Color yellow
```

YELLOW
```
public static Color YELLOW
```

green
```
public static Color green
```

GREEN
```
public static Color GREEN
```

magenta
```
public static Color magenta
```

MAGENTA
```
public static Color MAGENTA
```

cyan
```
public static Color cyan
```

CYAN
```
public static Color CYAN
```

blue
```
public static Color blue
```

BLUE
```
public static Color BLUE
```

Constructor Detail

Color

public Color(int r,
             int g,
             int b,
             int a)

Color

public Color(int r,
             int g,
             int b)

Color
```
public Color(int value)
```

Color

public Color(int value,
             boolean hasalpha)

Color
```
public Color(Color color)
```

Method Detail

getRed
```
public int getRed()
```

getGreen
```
public int getGreen()
```

getBlue
```
public int getBlue()
```

getAlpha
```
public int getAlpha()
```

getRGB
```
public int getRGB()
```

getIndexedColors

public static java.util.List<Color> getIndexedColors()

testColorValueRange

public void testColorValueRange(int r,
                                int g,
                                int b,
                                int a)

testColorValueRange

public void testColorValueRange(float r,
                                float g,
                                float b,
                                float a)

decode

public static Color decode(java.lang.String nm)
                    throws java.lang.NumberFormatException

Throws:: java.lang.NumberFormatException

getColor

public static Color getColor(java.lang.String nm)

getColor

public static Color getColor(java.lang.String nm,
                             Color v)

getColor

public static Color getColor(java.lang.String nm,
                             int v)

brighter
```
public Color brighter()
```

darker
```
public Color darker()
```

getColorAt
```
public static Color getColorAt(java.lang.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.

indexOf
```
public static int indexOf(Color color)
```
Searches for the color index associated with the current Color.

Parameters:

color - the Color to be searched for.

Returns:

the associated color index. -1 if not found.

getRandomColor
```
public static Color getRandomColor(java.util.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.

getRandomColor
```
public static Color getRandomColor()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class java.lang.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

testColorValueRange

testColorValueRange

decode

getColor

getColor

getColor

brighter

darker

getColorAt

indexOf

getRandomColor

getRandomColor

hashCode

equals