PropertiesFile represents a file of properties.
A properties file contains simple key-value pairs. Multiple pairs are separated by line terminators (\n or \r or \r\n). Keys are separated from values with the characters '=', ':' or a white space character.
Comments are also supported. Just add a '#' or '!' character at the beginning of your comment-line.
If you want to use any of the special characters in your key or value you must escape it with a back-slash character '\'.
The key contains all of the characters in a line starting from the first non-white space character up to, but not including, the first unescaped key-value-separator.
The value contains all of the characters in a line starting from the first non-white space character after the key-value-separator up to the end of the line. You may of course also escape the line terminator and create a value across multiple lines.
public function PropertiesFile(source:String, size:Byte, uri:String)
Constructs a new PropertiesFile instance.
For information on how the source must look like take a look at this class's class documentation.
source | the content of the properties file |
size | the size in bytes of the properties file |
uri | the URI to the properties file |
public function getProperties(Void):PropertiesReturns the data structure representaton of this properties file.
this properties file data structure representation