src/java.net.http/share/classes/java/net/http/package-info.java
branchhttp-client-branch
changeset 56089 42208b2f224e
parent 56088 38fac6d0521d
child 56097 15dc43936d39
equal deleted inserted replaced
56088:38fac6d0521d 56089:42208b2f224e
       
     1 /*
       
     2  * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
       
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
       
     4  *
       
     5  * This code is free software; you can redistribute it and/or modify it
       
     6  * under the terms of the GNU General Public License version 2 only, as
       
     7  * published by the Free Software Foundation.  Oracle designates this
       
     8  * particular file as subject to the "Classpath" exception as provided
       
     9  * by Oracle in the LICENSE file that accompanied this code.
       
    10  *
       
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
       
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
       
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
       
    14  * version 2 for more details (a copy is included in the LICENSE file that
       
    15  * accompanied this code).
       
    16  *
       
    17  * You should have received a copy of the GNU General Public License version
       
    18  * 2 along with this work; if not, write to the Free Software Foundation,
       
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
       
    20  *
       
    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
       
    22  * or visit www.oracle.com if you need additional information or have any
       
    23  * questions.
       
    24  */
       
    25 
       
    26 /**
       
    27  * <h2>High level HTTP and WebSocket API</h2>
       
    28  *
       
    29  * <p> Provides high-level client interfaces to HTTP (versions 1.1 and 2) and
       
    30  * WebSocket. The main types defined are:
       
    31  *
       
    32  * <ul>
       
    33  *    <li>{@link java.net.http.HttpClient}</li>
       
    34  *    <li>{@link java.net.http.HttpRequest}</li>
       
    35  *    <li>{@link java.net.http.HttpResponse}</li>
       
    36  *    <li>{@link java.net.http.WebSocket}</li>
       
    37  * </ul>
       
    38  *
       
    39  * <p> The API functions asynchronously (using {@link java.util.concurrent.CompletableFuture})
       
    40  * and work is done on the threads supplied by the client's {@link java.util.concurrent.Executor}
       
    41  * where practical.
       
    42  *
       
    43  * <p> {@code HttpClient} also provides a simple synchronous mode, where all
       
    44  * work may be done on the calling thread.
       
    45  *
       
    46  * <p> {@code CompletableFuture}s returned by this API will throw {@link java.lang.UnsupportedOperationException}
       
    47  * for their {@link java.util.concurrent.CompletableFuture#obtrudeValue(Object) obtrudeValue}
       
    48  * and {@link java.util.concurrent.CompletableFuture#obtrudeException(Throwable) obtrudeException}
       
    49  * methods. Invoking the {@link java.util.concurrent.CompletableFuture#cancel cancel}
       
    50  * method on a {@code CompletableFuture} returned by this API will not interrupt
       
    51  * the underlying operation, but may be useful to complete, exceptionally,
       
    52  * dependent stages that have not already completed.
       
    53  *
       
    54  * <p> Unless otherwise stated, {@code null} parameter values will cause methods
       
    55  * of all classes in this package to throw {@code NullPointerException}.
       
    56  *
       
    57  * @since 11
       
    58  */
       
    59 package java.net.http;