com.gs.collections.api.factory.stack.ImmutableStackFactory Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Goldman Sachs.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.gs.collections.api.factory.stack;

import com.gs.collections.api.stack.ImmutableStack;

public interface ImmutableStackFactory
{
    /**
     * @since 6.0
     */
     ImmutableStack empty();

    /**
     * Same as {@link #empty()}.
     */
     ImmutableStack of();

    /**
     * Same as {@link #empty()}.
     */
     ImmutableStack with();

    /**
     * Same as {@link #with(Object)}.
     */
     ImmutableStack of(T element);

     ImmutableStack with(T element);

    /**
     * Same as {@link #with(Object[])}.
     */
     ImmutableStack of(T... elements);

     ImmutableStack with(T... elements);

    /**
     * Same as {@link #withAll(Iterable)}.
     */
     ImmutableStack ofAll(Iterable items);

     ImmutableStack withAll(Iterable items);

    /**
     * Same as {@link #withReversed(Object[])}.
     */
     ImmutableStack ofReversed(T... elements);

     ImmutableStack withReversed(T... elements);

    /**
     * Same as {@link #withAllReversed(Iterable)}.
     */
     ImmutableStack ofAllReversed(Iterable items);

     ImmutableStack withAllReversed(Iterable items);
}