com.cinchapi.common.base.Array Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2013-2017 Cinchapi Inc.
 *
 * 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.cinchapi.common.base;

import java.util.Arrays;

/**
 * Array-related helper functions.
 *
 * @author Jeff Nelson
 */
public final class Array {

    /**
     * Return an array containing all the {@code args}.
     * 
     * This method is just syntactic sugar for easily passing array objects to
     * methods that don't take varargs.
     * 
     * 
     * @param args the elements that should go in the array.
     * @return args
     */
    @SafeVarargs
    public static  T[] containing(T... args) {
        return args;
    }

    /**
     * Return a new array that contains the items in the {@code args} array in
     * reverse order.
     * 
     * @param args
     * @return an array containing the {@code args} in reverse
     */
    @SafeVarargs
    public static  T[] reverse(T... args) {
        T[] copy = Arrays.copyOf(args, args.length);
        reverseInPlace(copy);
        return copy;
    }

    /**
     * Reverse the order of the items in the {@code args} array in-place (e.g.
     * edit the input array).
     * 
     * @param args
     */
    @SafeVarargs
    public static  void reverseInPlace(T... args) {
        for (int i = 0; i < args.length / 2; ++i) {
            T swap = args[i];
            args[i] = args[args.length - i - 1];
            args[args.length - i - 1] = swap;
        }
    }

    private Array() {}

}