org.eclipse.collections.impl.collection.mutable.CollectionAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipse-collections Show documentation
There is a newer version: 12.0.0.M3
/*
 * Copyright (c) 2015 Goldman Sachs.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v. 1.0 which accompany this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 */

package org.eclipse.collections.impl.collection.mutable;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.RandomAccess;
import java.util.Set;

import org.eclipse.collections.api.collection.ImmutableCollection;
import org.eclipse.collections.api.collection.MutableCollection;
import org.eclipse.collections.api.list.MutableList;
import org.eclipse.collections.api.set.MutableSet;
import org.eclipse.collections.impl.block.factory.Comparators;
import org.eclipse.collections.impl.block.procedure.CollectionAddProcedure;
import org.eclipse.collections.impl.block.procedure.CollectionRemoveProcedure;
import org.eclipse.collections.impl.factory.Lists;
import org.eclipse.collections.impl.factory.Sets;
import org.eclipse.collections.impl.list.mutable.ArrayListAdapter;
import org.eclipse.collections.impl.list.mutable.FastList;
import org.eclipse.collections.impl.list.mutable.ListAdapter;
import org.eclipse.collections.impl.list.mutable.RandomAccessListAdapter;
import org.eclipse.collections.impl.set.mutable.SetAdapter;
import org.eclipse.collections.impl.set.mutable.UnifiedSet;
import org.eclipse.collections.impl.utility.ArrayIterate;
import org.eclipse.collections.impl.utility.Iterate;

/**
 * This class provides a MutableCollection interface wrapper around a JDK Collections Collection interface instance.  All
 * of the MutableCollection interface methods are supported in addition to the JDK Collection interface methods.
 * 
 * To create a new instance that wraps a collection with the MutableSet interface, use the {@link #wrapSet(Iterable)}
 * factory method.  To create a new instance that wraps a collection with the MutableList interface, use the
 * {@link #wrapList(Iterable)} factory method.  To wrap a collection with the MutableCollection interface alone, use
 * the {@link #adapt(Collection)} factory method.
 */
public final class CollectionAdapter
        extends AbstractCollectionAdapter
        implements Serializable
{
    private static final long serialVersionUID = 1L;
    private final Collection delegate;

    public CollectionAdapter(Collection newDelegate)
    {
        if (newDelegate == null)
        {
            throw new NullPointerException("CollectionAdapter may not wrap null");
        }
        this.delegate = newDelegate;
    }

    @Override
    protected Collection getDelegate()
    {
        return this.delegate;
    }

    public MutableCollection asUnmodifiable()
    {
        return UnmodifiableMutableCollection.of(this);
    }

    public MutableCollection asSynchronized()
    {
        return SynchronizedMutableCollection.of(this);
    }

    public ImmutableCollection toImmutable()
    {
        return this.delegate instanceof Set
                ? Sets.immutable.withAll(this.delegate)
                : Lists.immutable.withAll(this.delegate);
    }

    public static  MutableSet wrapSet(Iterable iterable)
    {
        if (iterable instanceof MutableSet)
        {
            return (MutableSet) iterable;
        }
        if (iterable instanceof Set)
        {
            return SetAdapter.adapt((Set) iterable);
        }
        return UnifiedSet.newSet(iterable);
    }

    public static  MutableList wrapList(Iterable iterable)
    {
        if (iterable instanceof MutableList)
        {
            return (MutableList) iterable;
        }
        if (iterable instanceof ArrayList)
        {
            return ArrayListAdapter.adapt((ArrayList) iterable);
        }
        if (iterable instanceof RandomAccess)
        {
            return RandomAccessListAdapter.adapt((List) iterable);
        }
        if (iterable instanceof List)
        {
            return ListAdapter.adapt((List) iterable);
        }
        return FastList.newList(iterable);
    }

    public static  MutableCollection adapt(Collection collection)
    {
        if (collection instanceof MutableCollection)
        {
            return (MutableCollection) collection;
        }
        if (collection instanceof List)
        {
            return CollectionAdapter.wrapList(collection);
        }
        if (collection instanceof Set)
        {
            return SetAdapter.adapt((Set) collection);
        }
        return new CollectionAdapter(collection);
    }

    @Override
    public boolean equals(Object o)
    {
        if (this == o)
        {
            return true;
        }
        if (o == null || this.getClass() != o.getClass())
        {
            return false;
        }

        CollectionAdapter that = (CollectionAdapter) o;
        return Comparators.nullSafeEquals(this.delegate, that.delegate);
    }

    @Override
    public int hashCode()
    {
        return this.delegate.hashCode();
    }

    public CollectionAdapter with(T... elements)
    {
        ArrayIterate.forEach(elements, new CollectionAddProcedure(this.delegate));
        return this;
    }

    public CollectionAdapter with(T element)
    {
        this.delegate.add(element);
        return this;
    }

    public CollectionAdapter without(T element)
    {
        this.delegate.remove(element);
        return this;
    }

    public CollectionAdapter withAll(Iterable elements)
    {
        Iterate.forEach(elements, new CollectionAddProcedure(this.delegate));
        return this;
    }

    public CollectionAdapter withoutAll(Iterable elements)
    {
        Iterate.forEach(elements, new CollectionRemoveProcedure(this.delegate));
        return this;
    }

    /**
     * @deprecated use {@link FastList#newList()} or {@link UnifiedSet#newSet()} instead
     */
    @Deprecated
    public MutableCollection newEmpty()
    {
        if (this.delegate instanceof Set)
        {
            return UnifiedSet.newSet();
        }
        return Lists.mutable.empty();
    }
}