org.apache.hc.core5.http.message

## Class HttpResponseWrapper

- java.lang.Object
- - org.apache.hc.core5.http.message.AbstractMessageWrapper
  - - org.apache.hc.core5.http.message.HttpResponseWrapper

- All Implemented Interfaces:
    HttpMessage, HttpResponse, MessageHeaders

      public class HttpResponseWrapper
      extends AbstractMessageWrapper
      implements HttpResponse

  `HttpResponse` wrapper.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `HttpResponseWrapper(HttpResponse message)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `getCode()` Obtains the code of this response message.
    `Locale` | `getLocale()` Obtains the locale of this response.
    `String` | `getReasonPhrase()` Obtains the reason phrase of this response if available.
    `void` | `setCode(int code)` Updates status code of this response message.
    `void` | `setLocale(Locale loc)` Changes the locale of this response.
    `void` | `setReasonPhrase(String reason)` Updates the status line of this response with a new reason phrase.

    - ### Methods inherited from class org.apache.hc.core5.http.message.AbstractMessageWrapper

      `addHeader, addHeader, containsHeader, countHeaders, getFirstHeader, getHeader, getHeaders, getHeaders, getLastHeader, getVersion, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setVersion, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface org.apache.hc.core5.http.HttpMessage

      `addHeader, addHeader, getVersion, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setVersion`

    - ### Methods inherited from interface org.apache.hc.core5.http.MessageHeaders

      `containsHeader, countHeaders, getFirstHeader, getHeader, getHeaders, getHeaders, getLastHeader, headerIterator, headerIterator`

- - ### Constructor Detail

    - #### HttpResponseWrapper

          public HttpResponseWrapper(HttpResponse message)

  - ### Method Detail

    - #### getCode

          public int getCode()

      Description copied from interface: `HttpResponse`
      Obtains the code of this response message.
      Specified by:
        `getCode` in interface `HttpResponse`
      Returns:
        the status code.

    - #### setCode

          public void setCode(int code)

      Description copied from interface: `HttpResponse`
      Updates status code of this response message.
      Specified by:
        `setCode` in interface `HttpResponse`
      Parameters:
        `code` - the HTTP status code.
      See Also:
        `HttpStatus`

    - #### getReasonPhrase

          public String getReasonPhrase()

      Description copied from interface: `HttpResponse`
      Obtains the reason phrase of this response if available.
      Specified by:
        `getReasonPhrase` in interface `HttpResponse`
      Returns:
        the reason phrase.

    - #### setReasonPhrase

          public void setReasonPhrase(String reason)

      Description copied from interface: `HttpResponse`
      Updates the status line of this response with a new reason phrase.
      Specified by:
        `setReasonPhrase` in interface `HttpResponse`
      Parameters:
        `reason` - the new reason phrase as a single-line string, or `null` to unset the reason phrase

    - #### getLocale

          public Locale getLocale()

      Description copied from interface: `HttpResponse`
      Obtains the locale of this response. The locale is used to determine the reason phrase for the `status code`. It can be changed using `setLocale`.
      Specified by:
        `getLocale` in interface `HttpResponse`
      Returns:
        the locale of this response, never `null`

    - #### setLocale

          public void setLocale(Locale loc)

      Description copied from interface: `HttpResponse`
      Changes the locale of this response.
      Specified by:
        `setLocale` in interface `HttpResponse`
      Parameters:
        `loc` - the new locale

Copyright © 2005–2022 The Apache Software Foundation. All rights reserved.