pascal.taie.language.generics.ClassGSignature Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tai-e Show documentation
An easy-to-learn/use static analysis framework for Java
The newest version!
/*
 * Tai-e: A Static Analysis Framework for Java
 *
 * Copyright (C) 2022 Tian Tan 
 * Copyright (C) 2022 Yue Li 
 *
 * 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 .
 */


package pascal.taie.language.generics;

import pascal.taie.util.Experimental;

import java.io.Serializable;
import java.util.List;
import java.util.StringJoiner;
import java.util.stream.Collectors;

/**
 * In 
 * JVM Spec. 4.7.9.1 ClassSignature,
 * a class signature encodes type information about a (possibly generic) class
 * or interface declaration. It describes any type parameters of the class or interface,
 * and lists its (possibly parameterized) direct superclass and direct superinterfaces, if any.
 * A type parameter is described by its name, followed by any class bound and interface bounds.
 */
public final class ClassGSignature implements Serializable {

    /**
     * Whether this class signature describes an interface.
     * This field is only used for precise printing.
     *
     * @see #toString()
     */
    private final boolean isInterface;

    private final List typeParams;

    private final ClassTypeGSignature superClass;

    private final List superInterfaces;

    ClassGSignature(boolean isInterface,
                    List typeParams,
                    ClassTypeGSignature superClass,
                    List superInterfaces) {
        this.isInterface = isInterface;
        this.typeParams = List.copyOf(typeParams);
        this.superClass = superClass;
        this.superInterfaces = List.copyOf(superInterfaces);
    }

    @Experimental
    public List getTypeParams() {
        return typeParams;
    }

    @Experimental
    public ClassTypeGSignature getSuperClass() {
        return superClass;
    }

    @Experimental
    public List getSuperInterfaces() {
        return superInterfaces;
    }

    @Override
    public String toString() {
        StringJoiner joiner = new StringJoiner(" ");
        if (!typeParams.isEmpty()) {
            joiner.add(typeParams.stream().map(TypeParameter::toString)
                    .collect(Collectors.joining(", ", "<", ">")));
        }
        if (superClass != null && !superClass.isJavaLangObject()) {
            joiner.add("extends");
            joiner.add(superClass.toString());
        }
        if (!superInterfaces.isEmpty()) {
            joiner.add(isInterface ? "extends" : "implements");
            joiner.add(superInterfaces.stream().map(ClassTypeGSignature::toString)
                    .collect(Collectors.joining(", ")));
        }
        return joiner.toString();
    }

}