/*
 * Copyright (c) 2008 Harold Cooper. All rights reserved.
 * Licensed under the MIT License.
 * See LICENSE file in the project root for full license information.
 */

package org.pcollections;

import java.util.Collection;

An immutable, persistent collection of non-null elements of type E.
Author:
harold
Type parameters:
<E> – /**
 * An immutable, persistent collection of non-null elements of type E.
 *
 * @author harold
 * @param <E>
 */
public interface PCollection<E> extends Collection<E> {

  
Params:
e – non-null
Returns:
a collection which contains e and all of the elements of this/**
   * @param e non-null
   * @return a collection which contains e and all of the elements of this
   */
  public PCollection<E> plus(E e);

  
Params:
list – contains no null elements
Returns:
a collection which contains all of the elements of list and this/**
   * @param list contains no null elements
   * @return a collection which contains all of the elements of list and this
   */
  public PCollection<E> plusAll(Collection<? extends E> list);

  
Params:
e – 
Returns:
this with a single instance of e removed, if e is in this/**
   * @param e
   * @return this with a single instance of e removed, if e is in this
   */
  public PCollection<E> minus(Object e);

  
Params:
list – 
Returns:
this with all elements of list completely removed/**
   * @param list
   * @return this with all elements of list completely removed
   */
  public PCollection<E> minusAll(Collection<?> list);

  // TODO public PCollection<E> retainingAll(Collection<?> list);

  @Deprecated
  boolean add(E o);

  @Deprecated
  boolean remove(Object o);

  @Deprecated
  boolean addAll(Collection<? extends E> c);

  @Deprecated
  boolean removeAll(Collection<?> c);

  @Deprecated
  boolean retainAll(Collection<?> c);

  @Deprecated
  void clear();
}