org.apache.hc.core5.http

## Interface FormattedHeader

- All Superinterfaces:
    Header, NameValuePair
  All Known Implementing Classes:
    BufferedHeader

      public interface FormattedHeader
      extends Header

  An HTTP header which is already formatted. For example when headers are received, the original formatting can be preserved. This allows for the header to be sent without another formatting step.
  Since:
    4.0

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `CharArrayBuffer` | `getBuffer()` Obtains the buffer with the formatted header.
    `int` | `getValuePos()` Obtains the start of the header value in the `buffer`.

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

      `isSensitive`

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

      `getName, getValue`

- - ### Method Detail

    - #### getBuffer

          CharArrayBuffer getBuffer()

      Obtains the buffer with the formatted header. The returned buffer MUST NOT be modified.
      Returns:
        the formatted header, in a buffer that must not be modified

    - #### getValuePos

          int getValuePos()

      Obtains the start of the header value in the `buffer`. By accessing the value in the buffer, creation of a temporary string can be avoided.
      Returns:
        index of the first character of the header value in the buffer returned by `getBuffer`.

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