com.dukascopy.api.indicators

Class IntegerListDescription

java.lang.Object

com.dukascopy.api.indicators.IntegerListDescription

All Implemented Interfaces:

OptInputDescription

public class IntegerListDescription
extends Object
implements OptInputDescription

Describes optional input as list of values

Author:

Dmitry Shohov

Constructor Summary

Constructors

Constructor and Description
IntegerListDescription() Creates object without setting any field
IntegerListDescription(int defaultValue, int[] values, String[] valueNames) Creates object and sets all the fields

Method Summary

Methods

Modifier and Type	Method and Description
int	getDefaultValue() Returns default value, that is used if user doesn't set optional input
Object	getOptInputDefaultValue() Returns parameter's default value
String[]	getValueNames() Returns names of the every value in array
int[]	getValues() Returns array of the values, that user can set
void	setDefaultValue(int defaultValue) Sets default value, that is used if user doesn't set optional input
void	setValueNames(String[] valueNames) Sets value names
void	setValues(int[] 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

IntegerListDescription

public IntegerListDescription()

Creates object without setting any field

IntegerListDescription

public IntegerListDescription(int defaultValue,
                      int[] values,
                      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 integers

valueNames - name of every value

Method Detail

getDefaultValue

public int getDefaultValue()

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

Returns:

default value

setDefaultValue

public void setDefaultValue(int defaultValue)

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

Parameters:

defaultValue - default value

getValues

public int[] getValues()

Returns array of the values, that user can set

Returns:

array of the values, that user can set

setValues

public void setValues(int[] values)

Sets array of the values, that user can set

Parameters:

values - array of the values, that user can set

getValueNames

public String[] getValueNames()

Returns names of the every value in array

Returns:

names of the every value in array

setValueNames

public void setValueNames(String[] valueNames)

Sets value names

Parameters:

valueNames - value names

getOptInputDefaultValue

public Object getOptInputDefaultValue()

Returns parameter's default value

Specified by:

getOptInputDefaultValue in interface OptInputDescription

Returns:

default value