You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@directory.apache.org by "Ersin Er (JIRA)" <di...@incubator.apache.org> on 2005/12/01 18:48:30 UTC

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

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
 Assigned to: 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.)

-- 
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


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

Posted by "Trustin Lee (JIRA)" <di...@incubator.apache.org>.
    [ http://issues.apache.org/jira/browse/DIRSNICKERS-116?page=comments#action_12360791 ] 

Trustin Lee commented on DIRSNICKERS-116:
-----------------------------------------

Why don't you close this issue if you think it is fixed now? :)

> 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.)

-- 
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


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

Posted by "Ersin Er (JIRA)" <di...@incubator.apache.org>.
     [ http://issues.apache.org/jira/browse/DIRSNICKERS-116?page=all ]
     
Ersin Er closed DIRSNICKERS-116:
--------------------------------


OK, sorry :-)

> 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.)

-- 
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


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

Posted by "Emmanuel Lecharny (JIRA)" <di...@incubator.apache.org>.
     [ http://issues.apache.org/jira/browse/DIRSNICKERS-116?page=all ]
     
Emmanuel Lecharny resolved DIRSNICKERS-116:
-------------------------------------------

    Resolution: Fixed

Fixed ! Thans a lot Ersin to pointed out this stupid method name and inacurrate javaDoc.

> 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.)

-- 
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


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

Posted by "Emmanuel Lecharny (JIRA)" <di...@incubator.apache.org>.
    [ http://issues.apache.org/jira/browse/DIRSNICKERS-116?page=comments#action_12360803 ] 

Emmanuel Lecharny commented on DIRSNICKERS-116:
-----------------------------------------------

Because I can't ! It's marked as resolved, and the only worklow action possible for it is "Reopen 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.)

-- 
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


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

Posted by 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


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

Posted by "Trustin Lee (JIRA)" <di...@incubator.apache.org>.
    [ 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.)

-- 
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