[CONFIGURATION-246] The method getBasePath() in FileConfiguration suggest other behavior than it is implemented

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.4
• Assignee: Oliver Heger
• Reporter: Thomas Wabner
• Created: 20/Dec/06 10:29
• Updated: 22/Aug/09 19:36
• Resolved: 03/Jan/07 17:42

Description

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