author | chegar |
Wed, 06 Dec 2017 11:11:59 -0800 | |
changeset 48083 | b1c1b4ef4be2 |
parent 47216 | 71c04702a3d5 |
child 55973 | 4d9b002587db |
permissions | -rw-r--r-- |
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
1 |
/* |
48083 | 2 |
* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. |
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
4 |
* |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
10 |
* |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
15 |
* accompanied this code). |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
16 |
* |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
20 |
* |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
22 |
* or visit www.oracle.com if you need additional information or have any |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
23 |
* questions. |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
24 |
*/ |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
25 |
|
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
26 |
package jdk.incubator.http; |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
27 |
|
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
28 |
import java.util.List; |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
29 |
import java.util.Map; |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
30 |
import java.util.Optional; |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
31 |
import java.util.OptionalLong; |
48083 | 32 |
import static java.util.Collections.emptyList; |
33 |
import static java.util.Collections.unmodifiableList; |
|
34 |
import static java.util.Objects.requireNonNull; |
|
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
35 |
|
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
36 |
/** |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
37 |
* A read-only view of a set of HTTP headers. |
43302
45de1dc92ecd
8173354: javadoc warning notice for types in Incubator Modules
chegar
parents:
42460
diff
changeset
|
38 |
* {@Incubating} |
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
39 |
* |
48083 | 40 |
* <p> The methods of this class ( that accept a String header name ), and the |
41 |
* Map returned by the {@linkplain #map() map} method, operate without regard to |
|
42 |
* case when retrieving the header value. |
|
43 |
* |
|
44 |
* <p> HttpHeaders instances are immutable. |
|
45 |
* |
|
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
46 |
* @since 9 |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
47 |
*/ |
48083 | 48 |
public abstract class HttpHeaders { |
49 |
||
50 |
/** |
|
51 |
* Creates an HttpHeaders. |
|
52 |
*/ |
|
53 |
protected HttpHeaders() {} |
|
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
54 |
|
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
55 |
/** |
48083 | 56 |
* Returns an {@link Optional} containing the first value of the given named |
57 |
* (and possibly multi-valued) header. If the header is not present, then |
|
58 |
* the returned {@code Optional} is empty. |
|
59 |
* |
|
60 |
* @implSpec |
|
61 |
* The default implementation invokes |
|
62 |
* {@code allValues(name).stream().findFirst()} |
|
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
63 |
* |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
64 |
* @param name the header name |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
65 |
* @return an {@code Optional<String>} for the first named value |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
66 |
*/ |
48083 | 67 |
public Optional<String> firstValue(String name) { |
68 |
return allValues(name).stream().findFirst(); |
|
69 |
} |
|
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
70 |
|
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
71 |
/** |
48083 | 72 |
* Returns an {@link OptionalLong} containing the first value of the |
73 |
* named header field. If the header is not present, then the Optional is |
|
74 |
* empty. If the header is present but contains a value that does not parse |
|
75 |
* as a {@code Long} value, then an exception is thrown. |
|
76 |
* |
|
77 |
* @implSpec |
|
78 |
* The default implementation invokes |
|
79 |
* {@code allValues(name).stream().mapToLong(Long::valueOf).findFirst()} |
|
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
80 |
* |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
81 |
* @param name the header name |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
82 |
* @return an {@code OptionalLong} |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
83 |
* @throws NumberFormatException if a value is found, but does not parse as |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
84 |
* a Long |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
85 |
*/ |
48083 | 86 |
public OptionalLong firstValueAsLong(String name) { |
87 |
return allValues(name).stream().mapToLong(Long::valueOf).findFirst(); |
|
88 |
} |
|
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
89 |
|
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
90 |
/** |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
91 |
* Returns an unmodifiable List of all of the values of the given named |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
92 |
* header. Always returns a List, which may be empty if the header is not |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
93 |
* present. |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
94 |
* |
48083 | 95 |
* @implSpec |
96 |
* The default implementation invokes, among other things, the |
|
97 |
* {@code map().get(name)} to retrieve the list of header values. |
|
98 |
* |
|
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
99 |
* @param name the header name |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
100 |
* @return a List of String values |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
101 |
*/ |
48083 | 102 |
public List<String> allValues(String name) { |
103 |
requireNonNull(name); |
|
104 |
List<String> values = map().get(name); |
|
105 |
// Making unmodifiable list out of empty in order to make a list which |
|
106 |
// throws UOE unconditionally |
|
107 |
return values != null ? values : unmodifiableList(emptyList()); |
|
108 |
} |
|
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
109 |
|
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
110 |
/** |
48083 | 111 |
* Returns an unmodifiable multi Map view of this HttpHeaders. |
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
112 |
* |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
113 |
* @return the Map |
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
114 |
*/ |
48083 | 115 |
public abstract Map<String, List<String>> map(); |
116 |
||
117 |
/** |
|
118 |
* Tests this HTTP headers instance for equality with the given object. |
|
119 |
* |
|
120 |
* <p> If the given object is not an {@code HttpHeaders} then this |
|
121 |
* method returns {@code false}. Two HTTP headers are equal if each |
|
122 |
* of their corresponding {@linkplain #map() maps} are equal. |
|
123 |
* |
|
124 |
* <p> This method satisfies the general contract of the {@link |
|
125 |
* Object#equals(Object) Object.equals} method. |
|
126 |
* |
|
127 |
* @param obj the object to which this object is to be compared |
|
128 |
* @return {@code true} if, and only if, the given object is an {@code |
|
129 |
* HttpHeaders} that is equal to this HTTP headers |
|
130 |
*/ |
|
131 |
public final boolean equals(Object obj) { |
|
132 |
if (!(obj instanceof HttpHeaders)) |
|
133 |
return false; |
|
134 |
HttpHeaders that = (HttpHeaders)obj; |
|
135 |
return this.map().equals(that.map()); |
|
136 |
} |
|
137 |
||
138 |
/** |
|
139 |
* Computes a hash code for this HTTP headers instance. |
|
140 |
* |
|
141 |
* <p> The hash code is based upon the components of the HTTP headers |
|
142 |
* {@linkplain #map() map}, and satisfies the general contract of the |
|
143 |
* {@link Object#hashCode Object.hashCode} method. |
|
144 |
* |
|
145 |
* @return the hash-code value for this HTTP headers |
|
146 |
*/ |
|
147 |
public final int hashCode() { |
|
148 |
return map().hashCode(); |
|
149 |
} |
|
150 |
||
151 |
/** |
|
152 |
* Returns this HTTP headers as a string. |
|
153 |
* |
|
154 |
* @return a string describing the HTTP headers |
|
155 |
*/ |
|
156 |
@Override |
|
157 |
public String toString() { |
|
158 |
StringBuilder sb = new StringBuilder(); |
|
159 |
sb.append(super.toString()).append(" "); |
|
160 |
sb.append(map()); |
|
161 |
sb.append(" }"); |
|
162 |
return sb.toString(); |
|
163 |
} |
|
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
164 |
} |