pascal.taie.util.collection.CollectionUtils 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.util.collection;

import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.function.Predicate;
import java.util.function.ToIntFunction;

/**
 * Utility methods for {@link Collection}.
 * We name it CollectionUtils instead of Collections to avoid name collision
 * with {@link java.util.Collections}.
 */
public final class CollectionUtils {

    private CollectionUtils() {
    }

    /**
     * Iterates the elements in the specific collection, in the order they are
     * returned by the collection's iterator, and finds the first element
     * of given collection that satisfies the predicate. If not such element
     * is found, returns {@code null}.
     */
    @Nullable
    public static  T findFirst(Collection c,
                                  Predicate p) {
        for (T e : c) {
            if (p.test(e)) {
                return e;
            }
        }
        return null;
    }

    /**
     * @return an arbitrary element of the given collection.
     */
    public static  T getOne(Collection c) {
        return c.iterator().next();
    }

    /**
     * Creates a list of given collection, appends a specific element to
     * the list and returns it.
     */
    public static  List append(Collection c, T e) {
        List result = new ArrayList<>(c.size() + 1);
        result.addAll(c);
        result.add(e);
        return result;
    }

    /**
     * Maps each element in given collection to an integer and computes
     * the sum of the integers.
     */
    public static  long sum(Collection c, ToIntFunction toInt) {
        long sum = 0;
        for (var e : c) {
            sum += toInt.applyAsInt(e);
        }
        return sum;
    }

    /**
     * Converts a collection to a string.
     * The elements in the collection are sorted by their
     * string representation (in alphabet order) in the resulting string.
     * This is particularly useful for comparing expected results
     * with the ones given by the analysis.
     */
    public static  String toString(Collection c) {
        return Streams.toString(c.stream());
    }

    /**
     * Converts a collection to a set.
     */
    public static  Set toSet(Collection c) {
        if (c instanceof Set) {
            return Collections.unmodifiableSet((Set) c);
        } else {
            return Collections.unmodifiableSet(Sets.newHybridSet(c));
        }
    }
}