commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Oliver Heger (JIRA)" <j...@apache.org>
Subject [jira] Resolved: (CONFIGURATION-246) The method getBasePath() in FileConfiguration suggest other behavior than it is implemented
Date Wed, 03 Jan 2007 17:44:28 GMT

     [ https://issues.apache.org/jira/browse/CONFIGURATION-246?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Oliver Heger resolved CONFIGURATION-246.
----------------------------------------

       Resolution: Fixed
    Fix Version/s: Nightly Builds

The Javadocs for getBasePath() and setBasePath() in both FileConfiguration and AbstractFileConfiguration
have been improved. They now explain in more detail the background of the "base path" concept.

> The method getBasePath() in FileConfiguration suggest other behavior than it is implemented
> -------------------------------------------------------------------------------------------
>
>                 Key: CONFIGURATION-246
>                 URL: https://issues.apache.org/jira/browse/CONFIGURATION-246
>             Project: Commons Configuration
>          Issue Type: Improvement
>            Reporter: Thomas Wabner
>         Assigned To: Oliver Heger
>             Fix For: Nightly Builds
>
>
> I have tried to use the FileConfiguration#getBasePath method without a look into the
implementation. The documentation is not very useful because it says simple "returns the base
path". For me the method suggest that a string for the configuration file "C:\myDir\config.file"
in form "C:\myDir\" is returned. But the method returns the full path.
> I suggest to rename the method to getPath and give a documentation link to URL#getPath
which does in fact the same. Or update the documentation which describes in more detail that
this method returns the complete path for the associated file for this file configuration.
> A documentation entry can then looks like
> Returns the base path for the file associated with the current file configuration. The
base path contains the full path to the file and the file itself.
> @see java.net.URL#getPath

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message