commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Denise Fernandez (JIRA)" <j...@apache.org>
Subject [jira] Created: (LANG-424) Improve Javadoc for StringUtils class
Date Mon, 14 Apr 2008 06:45:05 GMT
Improve Javadoc for StringUtils class
-------------------------------------

                 Key: LANG-424
                 URL: https://issues.apache.org/jira/browse/LANG-424
             Project: Commons Lang
          Issue Type: Improvement
    Affects Versions: 2.4
            Reporter: Denise Fernandez


In the StringUtils class it would be helpful if in the following methods, the Javadoc is improved:

substringAfter
substringAfterLast

I think there should be better documentation in the case where the separator string is not
found in the search string: It should be explicity noted that in this case an empty string
will be returned.

In the following methods:

substringBefore
substringBeforeLast

It should be documented that if the separator is not found in the search string, the search
string is returned.

I realise there are examples for both these cases, but I think that they should be separately
and explicity documented as special cases. I had expected that substringAfterLast would return
the original string if the separator was not found in it and this caused me some trouble.



-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message