de.viadee.rules.Conclusions.java Source code

Introduction

Here is the source code for de.viadee.rules.Conclusions.java

Source

/*
 * Project: viaRules
 * Package: de.viadee.rules
 * File   : Conclusions.java
 * Created: Nov 10, 2010 - 5:55:55 PM
 *
 *
 * Copyright 2010 viadee IT Unternehmensberatung GmbH
 *
 * 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 de.viadee.rules;

import java.util.Collection;
import java.util.Iterator;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;

import de.viadee.rules.implementation.CompositeConclusion;

/**
 * <p>Utility class which helps creating new {@link Conclusion conclusions}.</p>
 * 
 * @author  Sebastian Ho (sebastian.hoss@viadee.de)
 * @since   1.0.0
 */
public final class Conclusions {

    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
    // *                                                 CONSTRUCTORS                                                *
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

    /**
     * Hidden constructor.
     */
    private Conclusions() {
        // do nothing
    }

    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
    // *                                                    METHODS                                                  *
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

    /**
     * <p>
     * Creates a new {@link Conclusion} which encapsulates all given conclusions.
     * </p>
     * 
     * @param <T>           The topic of the inference process.
     * @param conclusions   The conclusions to group (<b>may not be <code>null</code> nor empty</b>).
     * @return              A new conclusion builder.
     */
    public static <T> Conclusion<T> conclude(final Collection<? extends Conclusion<T>> conclusions) {
        // Check inputs
        Preconditions.checkNotNull(conclusions);
        Preconditions.checkArgument(!conclusions.isEmpty());

        // Create composition
        return new CompositeConclusion<T>(ImmutableList.copyOf(conclusions));
    }

    /**
     * <p>
     * Creates a new {@link Conclusion} which encapsulates all given conclusions.
     * </p>
     * 
     * @param <T>           The topic of the inference process.
     * @param conclusion1   The first conclusion to use (<b>may not be <code>null</code></b>).
     * @param conclusion2   The second conclusion to use (<b>may not be <code>null</code></b>).
     * @return              A new conclusion builder.
     */
    public static <T> Conclusion<T> conclude(final Conclusion<T> conclusion1, final Conclusion<T> conclusion2) {
        // Check inputs
        Preconditions.checkNotNull(conclusion1);
        Preconditions.checkNotNull(conclusion2);

        // Create composition
        return new CompositeConclusion<T>(ImmutableList.of(conclusion1, conclusion2));
    }

    /**
     * <p>
     * Creates a new {@link Conclusion} which encapsulates all given conclusions.
     * </p>
     * 
     * @param <T>           The topic of the inference process.
     * @param conclusions   The conclusions to group (<b>may not be <code>null</code> nor empty</b>).
     * @return              A new conclusion builder.
     */
    public static <T> Conclusion<T> conclude(final Iterable<? extends Conclusion<T>> conclusions) {
        // Check inputs
        Preconditions.checkNotNull(conclusions);
        Preconditions.checkArgument(!Iterables.isEmpty(conclusions));

        // Create composition
        return new CompositeConclusion<T>(ImmutableList.copyOf(conclusions));
    }

    /**
     * <p>
     * Creates a new {@link Conclusion} which encapsulates all given conclusions.
     * </p>
     * 
     * @param <T>           The topic of the inference process.
     * @param conclusions   The conclusions to group (<b>may not be <code>null</code> nor empty</b>).
     * @return              A new conclusion builder.
     */
    public static <T> Conclusion<T> conclude(final Iterator<? extends Conclusion<T>> conclusions) {
        // Check inputs
        Preconditions.checkNotNull(conclusions);
        Preconditions.checkArgument(conclusions.hasNext());

        // Create composition
        return new CompositeConclusion<T>(ImmutableList.copyOf(conclusions));
    }

}