Package org.zalando.logbook

Interface HttpHeaders

All Superinterfaces:
java.util.Map<java.lang.String,​java.util.List<java.lang.String>>
@Immutable
public interface HttpHeaders
extends java.util.Map<java.lang.String,​java.util.List<java.lang.String>>
An immutable multi-map representing HTTP headers. It offers three kinds of operations: update is essentially Map.put(Object, Object), but returns a new instance with the updated entries. delete is essentially Map.remove(Object), but returns a new instance without the deleted headers. apply applies a function to all entries or a subset of them and applies the changes. If the given operator returns a null value the entry will be deleted otherwise updated.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface java.util.Map

    java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

  • Method Summary

    Modifier and Type Method Description
    HttpHeaders apply​(java.lang.String name, java.util.function.UnaryOperator<java.util.List<java.lang.String>> operator)  
    HttpHeaders apply​(java.util.Collection<java.lang.String> names, java.util.function.BiFunction<java.lang.String,​java.util.List<java.lang.String>,​java.util.Collection<java.lang.String>> operator)  
    HttpHeaders apply​(java.util.function.BiFunction<java.lang.String,​java.util.List<java.lang.String>,​java.util.Collection<java.lang.String>> operator)  
    HttpHeaders apply​(java.util.function.BiPredicate<java.lang.String,​java.util.List<java.lang.String>> predicate, java.util.function.BiFunction<java.lang.String,​java.util.List<java.lang.String>,​java.util.Collection<java.lang.String>> operator)  
    void clear()
    Deprecated.
    java.util.List<java.lang.String> compute​(java.lang.String key, java.util.function.BiFunction<? super java.lang.String,​? super java.util.List<java.lang.String>,​? extends java.util.List<java.lang.String>> remappingFunction)
    Deprecated.
    java.util.List<java.lang.String> computeIfAbsent​(java.lang.String key, java.util.function.Function<? super java.lang.String,​? extends java.util.List<java.lang.String>> mappingFunction)
    Deprecated.
    java.util.List<java.lang.String> computeIfPresent​(java.lang.String key, java.util.function.BiFunction<? super java.lang.String,​? super java.util.List<java.lang.String>,​? extends java.util.List<java.lang.String>> remappingFunction)
    Deprecated.
    HttpHeaders delete​(java.lang.String... names)  
    HttpHeaders delete​(java.util.Collection<java.lang.String> names)  
    HttpHeaders delete​(java.util.function.BiPredicate<java.lang.String,​java.util.List<java.lang.String>> predicate)  
    static HttpHeaders empty()  
    java.util.List<java.lang.String> merge​(java.lang.String key, java.util.List<java.lang.String> value, java.util.function.BiFunction<? super java.util.List<java.lang.String>,​? super java.util.List<java.lang.String>,​? extends java.util.List<java.lang.String>> remappingFunction)
    Deprecated.
    static HttpHeaders of​(java.lang.String name, java.lang.String... values)  
    static HttpHeaders of​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)  
    static <T,​ U> java.util.function.BiPredicate<T,​U> predicate​(java.util.function.Predicate<T> predicate)  
    java.util.List<java.lang.String> put​(java.lang.String key, java.util.List<java.lang.String> value)
    Deprecated.
    void putAll​(java.util.Map<? extends java.lang.String,​? extends java.util.List<java.lang.String>> m)
    Deprecated.
    java.util.List<java.lang.String> putIfAbsent​(java.lang.String key, java.util.List<java.lang.String> value)
    Deprecated.
    java.util.List<java.lang.String> remove​(java.lang.Object key)
    Deprecated.
    boolean remove​(java.lang.Object key, java.lang.Object value)
    Deprecated.
    java.util.List<java.lang.String> replace​(java.lang.String key, java.util.List<java.lang.String> value)
    Deprecated.
    boolean replace​(java.lang.String key, java.util.List<java.lang.String> oldValue, java.util.List<java.lang.String> newValue)
    Deprecated.
    void replaceAll​(java.util.function.BiFunction<? super java.lang.String,​? super java.util.List<java.lang.String>,​? extends java.util.List<java.lang.String>> function)
    Deprecated.
    HttpHeaders update​(java.lang.String name, java.lang.String... values)  
    HttpHeaders update​(java.lang.String name, java.util.Collection<java.lang.String> value)  
    HttpHeaders update​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)  

    Methods inherited from interface java.util.Map

    containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, size, values

  • Method Details

    • update

      @CheckReturnValue HttpHeaders update​(java.lang.String name, java.lang.String... values)

    • update

      @CheckReturnValue HttpHeaders update​(java.lang.String name, java.util.Collection<java.lang.String> value)

    • update

      @CheckReturnValue HttpHeaders update​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)

    • apply

      @CheckReturnValue HttpHeaders apply​(java.lang.String name, java.util.function.UnaryOperator<java.util.List<java.lang.String>> operator)

    • apply

      @CheckReturnValue HttpHeaders apply​(java.util.Collection<java.lang.String> names, java.util.function.BiFunction<java.lang.String,​java.util.List<java.lang.String>,​java.util.Collection<java.lang.String>> operator)

    • apply

      @CheckReturnValue HttpHeaders apply​(java.util.function.BiPredicate<java.lang.String,​java.util.List<java.lang.String>> predicate, java.util.function.BiFunction<java.lang.String,​java.util.List<java.lang.String>,​java.util.Collection<java.lang.String>> operator)

    • apply

      @CheckReturnValue HttpHeaders apply​(java.util.function.BiFunction<java.lang.String,​java.util.List<java.lang.String>,​java.util.Collection<java.lang.String>> operator)

    • delete

      @CheckReturnValue HttpHeaders delete​(java.lang.String... names)

    • delete

      @CheckReturnValue HttpHeaders delete​(java.util.Collection<java.lang.String> names)

    • delete

      @CheckReturnValue HttpHeaders delete​(java.util.function.BiPredicate<java.lang.String,​java.util.List<java.lang.String>> predicate)

    • empty

      static HttpHeaders empty()

    • of

      static HttpHeaders of​(java.lang.String name, java.lang.String... values)

    • of

      static HttpHeaders of​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)

    • predicate

      static <T,​ U> java.util.function.BiPredicate<T,​U> predicate​(java.util.function.Predicate<T> predicate)

    • put

      @Deprecated java.util.List<java.lang.String> put​(java.lang.String key, java.util.List<java.lang.String> value)
      Deprecated.
      Specified by:
      put in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • remove

      @Deprecated java.util.List<java.lang.String> remove​(java.lang.Object key)
      Deprecated.
      Specified by:
      remove in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • putAll

      @Deprecated void putAll​(java.util.Map<? extends java.lang.String,​? extends java.util.List<java.lang.String>> m)
      Deprecated.
      Specified by:
      putAll in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • clear

      @Deprecated void clear()
      Deprecated.
      Specified by:
      clear in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • replaceAll

      @Deprecated void replaceAll​(java.util.function.BiFunction<? super java.lang.String,​? super java.util.List<java.lang.String>,​? extends java.util.List<java.lang.String>> function)
      Deprecated.
      Specified by:
      replaceAll in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • putIfAbsent

      @Deprecated java.util.List<java.lang.String> putIfAbsent​(java.lang.String key, java.util.List<java.lang.String> value)
      Deprecated.
      Specified by:
      putIfAbsent in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • remove

      @Deprecated boolean remove​(java.lang.Object key, java.lang.Object value)
      Deprecated.
      Specified by:
      remove in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • replace

      @Deprecated boolean replace​(java.lang.String key, java.util.List<java.lang.String> oldValue, java.util.List<java.lang.String> newValue)
      Deprecated.
      Specified by:
      replace in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • replace

      @Deprecated java.util.List<java.lang.String> replace​(java.lang.String key, java.util.List<java.lang.String> value)
      Deprecated.
      Specified by:
      replace in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • computeIfAbsent

      @Deprecated java.util.List<java.lang.String> computeIfAbsent​(java.lang.String key, java.util.function.Function<? super java.lang.String,​? extends java.util.List<java.lang.String>> mappingFunction)
      Deprecated.
      Specified by:
      computeIfAbsent in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • computeIfPresent

      @Deprecated java.util.List<java.lang.String> computeIfPresent​(java.lang.String key, java.util.function.BiFunction<? super java.lang.String,​? super java.util.List<java.lang.String>,​? extends java.util.List<java.lang.String>> remappingFunction)
      Deprecated.
      Specified by:
      computeIfPresent in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • compute

      @Deprecated java.util.List<java.lang.String> compute​(java.lang.String key, java.util.function.BiFunction<? super java.lang.String,​? super java.util.List<java.lang.String>,​? extends java.util.List<java.lang.String>> remappingFunction)
      Deprecated.
      Specified by:
      compute in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>

    • merge

      @Deprecated java.util.List<java.lang.String> merge​(java.lang.String key, java.util.List<java.lang.String> value, java.util.function.BiFunction<? super java.util.List<java.lang.String>,​? super java.util.List<java.lang.String>,​? extends java.util.List<java.lang.String>> remappingFunction)
      Deprecated.
      Specified by:
      merge in interface java.util.Map<java.lang.String,​java.util.List<java.lang.String>>