com.dukascopy.api.indicators
Class OptInputParameterInfo

java.lang.Object
  extended by com.dukascopy.api.indicators.OptInputParameterInfo

public class OptInputParameterInfo
extends java.lang.Object

Describes optional input

Nested Class Summary
static class OptInputParameterInfo.Type
          Type of the optional input
 
Constructor Summary
OptInputParameterInfo()
          Creates descriptor without setting any field
OptInputParameterInfo(java.lang.String name, OptInputParameterInfo.Type type, OptInputDescription description)
          Creates descriptor and sets all the fields
 
Method Summary
 OptInputDescription getDescription()
          Returns object that describes possible values of the optional input
 java.lang.String getName()
          Returns name of the optional input
 OptInputParameterInfo.Type getType()
          Returns type of the optional input
 void setDescription(OptInputDescription description)
          Sets object that describes possible values of the optional input
 void setName(java.lang.String name)
          Sets name of the optional input
 void setType(OptInputParameterInfo.Type type)
          Sets type of the optional input
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OptInputParameterInfo

public OptInputParameterInfo()
Creates descriptor without setting any field

OptInputParameterInfo

public OptInputParameterInfo(java.lang.String name,
                             OptInputParameterInfo.Type type,
                             OptInputDescription description)
Creates descriptor and sets all the fields

Parameters:
name - name of the optional input
type - type of the optional input
description - object that describes possible values of the optional input
See Also:
IntegerListDescription, IntegerRangeDescription, DoubleListDescription, DoubleRangeDescription
Method Detail

getName

public java.lang.String getName()
Returns name of the optional input

Returns:
name of the optional input

setName

public void setName(java.lang.String name)
Sets name of the optional input

Parameters:
name - name of the optional input

getType

public OptInputParameterInfo.Type getType()
Returns type of the optional input

Returns:
type of the optional input

setType

public void setType(OptInputParameterInfo.Type type)
Sets type of the optional input

Parameters:
type - type of the optional input

getDescription

public OptInputDescription getDescription()
Returns object that describes possible values of the optional input

Returns:
object that describes possible values of the optional input

setDescription

public void setDescription(OptInputDescription description)
Sets object that describes possible values of the optional input

Parameters:
description - object that describes possible values of the optional input