Uploaded image for project: 'Commons Configuration'
  1. Commons Configuration
  2. CONFIGURATION-502

Basic features and AbstractConfiguration documentation

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: 1.8
    • Fix Version/s: 1.9
    • Component/s: Documentation
    • Labels:
      None

      Description

      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");

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              robottinosino Tino Sino
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 1h
                1h
                Remaining:
                Remaining Estimate - 1h
                1h
                Logged:
                Time Spent - Not Specified
                Not Specified