Object
Colors
- All Implemented Interfaces:
Serializable
,Cloneable
The colors to use for formatting Well Known Text (WKT) objects.
Colors are identified by their names and can be mapped to
ElementKind
.
The currently supported color names are:
"red"
,"green"
,"yellow"
,"blue"
,"magenta"
,"cyan"
,"gray"
.
- Since:
- 0.4
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Colors
The default colors used byFormattableObject.print()
.static final Colors
Emphasis on identification information (name and identifiers) only. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns a clone of thisColors
.boolean
Compares thisColors
with the given object for equality.final String
getName
(ElementKind key) Returns the color for the given syntactic element.int
Returns a hash code value for this object.void
setName
(ElementKind key, String color) Sets the color of the given syntactic element from a color name.
-
Field Details
-
DEFAULT
The default colors used byFormattableObject.print()
. Those colors give better results on aConsole
with black background. This map is immutable.- See Also:
-
NAMING
Emphasis on identification information (name and identifiers) only. This map is immutable.
-
-
Constructor Details
-
Colors
public Colors()Creates a new, initially empty, set of colors. -
Colors
Creates a new set of colors initialized to a copy of the given one.- Parameters:
colors
- the set of colors to copy.
-
-
Method Details
-
setName
Sets the color of the given syntactic element from a color name. The color names supported in the current implementation are"red"
,"green"
,"yellow"
,"blue"
,"magenta"
,"cyan"
and"gray"
, case-insensitive.- Parameters:
key
- the syntactic element for which to set the color.color
- the color to give to the specified element, ornull
if none.- Throws:
IllegalArgumentException
- if the given color name is not recognized.UnsupportedOperationException
- if thisColors
instance is immutable.
-
getName
Returns the color for the given syntactic element.- Parameters:
key
- the syntactic element for which to get the color.- Returns:
- the color of the specified element, or
null
if none.
-
clone
Returns a clone of thisColors
. -
equals
Compares thisColors
with the given object for equality. -
hashCode
public int hashCode()Returns a hash code value for this object.
-