pascal.taie.analysis.pta.toolkit.CollectionMethods 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.analysis.pta.toolkit;

import pascal.taie.language.classes.ClassHierarchy;
import pascal.taie.language.classes.JClass;
import pascal.taie.language.classes.JMethod;
import pascal.taie.util.collection.Sets;

import java.util.Collection;
import java.util.Set;
import java.util.function.Predicate;
import java.util.stream.Collectors;

/**
 * Computes collection methods in the program.
 */
public class CollectionMethods {

    /**
     * Collection base classes.
     */
    private static final Set COLLECTION_BASES = Set.of(
            "java.util.Collection", "java.util.Map", "java.util.Dictionary");

    /**
     * Collection utility classes.
     */
    private static final Set COLLECTION_UTILS = Set.of(
            "java.util.Collections", "java.util.Arrays");

    private final ClassHierarchy hierarchy;

    public CollectionMethods(ClassHierarchy hierarchy) {
        this.hierarchy = hierarchy;
    }

    /**
     * @return set of collection methods in the program.
     */
    public Set get() {
        Set collectionClasses = Sets.newSet();
        COLLECTION_BASES.stream()
                .map(hierarchy::getJREClass)
                .map(hierarchy::getAllSubclassesOf)
                .flatMap(Collection::stream)
                .filter(Predicate.not(this::isExcluded))
                .forEach(collectionClasses::add);
        COLLECTION_UTILS.stream()
                .map(hierarchy::getJREClass)
                .forEach(collectionClasses::add);
        Set allCollectionClasses = Sets.newSet(collectionClasses);
        collectionClasses.forEach(c ->
                allCollectionClasses.addAll(getAllInnerClassesOf(c)));
        return allCollectionClasses.stream()
                .map(JClass::getDeclaredMethods)
                .flatMap(Collection::stream)
                .collect(Collectors.toUnmodifiableSet());
    }

    private boolean isExcluded(JClass jclass) {
        return jclass.isApplication() &&
                getAllInnerClassesOf(jclass).size() > 10;
    }

    private Set getAllInnerClassesOf(JClass jclass) {
        Set innerClasses = Sets.newHybridSet();
        hierarchy.getDirectInnerClassesOf(jclass).forEach(inner -> {
            innerClasses.add(inner);
            innerClasses.addAll(getAllInnerClassesOf(inner));
        });
        return innerClasses;
    }
}