/*
 * Copyright (c) 2020 Goldman Sachs and others.
 * 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.factory.list.primitive;

import org.eclipse.collections.api.IntIterable;
import org.eclipse.collections.api.list.primitive.MutableIntList;
import java.util.stream.IntStream;

A factory which creates instances of type MutableIntList. This file was automatically generated from template file mutablePrimitiveListFactory.stg. 
Since:
6.0./**
 * A factory which creates instances of type {@link MutableIntList}.
 * This file was automatically generated from template file mutablePrimitiveListFactory.stg.
 *
 * @since 6.0.
 */
public interface MutableIntListFactory
{
    MutableIntList empty();

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

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

    
Same as empty(). but takes in an initial capacity 
Since:
10.3/**
     * Same as {@link #empty()}. but takes in an initial capacity
     * @since 10.3
     */
    default MutableIntList withInitialCapacity(int capacity)
    {
        throw new UnsupportedOperationException("Default method to ensure backwards compatibility");
    }

    
Same as with(int[]). /**
     * Same as {@link #with(int[])}.
     */
    MutableIntList of(int... items);

    
Creates a new list using the passed items argument as the backing store. 

!!! WARNING: This method uses the passed in array, so can be very unsafe if the original
array is held onto anywhere else. !!!
/**
     * Creates a new list using the passed {@code items} argument as the backing store.
     * <p>
     * !!! WARNING: This method uses the passed in array, so can be very unsafe if the original
     * array is held onto anywhere else. !!!
     */
    MutableIntList with(int... items);

    
Creates a new list by first copying the array passed in.
/**
     * Creates a new list by first copying the array passed in.
     */
    default MutableIntList wrapCopy(int... array)
    {
        int[] newArray = new int[array.length];
        System.arraycopy(array, 0, newArray, 0, array.length);
        return this.with(newArray);
    }

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

    MutableIntList withAll(IntIterable items);

    
Same as withAll(Iterable<Integer>). /**
     * Same as {@link #withAll(Iterable)}.
     */
    MutableIntList ofAll(Iterable<Integer> iterable);

    MutableIntList withAll(Iterable<Integer> iterable);

    
Since:
9.0/**
     * @since 9.0
     */
    MutableIntList ofAll(IntStream items);

    
Since:
9.0/**
     * @since 9.0
     */
    MutableIntList withAll(IntStream items);
}