[CONFIGURATION-104] [configuration] Preserve file structure (line comments) when re-saving properties file

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed

Environment

Operating System: other
Platform: Other

• Bugzilla Id: 39182
• Assignee: Oliver Heger
• Reporter: Oded Noam
• Created: 03/Apr/06 00:52
• Updated: 20/Sep/18 18:44
• Resolved: 22/Jul/06 17:09

Description

This bug applies when an application allows both manual editing of its
configuration files, and manipulation of the configuration via software. When
saving the configuration file after changing, its file structure - file,
section and line comments - will all be lost. Next time a human tries to edit
the configuration file, all property documentation will be lost.

I have created a fix for this problem, applicable to PropertiesConfiguration
and XMLPropertiesConfiguration. The fix allows these classes to preserve a
list of comment lines preceding each property line. By default, comments are
not preserved; in case the comment preservation is required, it should be
enabled prior to loading the configuration file using:

AbstractFileConfiguration.setDefaultPreserveComments(true);

The fix is implemented and tested, attached as a patch file to this bug.

Issue Links

• incorporates: CONFIGURATION-140 [configuration] Header parsing for PropertiesConfiguration