The method getBasePath() in FileConfiguration suggest other behavior than it is
implemented
-------------------------------------------------------------------------------------------
Key: CONFIGURATION-246
URL: http://issues.apache.org/jira/browse/CONFIGURATION-246
Project: Commons Configuration
Issue Type: Improvement
Reporter: Thomas Wabner
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:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
