Package com.powsybl.commons.parameters

Class Parameter

java.lang.Object

com.powsybl.commons.parameters.Parameter

Direct Known Subclasses:

ConfiguredParameter

public class Parameter
extends Object

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Constructor Summary

Constructors

Constructor	Description
Parameter(String name, ParameterType type, String description, Object defaultValue)
Parameter(String name, ParameterType type, String description, Object defaultValue, ParameterScope scope, String categoryKey)
Parameter(String name, ParameterType type, String description, Object defaultValue, List<Object> possibleValues)
Parameter(String name, ParameterType type, String description, Object defaultValue, List<Object> possibleValues, ParameterScope scope)
Parameter(String name, ParameterType type, String description, Object defaultValue, List<Object> possibleValues, ParameterScope scope, String categoryKey)
Parameter(List<String> names, ParameterType type, String description, Object defaultValue, List<Object> possibleValues, ParameterScope scope, String categoryKey)

Method Summary

Modifier and Type	Method	Description
Parameter	addAdditionalNames(String... names)
String	getCategoryKey()
Object	getDefaultValue()
String	getDescription()
String	getName()
List<String>	getNames()
List<Object>	getPossibleValues()
ParameterScope	getScope()
ParameterType	getType()
static Object	read(String prefix, Properties paramaters, Parameter configuredParameter)
static Object	read(String prefix, Properties parameters, Parameter configuredParameter, ParameterDefaultValueConfig defaultValueConfig)
static boolean	readBoolean(String prefix, Properties parameters, Parameter configuredParameter)
static boolean	readBoolean(String prefix, Properties parameters, Parameter configuredParameter, ParameterDefaultValueConfig defaultValueConfig)
static double	readDouble(String prefix, Properties parameters, Parameter configuredParameter)
static double	readDouble(String prefix, Properties parameters, Parameter configuredParameter, ParameterDefaultValueConfig defaultValueConfig)
static int	readInteger(String prefix, Properties parameters, Parameter configuredParameter, ParameterDefaultValueConfig defaultValueConfig)
static String	readString(String prefix, Properties parameters, Parameter configuredParameter)
static String	readString(String prefix, Properties parameters, Parameter configuredParameter, ParameterDefaultValueConfig defaultValueConfig)
static List<String>	readStringList(String prefix, Properties parameters, Parameter configuredParameter)
static List<String>	readStringList(String prefix, Properties parameters, Parameter configuredParameter, ParameterDefaultValueConfig defaultValueConfig)

Methods inherited from class java.lang.Object

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

Constructor Details

Parameter

public Parameter(String name,
 ParameterType type,
 String description,
 Object defaultValue,
 List<Object> possibleValues,
 ParameterScope scope,
 String categoryKey)

Parameter

public Parameter(List<String> names,
 ParameterType type,
 String description,
 Object defaultValue,
 List<Object> possibleValues,
 ParameterScope scope,
 String categoryKey)

Parameter

public Parameter(String name,
 ParameterType type,
 String description,
 Object defaultValue,
 List<Object> possibleValues,
 ParameterScope scope)

Parameter

public Parameter(String name,
 ParameterType type,
 String description,
 Object defaultValue,
 ParameterScope scope,
 String categoryKey)

Parameter

public Parameter(String name,
 ParameterType type,
 String description,
 Object defaultValue,
 List<Object> possibleValues)

Parameter

public Parameter(String name,
 ParameterType type,
 String description,
 Object defaultValue)

Method Details

read

public static Object read(String prefix,
 Properties parameters,
 Parameter configuredParameter,
 ParameterDefaultValueConfig defaultValueConfig)

read

public static Object read(String prefix,
 Properties paramaters,
 Parameter configuredParameter)

readBoolean

public static boolean readBoolean(String prefix,
 Properties parameters,
 Parameter configuredParameter,
 ParameterDefaultValueConfig defaultValueConfig)

readBoolean

public static boolean readBoolean(String prefix,
 Properties parameters,
 Parameter configuredParameter)

readString

public static String readString(String prefix,
 Properties parameters,
 Parameter configuredParameter,
 ParameterDefaultValueConfig defaultValueConfig)

readString

public static String readString(String prefix,
 Properties parameters,
 Parameter configuredParameter)

readStringList

public static List<String> readStringList(String prefix,
 Properties parameters,
 Parameter configuredParameter,
 ParameterDefaultValueConfig defaultValueConfig)

readStringList

public static List<String> readStringList(String prefix,
 Properties parameters,
 Parameter configuredParameter)

readDouble

public static double readDouble(String prefix,
 Properties parameters,
 Parameter configuredParameter,
 ParameterDefaultValueConfig defaultValueConfig)

readInteger

public static int readInteger(String prefix,
 Properties parameters,
 Parameter configuredParameter,
 ParameterDefaultValueConfig defaultValueConfig)

readDouble

public static double readDouble(String prefix,
 Properties parameters,
 Parameter configuredParameter)

addAdditionalNames

public Parameter addAdditionalNames(String... names)

getName

public String getName()

getNames

public List<String> getNames()

getType

public ParameterType getType()

getDescription

public String getDescription()

getDefaultValue

public Object getDefaultValue()

getPossibleValues

public List<Object> getPossibleValues()

getScope

public ParameterScope getScope()

getCategoryKey

public String getCategoryKey()