com.smartsheet.api.models.ListBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation

Library for connecting to Smartsheet Services

There is a newer version: 3.2.1

/*
 * Copyright (C) 2023 Smartsheet
 *
 * 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.smartsheet.api.models;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

/**
 * Simple class that makes creating type safe lists of object easier
 */
public class ListBuilder {
    private List list;

    /**
     * Default constructor
     */
    public ListBuilder() {
    }

    /**
     * Constructor
     * @param initialCapacity Initial capacity of the internal storage of the list.
     */
    public ListBuilder(int initialCapacity) {
        this.list = new ArrayList<>(initialCapacity);
    }

    /**
     * Adds a single element to the list
     * @param element element to add
     * @return ListBuilder
     */
    public ListBuilder add(T element) {
        list.add(element);
        return this;
    }

    /**
     * Adds multiple elements to the list
     * @param elements elements to add
     * @return ListBuilder
     */
    public ListBuilder add(T... elements) {
        Collections.addAll(list, elements);
        return this;
    }

    /**
     * Adds multiple elements to the list
     * @param elements elements to add
     * @return ListBuilder
     */
    public ListBuilder add(Collection elements) {
        list.addAll(elements);
        return this;
    }

    /**
     * Retrieves the built up list of objects
     * @return The build up list of objects
     */
    public List build() {
        return list;
    }
}