com.dukascopy.api.indicators

Class DoubleListDescription

java.lang.Object

com.dukascopy.api.indicators.DoubleListDescription

All Implemented Interfaces:

OptInputDescription

public class DoubleListDescription
extends java.lang.Object
implements OptInputDescription

Describes optional input as list of values

Author:

Dmitry Shohov

Constructor Summary

Constructors

Constructor and Description
DoubleListDescription() Creates object without setting any field
DoubleListDescription(double defaultValue, double[] values, java.lang.String[] valueNames) Creates object and sets all the fields

Method Summary

Modifier and Type	Method and Description
double	getDefaultValue() Returns default value, that is used if user doesn't set optional input
java.lang.Object	getOptInputDefaultValue() Returns parameter's default value
java.lang.String[]	getValueNames() Returns names of the every value in array
double[]	getValues() Returns array of the values, that user can set
void	setDefaultValue(double defaultValue) Sets default value, that is used if user doesn't set optional input
void	setValueNames(java.lang.String[] valueNames) Sets value names
void	setValues(double[] values) Sets array of the values, that user can set

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DoubleListDescription

public DoubleListDescription()

Creates object without setting any field

DoubleListDescription

public DoubleListDescription(double defaultValue,
                             double[] values,
                             java.lang.String[] valueNames)

Creates object and sets all the fields

Parameters:

defaultValue - default value, that is used if user doesn't set optional input

values - array of the values as doubles

valueNames - name of every value

Method Detail

getDefaultValue

public double getDefaultValue()

Returns default value, that is used if user doesn't set optional input

Returns:

default value

setDefaultValue

public void setDefaultValue(double defaultValue)

Sets default value, that is used if user doesn't set optional input

Parameters:

defaultValue - default value

getValues

public double[] getValues()

Returns array of the values, that user can set

Returns:

array of the values, that user can set

setValues

public void setValues(double[] values)

Sets array of the values, that user can set

Parameters:

values - array of the values, that user can set

getValueNames

public java.lang.String[] getValueNames()

Returns names of the every value in array

Returns:

names of the every value in array

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