src/java.net.http/share/classes/jdk/internal/net/http/hpack/Huffman.java
author prappo
Tue, 01 May 2018 19:14:46 +0100
branchhttp-client-branch
changeset 56504 dd13fb9f1603
parent 56451 9585061fdb04
child 56507 2294c51eae30
permissions -rw-r--r--
http-client-branch: review comment - HPACK bytewise decoding
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
     1
/*
49765
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
     2
 * Copyright (c) 2014, 2018, 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
 */
49765
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    25
package jdk.internal.net.http.hpack;
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    26
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    27
import java.io.IOException;
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    28
import java.nio.ByteBuffer;
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    29
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    30
/**
56504
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    31
 * Huffman coding.
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    32
 *
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    33
 * @since 9
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    34
 */
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    35
public final class Huffman {
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    36
56504
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    37
    public interface Reader {
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    38
48083
b1c1b4ef4be2 8191494: Refresh incubating HTTP Client
chegar
parents: 47216
diff changeset
    39
        void read(ByteBuffer source,
b1c1b4ef4be2 8191494: Refresh incubating HTTP Client
chegar
parents: 47216
diff changeset
    40
                  Appendable destination,
56504
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    41
                  boolean isLast) throws IOException;
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    42
56504
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    43
        /**
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    44
         * Brings this reader to the state it had upon construction.
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    45
         */
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    46
        void reset();
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    47
    }
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    48
56504
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    49
    public interface Writer {
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    50
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    51
        Writer from(CharSequence input, int start, int end);
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    52
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    53
        boolean write(ByteBuffer destination);
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    54
56504
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    55
        /**
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    56
         * Brings this writer to the state it had upon construction.
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    57
         *
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    58
         * @return this writer
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    59
         */
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    60
        Writer reset();
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    61
56504
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    62
        /**
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    63
         * Calculates the number of bytes required to represent a subsequence of
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    64
         * the given {@code CharSequence} using the Huffman coding.
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    65
         *
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    66
         * @param value
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    67
         *         characters
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    68
         * @param start
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    69
         *         the start index, inclusive
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    70
         * @param end
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    71
         *         the end index, exclusive
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    72
         *
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    73
         * @return number of bytes
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    74
         * @throws NullPointerException
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    75
         *         if the value is null
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    76
         * @throws IndexOutOfBoundsException
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    77
         *         if any invocation of {@code value.charAt(i)}, where
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    78
         *         {@code start <= i < end}, throws an IndexOutOfBoundsException
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    79
         */
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    80
        int lengthOf(CharSequence value, int start, int end);
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    81
56504
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    82
        default int lengthOf(CharSequence value) {
dd13fb9f1603 http-client-branch: review comment - HPACK bytewise decoding
prappo
parents: 56451
diff changeset
    83
            return lengthOf(value, 0, value.length());
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    84
        }
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    85
    }
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    86
}