commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tino Sino (JIRA)" <j...@apache.org>
Subject [jira] [Created] (CONFIGURATION-502) Basic features and AbstractConfiguration documentation
Date Thu, 02 Aug 2012 21:51:03 GMT
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

        

Mime
View raw message