Key (Charba - GWT Charts library based on CHART.JS)

All Known Subinterfaces:

ColorScheme, IsFill, IsShape, IsTooltipPosition, Type

All Known Implementing Classes:

AbsoluteDatasetIndexFill, Align, Align, Anchor, AxisType, BorderAlign, BorderSkipped, CapStyle, CartesianAxisType, CharacterShape, ChartEventProperty, ChartType, ControllerType, CubicInterpolationMode, CustomTooltipPosition, Dataset.Property, DataType, DefaultPlugin, Display, Easing, Event, Event, Fill, Filler.Property, FillingMode, FontStyle, GradientOrientation, GradientScope, GradientType, Id, ImageShape, InteractionAxis, InteractionMode, JoinStyle, LegendAlign, LegendEventProperty, MeterDisplay, PluginOptionsScope, PointerElement, PointStyle, Position, Position, RelativeDatasetIndexFill, Render, Render, ScaleBounds, ScaleDistribution, SchemeScope, Shape, StandardKey, SteppedLine, TextAlign, TextAlign, TextDirection, TickSource, TimeUnit, TooltipPosition, Weight
```
public interface Key
```
Represents the property key of a JavaScript object.
Used for enum.

Author:

Andrea "Stock" Stocchero

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static void`	`checkIfValid(Key key)` Checks if key passed as argument is not `null` and its value is not `null` as well.
`static int`	`compare(Key k1, Key k2)` Compares the two specified key values.
`static Key`	`create(String key)` Returns a key instance by its string value.
`static boolean`	`equals(Key k1, Key k2)` Returns `true` if the keys have got the same value.
`static <T extends Key> T`	`getKeyByValue(Class<T> clazz, String value)` Returns a key into an enumeration by the value.
`static <T extends Key> T`	`getKeyByValue(Class<T> clazz, String value, T defaultKey)` Returns a key into an enumeration by the value, or the default key passed as argument.
`static <T extends Key> boolean`	`hasKeyByValue(Class<T> clazz, String value)` Returns `true` if a key into an enumeration is related to the value, otherwise `false`.
`static boolean`	`isValid(Key key)` Returns `true` if key passed as argument is not `null` and its value is not `null` as well.
`String`	`value()` Returns the name value of property

- Method Detail
  - create
```
static Key create(String key)
```
    Returns a key instance by its string value.
    
    Parameters:
    
    key - string value to use
    
    Returns:
    
    a standard key instance
  - isValid
```
static boolean isValid(Key key)
```
    Returns true if key passed as argument is not null and its value is not null as well.
    
    Parameters:
    
    key - key to be checked
    
    Returns:
    
    true if key passed as argument is not null and its value is not null as well.
  - checkIfValid
```
static void checkIfValid(Key key)
```
    Checks if key passed as argument is not null and its value is not null as well. If not, throw a IllegalArgumentException.
    
    Parameters:
    
    key - key to be checked
  - hasKeyByValue
```
static <T extends Key> boolean hasKeyByValue(Class<T> clazz,
                                             String value)
```
    Returns true if a key into an enumeration is related to the value, otherwise false.
    
    Type Parameters:
    
    T - type of key
    
    Parameters:
    
    clazz - enumeration of keys
    
    value - value to search into key
    
    Returns:
    
    true if a key into an enumeration is related to the value, otherwise false
  - getKeyByValue
```
static <T extends Key> T getKeyByValue(Class<T> clazz,
                                       String value)
```
    Returns a key into an enumeration by the value.
    
    Type Parameters:
    
    T - type of key
    
    Parameters:
    
    clazz - enumeration of keys
    
    value - value to search into key
    
    Returns:
    
    the found key by value or null
  - getKeyByValue
```
static <T extends Key> T getKeyByValue(Class<T> clazz,
                                       String value,
                                       T defaultKey)
```
    Returns a key into an enumeration by the value, or the default key passed as argument.
    
    Type Parameters:
    
    T - type of key
    
    Parameters:
    
    clazz - enumeration of keys
    
    value - value to search into key
    
    defaultKey - default key instance if the value is not found
    
    Returns:
    
    the found key by value or the default one
  - compare
```
static int compare(Key k1,
                   Key k2)
```
    Compares the two specified key values.
    
    Parameters:
    
    k1 - the first key to compare
    
    k2 - the second key to compare
    
    Returns:
    
    the value 0 if k1 value is equal to k2; a value less than 0 if k1 value is less than k2; and a value greater than 0 if k1 value is greater than k2.
  - equals
```
static boolean equals(Key k1,
                      Key k2)
```
    Returns true if the keys have got the same value.
    
    Parameters:
    
    k1 - the first key to compare
    
    k2 - the second key to compare
    
    Returns:
    
    true if the keys have got the same value
  - value
```
String value()
```
    Returns the name value of property
    
    Returns:
    
    the name value of property

Interface Key

Method Summary

Method Detail

create

isValid

checkIfValid

hasKeyByValue

getKeyByValue

getKeyByValue

compare

equals

value