Http2Headers.iterator() comment correction

Motivation:
The javadoc comments on Http2Headers.iterator() are incorrect.

Modifications:
- Correct and clarify the javadoc for Http2Headers.iterator()

Result:
Javadoc for Http2Headers.iterator() is more correct.
This commit is contained in:
Scott Mitchell 2015-09-03 10:28:58 -07:00
parent f1eddd6117
commit 7e5ad25bb1

View File

@ -186,9 +186,9 @@ public interface Http2Headers extends Headers<ByteString> {
Http2Headers clear();
/**
* Returns an iterator over all HTTP/2 headers from this instance. The iteration order is as follows:
* 1. All non-pseudo headers (in no particular order).
* 2. Headers with multiple values will have their values appear in insertion order.
* Returns an iterator over all HTTP/2 headers. The iteration order is as follows:
* 1. All pseudo headers (order not specified).
* 2. All non-pseudo headers (in insertion order).
*/
@Override
Iterator<Entry<ByteString, ByteString>> iterator();