Module org.tquadrat.foundation.inifile

Package org.tquadrat.foundation.inifile

@API(status=STABLE, since="0.1.0") package org.tquadrat.foundation.inifile

The module INIFile provides an API to Windows-style configuration files, the so called 'INI' files, from the extension '.ini' of these files.

These files are text files with UTF-8 encoding and do look like below:


  # This is a comment line
  [Group]
  key=value

  [otherGroup]
  key=value
  otherKey=otherValue
  key1=longValue\
  continued in the next line
  text=Values may contain escape sequences like \n for new lines, \
  and \t for tabs.
  • Empty lines are ignored.
  • A line that ends with a backslash ("\") will be concatenated with the following line.
  • All leading whitespace will be removed.
  • Lines starting with the hash symbol ("#") contain comments and will be ignored.
  • All values are assigned to a group; this means that the first relevant line is always a group header.
  • A group header is an arbitrary String within brackets ("[" and "]").
  • The keys are separated from the values by the equals sign ("=").
  • A key may contain whitespace (blanks), but trailing or leading whitespace is ignored.
  • Any leading whitespace for a value will be ignored, but the escape sequence '\ ' for a blank will be regarded.