src/jdk.incubator.httpclient/share/classes/jdk/incubator/http/package-info.java
changeset 47216 71c04702a3d5
parent 43302 45de1dc92ecd
child 48083 b1c1b4ef4be2
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/jdk.incubator.httpclient/share/classes/jdk/incubator/http/package-info.java	Tue Sep 12 19:03:39 2017 +0200
@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/**
+ * <h2>High level HTTP and WebSocket API</h2>
+ * {@Incubating}
+ *
+ * <p> Provides high-level client interfaces to HTTP (versions 1.1 and 2) and
+ * WebSocket. The main types defined are:
+ *
+ * <ul>
+ *    <li>{@link jdk.incubator.http.HttpClient}</li>
+ *    <li>{@link jdk.incubator.http.HttpRequest}</li>
+ *    <li>{@link jdk.incubator.http.HttpResponse}</li>
+ *    <li>{@link jdk.incubator.http.WebSocket}</li>
+ * </ul>
+ *
+ * <p> The API functions asynchronously (using {@link java.util.concurrent.CompletableFuture})
+ * and work is done on the threads supplied by the client's {@link java.util.concurrent.Executor}
+ * where practical.
+ *
+ * <p> {@code HttpClient} also provides a simple synchronous mode, where all
+ * work may be done on the calling thread.
+ *
+ * <p> {@code CompletableFuture}s returned by this API will throw {@link java.lang.UnsupportedOperationException}
+ * for their {@link java.util.concurrent.CompletableFuture#obtrudeValue(Object) obtrudeValue}
+ * and {@link java.util.concurrent.CompletableFuture#obtrudeException(Throwable) obtrudeException}
+ * methods. Invoking the {@link java.util.concurrent.CompletableFuture#cancel cancel}
+ * method on a {@code CompletableFuture} returned by this API will not interrupt
+ * the underlying operation, but may be useful to complete, exceptionally,
+ * dependent stages that have not already completed.
+ *
+ * <p> Unless otherwise stated, {@code null} parameter values will cause methods
+ * of all classes in this package to throw {@code NullPointerException}.
+ *
+ * @since 9
+ */
+package jdk.incubator.http;