/*
 * 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;
import java.util.List;

An immutable, persistent indexed collection.
Author:
harold
Type parameters:
<E> – /**
 * An immutable, persistent indexed collection.
 *
 * @author harold
 * @param <E>
 */
public interface PSequence<E> extends PCollection<E>, List<E> {

  // @Override
  public PSequence<E> plus(E e);

  // @Override
  public PSequence<E> plusAll(Collection<? extends E> list);

  
Params:
i – 
e – 
Throws:
IndexOutOfBOundsException – if i<0 || i>=this.size()
Returns:
a sequence consisting of the elements of this with e replacing the element at index i./**
   * @param i
   * @param e
   * @return a sequence consisting of the elements of this with e replacing the element at index i.
   * @throws IndexOutOfBOundsException if i&lt;0 || i&gt;=this.size()
   */
  public PSequence<E> with(int i, E e);

  
Params:
i – 
e – non-null
Throws:
IndexOutOfBOundsException – if i<0 || i>this.size()
Returns:
a sequence consisting of the elements of this with e inserted at index i./**
   * @param i
   * @param e non-null
   * @return a sequence consisting of the elements of this with e inserted at index i.
   * @throws IndexOutOfBOundsException if i&lt;0 || i&gt;this.size()
   */
  public PSequence<E> plus(int i, E e);

  
Params:
i – 
list – 
Throws:
IndexOutOfBOundsException – if i<0 || i>this.size()
Returns:
a sequence consisting of the elements of this with list inserted at index i./**
   * @param i
   * @param list
   * @return a sequence consisting of the elements of this with list inserted at index i.
   * @throws IndexOutOfBOundsException if i&lt;0 || i&gt;this.size()
   */
  public PSequence<E> plusAll(int i, Collection<? extends E> list);

  
Returns a sequence consisting of the elements of this without the first occurrence of e. /** Returns a sequence consisting of the elements of this without the first occurrence of e. */
  // @Override
  public PSequence<E> minus(Object e);

  // @Override
  public PSequence<E> minusAll(Collection<?> list);

  
Params:
i – 
Throws:
IndexOutOfBOundsException – if i<0 || i>=this.size()
Returns:
a sequence consisting of the elements of this with the element at index i removed./**
   * @param i
   * @return a sequence consisting of the elements of this with the element at index i removed.
   * @throws IndexOutOfBOundsException if i&lt;0 || i&gt;=this.size()
   */
  public PSequence<E> minus(int i);

  // @Override
  public PSequence<E> subList(int start, int end);

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

  @Deprecated
  E set(int index, E element);

  @Deprecated
  void add(int index, E element);

  @Deprecated
  E remove(int index);
}