com.github.czyzby.kiwi.util.gdx.collection.GdxSets Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gdx-kiwi Show documentation
Guava-inspired set of utilities for LibGDX.
There is a newer version: 1.9.1.9.6
package com.github.czyzby.kiwi.util.gdx.collection;

import com.badlogic.gdx.utils.Disposable;
import com.badlogic.gdx.utils.ObjectSet;
import com.github.czyzby.kiwi.util.common.UtilitiesClass;
import com.github.czyzby.kiwi.util.gdx.collection.disposable.DisposableObjectSet;
import com.github.czyzby.kiwi.util.gdx.collection.immutable.ImmutableObjectSet;

/** Common {@link ObjectSet} utilities, somewhat inspired by Guava.
 *
 * @author MJ */
public class GdxSets extends UtilitiesClass {
    private GdxSets() {
    }

    /** @return a new, empty ObjectSet.
     * @param  type of stored values. */
    public static  ObjectSet newSet() {
        return new ObjectSet();
    }

    /** @param values will be added to the set.
     * @return a new ObjectSet with the passed values.
     * @param  type of stored values. */
    public static  ObjectSet newSet(final Type... values) {
        final ObjectSet set = new ObjectSet();
        for (final Type value : values) {
            set.add(value);
        }
        return set;
    }

    /** @param values will be added to the set.
     * @return a new ObjectSet with the passed values.
     * @param  type of stored values. */
    public static  ObjectSet newSet(final Iterable values) {
        final ObjectSet set = new ObjectSet();
        for (final Type value : values) {
            set.add(value);
        }
        return set;
    }

    /** @param set will be copied.
     * @return a new disposable set with the passed values.
     * @param  type of stored values. */
    public static  DisposableObjectSet toDisposable(
            final ObjectSet set) {
        return new DisposableObjectSet(set);
    }

    /** @param set will be copied.
     * @return a new semi-immutable set with the passed values.
     * @param  type of stored values. */
    public static  ImmutableObjectSet toImmutable(final ObjectSet set) {
        return new ImmutableObjectSet(set);
    }

    /** @param set can be null.
     * @return true if array is null or has no elements. */
    public static boolean isEmpty(final ObjectSet set) {
        return set == null || set.size == 0;
    }

    /** @param set can be null.
     * @return true if array is not null and has at least one element. */
    public static boolean isNotEmpty(final ObjectSet set) {
        return set != null && set.size > 0;
    }

    /** @param sets cannot be null.
     * @return the biggest size among the passed sets. */
    public static int getBiggestSize(final ObjectSet... sets) {
        int maxSize = 0;
        for (final ObjectSet set : sets) {
            maxSize = Math.max(maxSize, set.size);
        }
        return maxSize;
    }

    /** @param sets cannot be null.
     * @return the biggest size among the passed sets.
     * @param  type of stored values. */
    public static  int getBiggestSize(final Iterable> sets) {
        int maxSize = 0;
        for (final ObjectSet set : sets) {
            maxSize = Math.max(maxSize, set.size);
        }
        return maxSize;
    }

    /** @param set will contain all values that are present in every passed set (excluding this one).
     * @param sets will be intersected.
     * @return first argument set will all intersecting values.
     * @param  type of stored values. */
    public static  ObjectSet intersectTo(final ObjectSet set, final ObjectSet... sets) {
        if (sets == null || sets.length == 0) {
            return set;
        }
        final ObjectSet allValues = union(sets);
        for (final Type value : allValues) {
            if (isPresentInEvery(value, sets)) {
                set.add(value);
            }
        }
        return set;
    }

    /** @param value cannot be null.
     * @param sets will be checked.
     * @return true if passed value is present in all of passed sets.
     * @param  type of stored values. */
    public static  boolean isPresentInEvery(final Type value, final ObjectSet... sets) {
        for (final ObjectSet set : sets) {
            if (!set.contains(value)) {
                return false;
            }
        }
        return true;
    }

    /** @param value cannot be null.
     * @param sets will be checked.
     * @return true if passed value is present in any of passed sets.
     * @param  type of stored values. */
    public static  boolean isPresentInAny(final Type value, final ObjectSet... sets) {
        for (final ObjectSet set : sets) {
            if (set.contains(value)) {
                return true;
            }
        }
        return false;
    }

    /** @param sets cannot be null.
     * @return a new set with all values that are present in all of passed sets.
     * @param  type of stored values. */
    public static  ObjectSet intersect(final ObjectSet... sets) {
        return intersectTo(new ObjectSet(), sets);
    }

    /** @param set will contain all values present in passed sets. Will be returned.
     * @param sets cannot be null.
     * @return first set argument will all values present in other passed sets.
     * @param  type of stored values. */
    public static  ObjectSet unionTo(final ObjectSet set, final ObjectSet... sets) {
        if (sets == null || sets.length == 0) {
            return set;
        }
        for (final ObjectSet unionedSet : sets) {
            set.addAll(unionedSet);
        }
        return set;
    }

    /** @param sets will be merged.
     * @return a new set containing all values present in all of passed sets.
     * @param  type of stored values. */
    public static  ObjectSet union(final ObjectSet... sets) {
        return unionTo(new ObjectSet(), sets);
    }

    /** @param sets will all be cleared, with an additional null-check before the clearing. */
    public static void clearAll(final ObjectSet... sets) {
        for (final ObjectSet set : sets) {
            if (set != null) {
                set.clear();
            }
        }
    }

    /** @param sets all contained sets will all be cleared, with an additional null-check before the clearing. */
    public static void clearAll(final Iterable> sets) {
        for (final ObjectSet set : sets) {
            if (set != null) {
                set.clear();
            }
        }
    }

    /** Static utility for accessing {@link ObjectSet#size} variable (which is kind of ugly, since it allows to easily
     * modify and damage internal collection data). Performs null check.
     *
     * @param set its size will be checked. Can be null.
     * @return current size of the passed set. 0 is set is empty or null. */
    public static int sizeOf(final ObjectSet set) {
        if (set == null) {
            return 0;
        }
        return set.size;
    }
}