You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hc.apache.org by "Toli Kuznets (JIRA)" <ji...@apache.org> on 2011/03/02 20:49:37 UTC

[jira] Created: (HTTPCLIENT-1065) Documentation on SingleClientConnManager(SchemeRegistry schreg) constructor is wrong

Documentation on SingleClientConnManager(SchemeRegistry schreg) constructor is wrong
------------------------------------------------------------------------------------

                 Key: HTTPCLIENT-1065
                 URL: https://issues.apache.org/jira/browse/HTTPCLIENT-1065
             Project: HttpComponents HttpClient
          Issue Type: Task
          Components: HttpClient
    Affects Versions: 4.1 Final
            Reporter: Toli Kuznets
            Priority: Minor


Seems that the documentation for single-arg constructor SingleClientConnManager(SchemeRegistry schreg) is wrong.

Documentation says that incoming SchemeRegistry parameter can be null:
    schreg - the scheme registry, or null for the default registry

However, the constructor throws an exception in incoming schreg param is null:

    /**
     * Creates a new simple connection manager.
     *
     * @param params    the parameters for this manager
     * @param schreg    the scheme registry, or
     *                  <code>null</code> for the default registry
     */
    public SingleClientConnManager(HttpParams params,
                                   SchemeRegistry schreg) {
        if (schreg == null) {
            throw new IllegalArgumentException
                ("Scheme registry must not be null.");
        }


So this is likely a documentation bug...

-- 
This message is automatically generated by JIRA.
-
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


[jira] Resolved: (HTTPCLIENT-1065) Documentation on SingleClientConnManager(SchemeRegistry schreg) constructor is wrong

Posted by "Oleg Kalnichevski (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HTTPCLIENT-1065?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Oleg Kalnichevski resolved HTTPCLIENT-1065.
-------------------------------------------

       Resolution: Fixed
    Fix Version/s: 4.2 Final

Corrected. Many thanks, Toli

Oleg

> Documentation on SingleClientConnManager(SchemeRegistry schreg) constructor is wrong
> ------------------------------------------------------------------------------------
>
>                 Key: HTTPCLIENT-1065
>                 URL: https://issues.apache.org/jira/browse/HTTPCLIENT-1065
>             Project: HttpComponents HttpClient
>          Issue Type: Task
>          Components: HttpClient
>    Affects Versions: 4.1 Final
>            Reporter: Toli Kuznets
>            Priority: Minor
>              Labels: documentaion
>             Fix For: 4.2 Final
>
>
> Seems that the documentation for single-arg constructor SingleClientConnManager(SchemeRegistry schreg) is wrong.
> Documentation says that incoming SchemeRegistry parameter can be null:
>     schreg - the scheme registry, or null for the default registry
> However, the constructor throws an exception in incoming schreg param is null:
>     /**
>      * Creates a new simple connection manager.
>      *
>      * @param params    the parameters for this manager
>      * @param schreg    the scheme registry, or
>      *                  <code>null</code> for the default registry
>      */
>     public SingleClientConnManager(HttpParams params,
>                                    SchemeRegistry schreg) {
>         if (schreg == null) {
>             throw new IllegalArgumentException
>                 ("Scheme registry must not be null.");
>         }
> So this is likely a documentation bug...

-- 
This message is automatically generated by JIRA.
-
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