ALox  V. 2402 R. 0
Home ALox for C++ ALox for C# ALox for Java Download
Public Methods | Protected Fields | List of all members
Environment Class Reference
Inheritance diagram for Environment:
[legend]
Collaboration diagram for Environment:
[legend]

Class Description


Specialization of abstract interface class ConfigurationPlugin, retrieves configuration data from the system environment.

Its priority value usually is Configuration.PRIO_ENVIRONMENT, which is higher than Configuration.PRIO_STANDARD but lower than Configuration.PRIO_CLI_ARGS.

Variable categories are used as a prefix together with an underscore '_'. This means, if variable LOCALE in category ALIB is accessed, the environment variable ALIB_LOCALE is read.

Category and Variable names are insensitive in respect to character case.

Public Methods

 Environment ()
 
boolean load (Variable variable, boolean searchOnly)
 
- Public Methods inherited from ConfigurationPlugin
boolean load (Variable variable)
 
boolean store (Variable variable)
 
boolean store (Variable variable, Object externalizedValue)
 

Protected Fields

AString tmpAS = new AString()
 A temporary string to reuse.
 
- Protected Fields inherited from ConfigurationPlugin
XTernalizer defaultStringConverter = new XTernalizer()
 

Additional Inherited Members

- Public Fields inherited from ConfigurationPlugin
XTernalizer stringConverter
 
- Protected Methods inherited from ConfigurationPlugin
 ConfigurationPlugin ()
 

Constructor & Destructor Documentation

◆ Environment()


Constructor.

Member Function Documentation

◆ load()

boolean load ( Variable  variable,
boolean  searchOnly 
)

Searches the variable in the environment.

Parameters
variableThe variable to retrieve.
searchOnlyIf true, the variable is not set. Defaults to false.
Returns
true if variable was found, false if not.

Reimplemented from ConfigurationPlugin.


The documentation for this class was generated from the following file: