tech.sirwellington.alchemy.arguments.Arguments Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemy-arguments Show documentation

Part of the Alchemy Collection. Easy, Simple, and Robust argument checking logic for your Services, Libraries, and Scripts.

There is a newer version: 2.3

Show newest version

/*
 * Copyright 2015 SirWellington Tech.
 *
 * 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 tech.sirwellington.alchemy.arguments;

import java.util.ArrayList;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import tech.sirwellington.alchemy.annotations.access.NonInstantiable;
import tech.sirwellington.alchemy.annotations.arguments.Nullable;
import tech.sirwellington.alchemy.annotations.designs.FluidAPIDesign;

import static java.util.Arrays.asList;

/**
 * This is the main entry-point for the Library.
 * 

 * From here you can do:
 *  * {@code
 * checkThat(zipCode)
 .throwing(ex -> new InvalidZipCodeException(zipCode))
 .is(notNull())
 .is(positiveInteger())
 .is(intAtLeast(10000))
 .is(intAtMost(99999));
 }
 * 
 *
 * @author SirWellington
 */
@NonInstantiable
@FluidAPIDesign
public final class Arguments
{

    private final static Logger LOG = LoggerFactory.getLogger(Arguments.class);

    Arguments() throws IllegalAccessException
    {
        throw new IllegalAccessException("cannot instantiate class");
    }

    /**
     * Begin assertions on a single argument.
     *
     * @param  The type of the argument
     * @param argument   The argument itself
     *
     * @return An object that allows building assertions on the argument.
     */
    public static  AssertionBuilder checkThat(@Nullable Argument argument)
    {
        return AssertionBuilderImpl.checkThat(asList(argument));
    }

    /**
     * Begin assertions on multiple arguments.
     *
     * @param  The type of the arguments
     * @param argument   The first argument.
     * @param others     The rest of the argument to perform checks on.
     *
     * @return An object that allows building assertions on the arguments.
     */
    public static  AssertionBuilder checkThat(@Nullable Argument argument, Argument... others)
    {
        List listOfArguments = new ArrayList<>();
        listOfArguments.add(argument);
        if (others != null)
        {
            listOfArguments.addAll(asList(others));
        }
        return AssertionBuilderImpl.checkThat(listOfArguments);
    }

}