com.dukascopy.api.indicators
Class IntegerRangeDescription

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

Describes optional input as range of values

Constructor Summary
IntegerRangeDescription()
          Creates object without setting any field
IntegerRangeDescription(int defaultValue, int min, int max, int suggestedIncrement)
          Creates object and sets all the fields
 
Method Summary
 int getDefaultValue()
          Returns default value, that is used if user doesn't set optional input
 int getMax()
          Returns maximal value
 int getMin()
          Returns minimal value
 java.lang.Object getOptInputDefaultValue()
          Returns parameter's default value
 int getSuggestedIncrement()
          Returns suggested step to change this input
 void setDefaultValue(int defaultValue)
          Sets default value, that is used if user doesn't set optional input
 void setMax(int max)
          Sets maximal value
 void setMin(int min)
          Sets minimal value
 void setSuggestedIncrement(int suggestedIncrement)
          Sets suggested step to change this input
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IntegerRangeDescription

public IntegerRangeDescription()
Creates object without setting any field

IntegerRangeDescription

public IntegerRangeDescription(int defaultValue,
                               int min,
                               int max,
                               int suggestedIncrement)
Creates object and sets all the fields

Parameters:
defaultValue - default value, that is user if used doesn't set optional input
min - minimal value
max - maximal value
suggestedIncrement - suggested step to change this input
Method Detail

getOptInputDefaultValue

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

Specified by:
getOptInputDefaultValue in interface OptInputDescription
Returns:
default value

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

getMin

public int getMin()
Returns minimal value

Returns:
minimal value

setMin

public void setMin(int min)
Sets minimal value

Parameters:
min - minimal value

getMax

public int getMax()
Returns maximal value

Returns:
maximal value

setMax

public void setMax(int max)
Sets maximal value

Parameters:
max - maximal value

getSuggestedIncrement

public int getSuggestedIncrement()
Returns suggested step to change this input

Returns:
suggested step to change this input

setSuggestedIncrement

public void setSuggestedIncrement(int suggestedIncrement)
Sets suggested step to change this input

Parameters:
suggestedIncrement - suggested step to change this input