You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ol...@apache.org on 2018/04/24 14:02:22 UTC

httpcomponents-core git commit: Improve HeaderValueParser API doc (HTTPCORE-523)

Repository: httpcomponents-core
Updated Branches:
  refs/heads/4.4.x 5b4eef28d -> 1080d0931


Improve HeaderValueParser API doc (HTTPCORE-523)

Project: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/commit/1080d093
Tree: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/tree/1080d093
Diff: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/diff/1080d093

Branch: refs/heads/4.4.x
Commit: 1080d09318067e9aad1587a61d6a576f0ed256d9
Parents: 5b4eef2
Author: Julian Reschke <ju...@gmx.de>
Authored: Tue Apr 24 11:07:40 2018 +0000
Committer: GitHub <no...@github.com>
Committed: Tue Apr 24 11:07:40 2018 +0000

----------------------------------------------------------------------
 .../main/java/org/apache/http/message/HeaderValueParser.java   | 6 ++++++
 1 file changed, 6 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/httpcomponents-core/blob/1080d093/httpcore/src/main/java/org/apache/http/message/HeaderValueParser.java
----------------------------------------------------------------------
diff --git a/httpcore/src/main/java/org/apache/http/message/HeaderValueParser.java b/httpcore/src/main/java/org/apache/http/message/HeaderValueParser.java
index 180f38f..deaa5f1 100644
--- a/httpcore/src/main/java/org/apache/http/message/HeaderValueParser.java
+++ b/httpcore/src/main/java/org/apache/http/message/HeaderValueParser.java
@@ -68,6 +68,12 @@ public interface HeaderValueParser {
      * element or param will be stored as the empty {@link String};
      * if the "=" is also missing <var>null</var> will be stored instead.
      * </p>
+     * <p>
+     * Note that this parser does not apply to list-typed HTTP header fields in
+     * general; it is only suitable for fields that use the syntax described
+     * above. Counter-examples are "Link" (RFC 8269), "If-None-Match" (RFC 7232)
+     * or "Dav" (RFC 4918).
+     * </p>
      *
      * @param buffer    buffer holding the header value to parse
      * @param cursor    the parser cursor containing the current position and