com.dukascopy.api.indicators
Class ColorListDescription

java.lang.Object
  extended by com.dukascopy.api.indicators.ColorListDescription
All Implemented Interfaces:
OptInputDescription
public class ColorListDescription
extends java.lang.Object
implements OptInputDescription

Describes optional input as a list of values

Constructor Summary
ColorListDescription()
          Creates an object without setting any field
ColorListDescription(java.awt.Color defaultValue, java.awt.Color[] values, java.lang.String[] valueNames)
          Creates an object and sets all the fields
 
Method Summary
 java.awt.Color getDefaultValue()
          Returns the default value
 java.lang.Object getOptInputDefaultValue()
          Returns parameter's default value
 java.lang.String[] getValueNames()
          Returns an array of value names
 java.awt.Color[] getValues()
          Returns an array of values
 void setDefaultValue(java.awt.Color defaultValue)
          Sets the default value
 void setValueNames(java.lang.String[] valueNames)
          Sets value names
 void setValues(java.awt.Color[] values)
          Sets an array of values
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ColorListDescription

public ColorListDescription()
Creates an object without setting any field

ColorListDescription

public ColorListDescription(java.awt.Color defaultValue,
                            java.awt.Color[] values,
                            java.lang.String[] valueNames)
Creates an object and sets all the fields

Parameters:
defaultValue - default value that is used when optional input is not set
values - an array of values of type Color
valueNames - name of every value
Method Detail

getDefaultValue

public java.awt.Color getDefaultValue()
Returns the default value

Returns:
default value

setDefaultValue

public void setDefaultValue(java.awt.Color defaultValue)
Sets the default value

Parameters:
defaultValue - default value

getValues

public java.awt.Color[] getValues()
Returns an array of values

Returns:
array of values

setValues

public void setValues(java.awt.Color[] values)
Sets an array of values

Parameters:
values - array of values

getValueNames

public java.lang.String[] getValueNames()
Returns an array of value names

Returns:
array of value names

setValueNames

public void setValueNames(java.lang.String[] valueNames)
Sets value names

Parameters:
valueNames - value names

getOptInputDefaultValue

public java.lang.Object getOptInputDefaultValue()
Returns parameter's default value

Specified by:
getOptInputDefaultValue in interface OptInputDescription
Returns:
default value