/*
 * Tai-e: A Static Analysis Framework for Java
 *
 * Copyright (C) 2022 Tian Tan <tiantan@nju.edu.cn>
 * Copyright (C) 2022 Yue Li <yueli@nju.edu.cn>
 *
 * This file is part of Tai-e.
 *
 * Tai-e is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tai-e 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 Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Tai-e. If not, see <https://www.gnu.org/licenses/>.
 */


package pascal.taie.language.generics;

/**
 * In <a href="https://docs.oracle.com/javase/specs/jvms/se20/html/jvms-4.html#jvms-VoidDescriptor">
 * JVM Spec. 4.3.3 VoidDescriptor</a>,
 * The <i>void</i> descriptor indicates that the method returns no value.
 */
public enum VoidDescriptor implements TypeGSignature {

    VOID('V', "void");

    /**
     * Descriptor of this type.
     */
    private final char descriptor;

    /**
     * Name of this type.
     */
    private final String name;

    VoidDescriptor(char descriptor, String name) {
        this.descriptor = descriptor;
        this.name = name;
    }

    public static boolean isVoid(char descriptor) {
        return descriptor == VOID.descriptor;
    }

    @Override
    public String toString() {
        return "void";
    }

}
