- java.lang.Object
-
- com.powsybl.commons.parameters.Parameter
-
public class Parameter extends Object
- Author:
- Geoffroy Jamgotchian
-
-
Constructor Summary
Constructors Constructor Description Parameter(String name, ParameterType type, String description, Object defaultValue)
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)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Parameter
addAdditionalNames(String... names)
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 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)
-
-
-
Constructor Detail
-
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, List<Object> possibleValues)
-
Parameter
public Parameter(String name, ParameterType type, String description, Object defaultValue)
-
-
Method Detail
-
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)
-
readDouble
public static double readDouble(String prefix, Properties parameters, Parameter configuredParameter)
-
getName
public String getName()
-
getType
public ParameterType getType()
-
getDescription
public String getDescription()
-
getDefaultValue
public Object getDefaultValue()
-
getScope
public ParameterScope getScope()
-
-