PACommonProperties (scheduling 14.1.0-SNAPSHOT API)

All Known Implementing Classes:

PAResourceManagerProperties, PASchedulerProperties, PASharedProperties
```
public interface PACommonProperties
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getCmdLine()` Returns the string to be passed on the command line The property surrounded by '-D' and '='
`String`	`getConfigurationDefaultRelativeFilePath()` Returns the default relative path used to store the property file
`String`	`getConfigurationFilePathPropertyName()` Returns the System property name used to store the configuration file path
`String`	`getKey()` Get the key.
`PropertyType`	`getType()` Return the type of the given properties.
`boolean`	`getValueAsBoolean()` Returns the value of this property as a boolean.
`int`	`getValueAsInt()` Returns the value of this property as an integer.
`List<String>`	`getValueAsList(String separator)` Returns the value of this property as a List of strings.
`List<String>`	`getValueAsList(String separator, boolean allowEmpty)` Returns the value of this property as a List of strings.
`long`	`getValueAsLong()` Returns the value of this property as a long integer.
`String`	`getValueAsString()` Returns the value of this property as a string.
`String`	`getValueAsStringOrNull()` Returns the value of this property as a string.
`boolean`	`isSet()` Return true if this property is set or has a default value, false otherwise.
`void`	`loadPropertiesFromFile(String filename)` Load the properties from the given file.
`void`	`reloadConfiguration()` Reload the properties using the default property file configuration This method will clean every loaded properties before.
`void`	`unSet()` Unset this property, if this property has a default value, calling unSet will revert to the default.
`void`	`updateProperty(String value)` Set the value of this property to the given one.

- Method Detail
  - getKey
```
String getKey()
```
    Get the key.
    
    Returns:
    
    the key.
  - updateProperty
```
void updateProperty(String value)
```
    Set the value of this property to the given one.
    
    Parameters:
    
    value - the new value to set.
  - isSet
```
boolean isSet()
```
    Return true if this property is set or has a default value, false otherwise.
    
    Returns:
    
    true if this property is set, false otherwise.
  - unSet
```
void unSet()
```
    Unset this property, if this property has a default value, calling unSet will revert to the default.
  - getCmdLine
```
String getCmdLine()
```
    Returns the string to be passed on the command line The property surrounded by '-D' and '='
    
    Returns:
    
    the string to be passed on the command line
  - getValueAsInt
```
int getValueAsInt()
```
    Returns the value of this property as an integer. If value is not an integer, an exception will be thrown.
    
    Returns:
    
    the value of this property.
  - getValueAsLong
```
long getValueAsLong()
```
    Returns the value of this property as a long integer. If value is not a long integer, an exception will be thrown.
    
    Returns:
    
    the value of this property.
  - getValueAsString
```
String getValueAsString()
```
    Returns the value of this property as a string.
    
    Returns:
    
    the value of this property.
  - getValueAsStringOrNull
```
String getValueAsStringOrNull()
```
    Returns the value of this property as a string. If the property is not defined or empty, then null is returned
    
    Returns:
    
    the value of this property.
  - getValueAsBoolean
```
boolean getValueAsBoolean()
```
    Returns the value of this property as a boolean. If value is not a boolean, an exception will be thrown.
    The behavior of this method is the same as the Boolean.parseBoolean(String s).
    
    Returns:
    
    the value of this property or false if it's not defined.
  - getValueAsList
```
List<String> getValueAsList(String separator)
```
    Returns the value of this property as a List of strings. equivalent of getValueAsList(separator, false)
    
    Parameters:
    
    separator - the separator to use
    
    Returns:
    
    the list of values of this property.
  - getValueAsList
```
List<String> getValueAsList(String separator,
                            boolean allowEmpty)
```
    Returns the value of this property as a List of strings.
    
    Parameters:
    
    separator - the separator to use
    
    allowEmpty - allow empty values in the list
    
    Returns:
    
    the list of values of this property.
  - getType
```
PropertyType getType()
```
    Return the type of the given properties.
    
    Returns:
    
    the type of the given properties.
  - getConfigurationFilePathPropertyName
```
String getConfigurationFilePathPropertyName()
```
    Returns the System property name used to store the configuration file path
    
    Returns:
    
    system property name
  - getConfigurationDefaultRelativeFilePath
```
String getConfigurationDefaultRelativeFilePath()
```
    Returns the default relative path used to store the property file
    
    Returns:
    
    default file path
  - loadPropertiesFromFile
```
void loadPropertiesFromFile(String filename)
```
    Load the properties from the given file. This method will clean every loaded properties before.
    
    Parameters:
    
    filename - the file containing the properties to be loaded.
  - reloadConfiguration
```
void reloadConfiguration()
```
    Reload the properties using the default property file configuration This method will clean every loaded properties before.

Interface PACommonProperties

Method Summary

Method Detail

getKey

updateProperty

isSet

unSet

getCmdLine

getValueAsInt

getValueAsLong

getValueAsString

getValueAsStringOrNull

getValueAsBoolean

getValueAsList

getValueAsList

getType

getConfigurationFilePathPropertyName

getConfigurationDefaultRelativeFilePath

loadPropertiesFromFile

reloadConfiguration