Re: [jira] Commented: (DIRSNICKERS-116) StringUtils methods' names and javadocs does not reflect exactly what they do

[Emmanuel Lecharny <el...@gmail.com>]

oops... Sorry Trustin, I didn't realized it was for Ersin :)

On Mon, 2005-12-19 at 10:25 +0100, Trustin Lee (JIRA) wrote:
>     [ http://issues.apache.org/jira/browse/DIRSNICKERS-116?page=comments#action_12360805 ] 
> 
> Trustin Lee commented on DIRSNICKERS-116:
> -----------------------------------------
> 
> I was talking to Ersin, Emmanuel. :)  Ersin is the reporter, so he's the only one who can close this issue.
> 
> > StringUtils methods' names and javadocs does not reflect exactly what they do
> > -----------------------------------------------------------------------------
> >
> >          Key: DIRSNICKERS-116
> >          URL: http://issues.apache.org/jira/browse/DIRSNICKERS-116
> >      Project: Directory ASN1
> >         Type: Improvement
> >   Components: General
> >     Reporter: Ersin Er
> >     Assignee: Emmanuel Lecharny
> >     Priority: Trivial
> 
> >
> > There are to conversion methods in StringUtils class for String <-> UTF-8 transformation.
> > Here is the first one:
> > /**
> >   * Return an UTF-8 encoded String
> >   * @param bytes The byte array to be transformed to a String
> >   * @return A String. 
> >   */
> > public static String toUtf8( byte[] bytes )
> > {
> >    ...
> > It name should be changed to something like fromUtf8 or Utf8ToString and the definition in javadoc may be "Return a String converted from its UTF-8 encoded byte[] representation"
> > And one more method:
> > /**
> >   * Return an UTF-8 encoded String
> >   * @param string The string to be transformed to a byte array
> >   * @return The transformed byte array 
> > */
> > public static byte[] getBytesUtf8( String string )
> > {
> >    ...
> > This methods javadoc may be "Return UTF-8 encoded byte[] representation of a String"
> > (PS: Sorry for filing this trivial issue but currently I work on a branch and I do not want to cause a mess here.)
> 
-- 
Emmanuel Lécharny
www.iktek.com