hc-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tim (JIRA)" <j...@apache.org>
Subject [jira] [Created] (HTTPCLIENT-1260) Javadoc incorrectly states StringBody(String)'s encoding uses the system default.
Date Thu, 15 Nov 2012 14:04:12 GMT
Tim created HTTPCLIENT-1260:
-------------------------------

             Summary: Javadoc incorrectly states StringBody(String)'s encoding uses the system
default.
                 Key: HTTPCLIENT-1260
                 URL: https://issues.apache.org/jira/browse/HTTPCLIENT-1260
             Project: HttpComponents HttpClient
          Issue Type: Bug
          Components: HttpClient
    Affects Versions: 4.2.2
         Environment: Android
            Reporter: Tim
            Priority: Minor


(Sorry if this is the wrong component.)

In the class `org.apache.http.entity.mime.content.StringBody`, there is the following code:

    /**
     * Create a StringBody from the specified text.
     * The mime type is set to "text/plain".
     * The hosts default charset is used.
     *
     * @param text to be used for the body, not {@code null}
     * @throws UnsupportedEncodingException
     * @throws IllegalArgumentException if the {@code text} parameter is null
     */
    public StringBody(final String text) throws UnsupportedEncodingException {
        this(text, "text/plain", null);
    }

Note that it says "The hosts [sic] default charset is used.". This is incorrect. The code
*always* uses US-ASCII no matter what the host's default charset is (e.g. on Android it is
UTF-8).

Quite annoying! It should read:

    /**
     * Create a StringBody from the specified text.
     * The mime type is set to "text/plain".
     * The charset is set to US-ASCII.
     *
     * @param text to be used for the body, not {@code null}
     * @throws UnsupportedEncodingException
     * @throws IllegalArgumentException if the {@code text} parameter is null
     */
    public StringBody(final String text) throws UnsupportedEncodingException {
        this(text, "text/plain", null);
    }

I'd appreciate it if you could fix this, so future developers won't have the frustration of
working out why their non-ascii characters are all being changed to question marks.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Mime
View raw message