You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "Tino Sino (JIRA)" <ji...@apache.org> on 2012/08/02 23:51:03 UTC
[jira] [Created] (CONFIGURATION-502) Basic features and
AbstractConfiguration documentation
Tino Sino created CONFIGURATION-502:
---------------------------------------
Summary: Basic features and AbstractConfiguration documentation
Key: CONFIGURATION-502
URL: https://issues.apache.org/jira/browse/CONFIGURATION-502
Project: Commons Configuration
Issue Type: Improvement
Components: Documentation
Affects Versions: 1.8
Reporter: Tino Sino
Priority: Trivial
I think the documentation could be improved by being more specific.
Example:
from this...
// This will probably return null
String strValue = config.getString("NonExistingProperty");
// This might throw an exception
long longValue = config.getLong("NonExistingProperty");
to this...
// This will return null if no property with key "NonExistingProperty" exists
String strValue = config.getString("NonExistingProperty");
// This will throw a NoSuchElementException exception if no property with key "NonExistingProperty" exists
long longValue = config.getLong("NonExistingProperty");
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Resolved] (CONFIGURATION-502) Basic features and
AbstractConfiguration documentation
Posted by "Oliver Heger (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CONFIGURATION-502?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Oliver Heger resolved CONFIGURATION-502.
----------------------------------------
Resolution: Fixed
Fix Version/s: 1.9
Changes applied in revision 1369336. Many thanks.
> Basic features and AbstractConfiguration documentation
> ------------------------------------------------------
>
> Key: CONFIGURATION-502
> URL: https://issues.apache.org/jira/browse/CONFIGURATION-502
> Project: Commons Configuration
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.8
> Reporter: Tino Sino
> Priority: Trivial
> Fix For: 1.9
>
> Original Estimate: 1h
> Remaining Estimate: 1h
>
> I think the documentation could be improved by being more specific.
> Example:
> from this...
> // This will probably return null
> String strValue = config.getString("NonExistingProperty");
> // This might throw an exception
> long longValue = config.getLong("NonExistingProperty");
> to this...
> // This will return null if no property with key "NonExistingProperty" exists
> String strValue = config.getString("NonExistingProperty");
> // This will throw a NoSuchElementException exception if no property with key "NonExistingProperty" exists
> long longValue = config.getLong("NonExistingProperty");
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira