com.github.andrewoma.dexx.collection.Builder Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2014 Andrew O'Malley
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.github.andrewoma.dexx.collection;

import org.jetbrains.annotations.NotNull;

import java.util.Iterator;

/**
 * {@code Builders} provide efficient implementations for incrementally building persistent collections.
 *
 * It should be assumed that Builders are NOT thread safe. Furthermore, it is invalid to call
 * {@link #build()} more than once.
 */
public interface Builder {
    @NotNull
    Builder add(E element);

    @NotNull
    Builder addAll(@NotNull Traversable elements);

    @NotNull
    Builder addAll(@NotNull java.lang.Iterable elements);

    @NotNull
    Builder addAll(@NotNull Iterator iterator);

    @NotNull
    Builder addAll(E e1, E e2, E... es);

    @NotNull
    R build();
}