Java Collection Clear clear(Collection collection)

Description

Removes all elements from the given collection.

License

Open Source License

Parameter

Parameter	Description
collection	The collection to be cleared.
E	The component type of the collection.

Return

The cleared collection.

Declaration

public static <E> Collection<E> clear(Collection<E> collection) 

Method Source Code

//package com.java2s;
/*/*from ww  w. j  a va 2  s  . c  o m*/
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Lachlan Dowding
 *
 * 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.
 */

import java.util.Collection;

public class Main {
    /**
     * Removes all elements from the given collection.
     *
     * @param collection    The collection to be cleared.
     * @param <E>           The component type of the collection.
     * @return              The cleared collection.
     */
    public static <E> Collection<E> clear(Collection<E> collection) {
        if (collection != null) {
            collection.clear();
        }
        return collection;
    }
}

Related

1. cleanup(AnyCollection collection)
2. clear(Collection collection)
3. clear(Collection collection)
4. clear(final Collection collection)
5. clearAndAddAll(final Collection where, final Collection fromWhere)
6. clearCollection(Collection collection)