/*
 * 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.classes;

import pascal.taie.language.annotation.AnnotationHolder;
import pascal.taie.language.generics.ClassGSignature;
import pascal.taie.language.type.ClassType;

import javax.annotation.Nullable;
import java.util.Collection;
import java.util.Set;

/**
 * Each JClassBuilder builds one JClass.
 * TODO: make the relation between JClassBuilder and JClass explicit.
 */
public interface JClassBuilder {

    void build(JClass jclass);

    Set<Modifier> getModifiers();

    String getSimpleName();

    ClassType getClassType();

    JClass getSuperClass();

    Collection<JClass> getInterfaces();

    JClass getOuterClass();

    Collection<JField> getDeclaredFields();

    Collection<JMethod> getDeclaredMethods();

    AnnotationHolder getAnnotationHolder();

    /**
     * @return true if this class is application class, otherwise false.
     */
    boolean isApplication();

    /**
     * @return true if this class is phantom class, otherwise false.
     */
    boolean isPhantom();

    /**
     * @return the signature attribute for dealing with generics
     * starting from Java 1.5.
     * @see ClassGSignature
     */
    @Nullable
    ClassGSignature getGSignature();
}
