src/jdk.internal.vm.compiler/share/classes/org.graalvm.util/src/org/graalvm/util/OptionsEncoder.java
author dlong
Thu, 31 Oct 2019 16:54:16 -0700
changeset 58877 aec7bf35d6f5
permissions -rw-r--r--
8233273: Update Graal Reviewed-by: kvn
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58877
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
     1
/*
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
     2
 * Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved.
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
     4
 *
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
     7
 * published by the Free Software Foundation.
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
     8
 *
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    13
 * accompanied this code).
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    14
 *
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    18
 *
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    21
 * questions.
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    22
 */
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    23
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    24
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    25
package org.graalvm.util;
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    26
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    27
import java.io.ByteArrayInputStream;
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    28
import java.io.ByteArrayOutputStream;
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    29
import java.io.IOException;
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    30
import java.util.LinkedHashMap;
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    31
import java.util.Map;
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    32
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    33
/**
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    34
 * Facilities for encoding/decoding a set of options to/from a byte array.
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    35
 */
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    36
public final class OptionsEncoder {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    37
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    38
    private OptionsEncoder() {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    39
    }
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    40
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    41
    /**
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    42
     * Determines if {@code value} is supported by {@link #encode(Map)}.
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    43
     */
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    44
    public static boolean isValueSupported(Object value) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    45
        return TypedDataOutputStream.isValueSupported(value);
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    46
    }
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    47
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    48
    /**
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    49
     * Encodes {@code options} into a byte array.
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    50
     *
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    51
     * @throws IllegalArgumentException if any value in {@code options} is not
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    52
     *             {@linkplain #isValueSupported(Object) supported}
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    53
     */
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    54
    public static byte[] encode(final Map<String, Object> options) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    55
        try (ByteArrayOutputStream baout = new ByteArrayOutputStream()) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    56
            try (TypedDataOutputStream out = new TypedDataOutputStream(baout)) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    57
                out.writeInt(options.size());
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    58
                for (Map.Entry<String, Object> e : options.entrySet()) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    59
                    out.writeUTF(e.getKey());
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    60
                    try {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    61
                        out.writeTypedValue(e.getValue());
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    62
                    } catch (IllegalArgumentException iae) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    63
                        throw new IllegalArgumentException(String.format("Key: %s, Value: %s, Value type: %s",
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    64
                                        e.getKey(), e.getValue(), e.getValue().getClass()), iae);
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    65
                    }
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    66
                }
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    67
            }
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    68
            return baout.toByteArray();
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    69
        } catch (IOException ioe) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    70
            throw new IllegalArgumentException(ioe);
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    71
        }
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    72
    }
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    73
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    74
    /**
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    75
     * Decodes {@code input} into a name/value map.
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    76
     *
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    77
     * @throws IllegalArgumentException if {@code input} cannot be decoded
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    78
     */
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    79
    public static Map<String, Object> decode(byte[] input) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    80
        Map<String, Object> res = new LinkedHashMap<>();
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    81
        try (TypedDataInputStream in = new TypedDataInputStream(new ByteArrayInputStream(input))) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    82
            final int size = in.readInt();
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    83
            for (int i = 0; i < size; i++) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    84
                final String key = in.readUTF();
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    85
                final Object value = in.readTypedValue();
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    86
                res.put(key, value);
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    87
            }
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    88
            if (in.available() != 0) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    89
                throw new IllegalArgumentException(in.available() + " undecoded bytes");
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    90
            }
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    91
        } catch (IOException ioe) {
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    92
            throw new IllegalArgumentException(ioe);
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    93
        }
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    94
        return res;
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    95
    }
aec7bf35d6f5 8233273: Update Graal
dlong
parents:
diff changeset
    96
}