commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Oliver Heger (JIRA)" <>
Subject [jira] [Commented] (CONFIGURATION-569) Add API call to insert comments into save configuration
Date Sun, 23 Feb 2014 18:48:19 GMT


Oliver Heger commented on CONFIGURATION-569:

I agree that this is a useful feature to have for all kinds of configurations. Currently,
comments are only supported for {{PropertiesConfiguration}}, and here we took a major effort
to ensure that they are correctly loaded and saved without corrupting the original layout
of the configuration file. I am not sure to which degree it is possible to make this implementation
generic so that it can be used for other types of configurations, too.

In any case, the implementation of this request is surely not trivial. Patches in this area
are welcome!

> Add API call to insert comments into save configuration
> -------------------------------------------------------
>                 Key: CONFIGURATION-569
>                 URL:
>             Project: Commons Configuration
>          Issue Type: New Feature
>          Components: Format
>    Affects Versions: 1.9
>            Reporter: Rodney Beede
>            Priority: Trivial
>   Original Estimate: 672h
>  Remaining Estimate: 672h
> An API to insert comments into saved to disk configurations would be nice.  That would
make it possible to write a default configuration file in code for first-time use.
> The comments should be attached to particular config keys so that the comments appear
right before the config key/value (or node in the tree) on disk.
> The goal is to have some metadata to explain what values should/could be used for a particular
configuration setting.

This message was sent by Atlassian JIRA

View raw message