Package it.bancaditalia.oss.vtl.config
Interface VTLProperty
-
- All Known Implementing Classes:
VTLGeneralProperties
,VTLPropertyImpl
public interface VTLProperty
This interface provides access to the configuration properties of the VTL Engine components. Each property has a default initial value, that can be overriden by setting a value for the linked system property.- Author:
- Valentino Pinna
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
addValues(String... newValues)
Add new values to this property.String
getDescription()
String
getName()
String
getPlaceholder()
String
getValue()
default List<String>
getValues()
boolean
hasValue()
boolean
isMultiple()
boolean
isRequired()
void
setValue(String newValue)
Change the value for this propertydefault void
setValues(String... newValues)
Change the values for this property.
-
-
-
Method Detail
-
getName
String getName()
- Returns:
- The name of the system property that provides a starting value
-
getValue
String getValue()
- Returns:
- The current value for this property
-
setValue
void setValue(String newValue)
Change the value for this property- Parameters:
newValue
- The new value for this property
-
getDescription
String getDescription()
- Returns:
- A description of the property
-
getPlaceholder
String getPlaceholder()
- Returns:
- A placeholder for the property that can be used as a hint for the property contents
-
isMultiple
boolean isMultiple()
- Returns:
true
if the property allows multiple values
-
isRequired
boolean isRequired()
- Returns:
true
if the property must have a value set before using the component
-
getValues
default List<String> getValues()
- Returns:
- If the property
isMultiple()
, aList
where the elements match each of this property's values
-
setValues
default void setValues(String... newValues)
Change the values for this property. If the property is not multiple, behaviour is undefined- Parameters:
newValues
- The new values for this property
-
hasValue
boolean hasValue()
- Returns:
true
if a value was set for this property or it has a default value
-
addValues
default void addValues(String... newValues)
Add new values to this property. If the property is not multiple, behaviour is undefined- Parameters:
newValues
- The new values to add to existing values of this property
-
-