org.eclipse.collections.api.stack.StackIterable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipse-collections-api Show documentation
There is a newer version: 12.0.0.M3
Show newest version
/*
 * 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.api.stack;

import java.util.AbstractCollection;
import java.util.List;

import org.eclipse.collections.api.RichIterable;
import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.function.Function2;
import org.eclipse.collections.api.block.function.primitive.BooleanFunction;
import org.eclipse.collections.api.block.function.primitive.ByteFunction;
import org.eclipse.collections.api.block.function.primitive.CharFunction;
import org.eclipse.collections.api.block.function.primitive.DoubleFunction;
import org.eclipse.collections.api.block.function.primitive.FloatFunction;
import org.eclipse.collections.api.block.function.primitive.IntFunction;
import org.eclipse.collections.api.block.function.primitive.LongFunction;
import org.eclipse.collections.api.block.function.primitive.ShortFunction;
import org.eclipse.collections.api.block.predicate.Predicate;
import org.eclipse.collections.api.block.predicate.Predicate2;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.list.ListIterable;
import org.eclipse.collections.api.multimap.list.ListMultimap;
import org.eclipse.collections.api.partition.stack.PartitionStack;
import org.eclipse.collections.api.stack.primitive.BooleanStack;
import org.eclipse.collections.api.stack.primitive.ByteStack;
import org.eclipse.collections.api.stack.primitive.CharStack;
import org.eclipse.collections.api.stack.primitive.DoubleStack;
import org.eclipse.collections.api.stack.primitive.FloatStack;
import org.eclipse.collections.api.stack.primitive.IntStack;
import org.eclipse.collections.api.stack.primitive.LongStack;
import org.eclipse.collections.api.stack.primitive.ShortStack;
import org.eclipse.collections.api.tuple.Pair;

/**
 * StackIterable is a last-in-first-out data structure. All iteration methods iterate from the "top" of the stack to the
 * "bottom". In other words, it processes the most recently added elements first.
 * 
 * For example:
 * 

 * {@link #forEach(Procedure)} iterates over every element, starting with the most recently added
 * 

 * {@link #getFirst()} returns the most recently added element, not the element that was added first
 * 

 * {@link #toString()} follows the same rules as {@link AbstractCollection#toString()} except it processes the elements
 * in the same order as {@code forEach()}.
 */
public interface StackIterable extends RichIterable
{
    /**
     * @return the top of the stack.
     */
    T peek();

    /**
     * @return a ListIterable of the number of elements specified by the count, beginning with the top of the stack.
     */
    ListIterable peek(int count);

    /**
     * @param index the location to peek into
     * @return the element at the specified index
     */
    T peekAt(int index);

    /**
     * Should return the same value as peek().
     */
    T getFirst();

    /**
     * Should not work as it violates the contract of a Stack.
     */
    T getLast();

    /**
     * Follows the same rules as {@link AbstractCollection#toString()} except it processes the elements
     * in the same order as {@code forEach()}.
     */
    String toString();

    /**
     * Follows the same general contract as {@link List#equals(Object)}, but for Stacks.
     */
    boolean equals(Object o);

    /**
     * Follows the same general contract as {@link List#hashCode()}, but for Stacks.
     */
    int hashCode();

    /**
     * Converts the stack to a MutableStack implementation.
     *
     * @since 2.0
     */
    MutableStack toStack();

    StackIterable tap(Procedure procedure);

    StackIterable select(Predicate predicate);

    
 StackIterable selectWith(Predicate2 predicate, P parameter);

    StackIterable reject(Predicate predicate);

    
 StackIterable rejectWith(Predicate2 predicate, P parameter);

    PartitionStack partition(Predicate predicate);

     PartitionStack partitionWith(Predicate2 predicate, P parameter);

     StackIterable collect(Function function);

    BooleanStack collectBoolean(BooleanFunction booleanFunction);

    ByteStack collectByte(ByteFunction byteFunction);

    CharStack collectChar(CharFunction charFunction);

    DoubleStack collectDouble(DoubleFunction doubleFunction);

    FloatStack collectFloat(FloatFunction floatFunction);

    IntStack collectInt(IntFunction intFunction);

    LongStack collectLong(LongFunction longFunction);

    ShortStack collectShort(ShortFunction shortFunction);

     StackIterable collectWith(Function2 function, P parameter);

     StackIterable collectIf(Predicate predicate, Function function);

     StackIterable flatCollect(Function> function);

     ListMultimap groupBy(Function function);

     ListMultimap groupByEach(Function> function);

     StackIterable> zip(Iterable that);

    StackIterable> zipWithIndex();

    /**
     * Converts the StackIterable to an immutable implementation. Returns this for immutable stacks.
     *
     * @since 5.0
     */
    ImmutableStack toImmutable();
}