Package kong.unirest.core

Class Headers

  • public class Headers
extends java.lang.Object

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      (package private) static class  Headers.Entry  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void accepts​(java.lang.String value)  
      void add​(java.lang.String name, java.lang.String value)
      Add a header element
      void add​(java.lang.String name, java.util.function.Supplier<java.lang.String> value)
      Add a header element with a supplier which will be evaluated on request
      void add​(java.util.Map<java.lang.String,​java.lang.String> headerMap)  
      java.util.List<Header> all()
      Get all of the headers
      void clear()
      Clear the headers!
      boolean containsKey​(java.lang.String name)
      Check if a header is present
      void cookie​(java.util.Collection<Cookie> cookies)  
      void cookie​(Cookie cookie)  
      boolean equals​(java.lang.Object o)  
      java.util.List<java.lang.String> get​(java.lang.String name)
      Get all the values for a header name
      java.lang.String getFirst​(java.lang.String key)
      Get the first header value for a name
      int hashCode()  
      private boolean isName​(Header h, java.lang.String name)  
      void putAll​(Headers header)
      Add a bunch of headers at once
      void remove​(java.lang.String name)
      Remove a header by name
      (package private) void remove​(java.lang.String key, java.lang.String value)  
      void replace​(java.lang.String name, java.lang.String value)
      Replace a header value.
      void replace​(java.util.Map<java.lang.String,​java.lang.String> headerMap)
      Replace all headers from a given map.
      void setBasicAuth​(java.lang.String username, java.lang.String password)  
      int size()
      Get the number of header keys.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • headers

        private java.util.List<Header> headers

    • Constructor Detail

      • Headers

        public Headers()

      • Headers

        public Headers​(java.util.Collection<Headers.Entry> entries)

    • Method Detail

      • add

        public void add​(java.lang.String name,
                java.lang.String value)
        Add a header element
        Parameters:
        name - the name of the header
        value - the value for the header

      • add

        public void add​(java.lang.String name,
                java.util.function.Supplier<java.lang.String> value)
        Add a header element with a supplier which will be evaluated on request
        Parameters:
        name - the name of the header
        value - the value for the header

      • replace

        public void replace​(java.lang.String name,
                    java.lang.String value)
        Replace a header value. If there are multiple instances it will overwrite all of them
        Parameters:
        name - the name of the header
        value - the value for the header

      • remove

        public void remove​(java.lang.String name)
        Remove a header by name
        Parameters:
        name - the name of the header

      • size

        public int size()
        Get the number of header keys.
        Returns:
        the size of the header keys

      • get

        public java.util.List<java.lang.String> get​(java.lang.String name)
        Get all the values for a header name
        Parameters:
        name - name of the header element
        Returns:
        a list of values

      • putAll

        public void putAll​(Headers header)
        Add a bunch of headers at once
        Parameters:
        header - a header

      • containsKey

        public boolean containsKey​(java.lang.String name)
        Check if a header is present
        Parameters:
        name - a header
        Returns:
        if the headers contain this name.

      • clear

        public void clear()
        Clear the headers!

      • getFirst

        public java.lang.String getFirst​(java.lang.String key)
        Get the first header value for a name
        Parameters:
        key - the name of the header
        Returns:
        the first value

      • all

        public java.util.List<Header> all()
        Get all of the headers
        Returns:
        all the headers, in order

      • isName

        private boolean isName​(Header h,
                       java.lang.String name)

      • remove

        void remove​(java.lang.String key,
            java.lang.String value)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Returns:
        list all headers like this: 
        Content-Length: 42
 Cache-Control: no-cache
 ...

      • cookie

        public void cookie​(Cookie cookie)

      • cookie

        public void cookie​(java.util.Collection<Cookie> cookies)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • setBasicAuth

        public void setBasicAuth​(java.lang.String username,
                         java.lang.String password)

      • accepts

        public void accepts​(java.lang.String value)

      • add

        public void add​(java.util.Map<java.lang.String,​java.lang.String> headerMap)

      • replace

        public void replace​(java.util.Map<java.lang.String,​java.lang.String> headerMap)
        Replace all headers from a given map.
        Parameters:
        headerMap - the map of headers