de.rwth.swc.coffee4j.model.constraints.ConstraintBuilder Maven / Gradle / Ivy
package de.rwth.swc.coffee4j.model.constraints;
import de.rwth.swc.coffee4j.engine.util.Preconditions;
import java.util.Arrays;
import java.util.List;
/**
* Convenience methods for creating constraints on up to six parameters. For all numbers of parameters this works by
* the same schema. First, a number of parameters is given, then a {@link BooleanFunction1} (with the corresponding
* number at the end) is required as a constraint function.
*/
public final class ConstraintBuilder {
private ConstraintBuilder() {
}
/**
* Starts the build process for a constraint on one parameter.
*
* @param firstParameter the name of the first parameter. Must not be {@code null}
* @return a builder for defining the corresponding {@link ConstraintFunction}
*/
public static Constraint1Builder constrain(String firstParameter) {
return new Constraint1Builder(toNonNullContainingList(firstParameter));
}
private static List toNonNullContainingList(String... parameterNames) {
Preconditions.notNull(parameterNames);
final List list = Arrays.asList(parameterNames);
Preconditions.check(!list.contains(null));
return list;
}
/**
* Starts the build process for a constraint on two parameters.
*
* @param firstParameter the name of the first parameter. Must not be {@code null}
* @param secondParameter the name of the second parameter. Must not be {@code null}
* @return a builder for defining the corresponding {@link ConstraintFunction}
*/
public static Constraint2Builder constrain(String firstParameter, String secondParameter) {
return new Constraint2Builder(toNonNullContainingList(firstParameter, secondParameter));
}
/**
* Starts the build process for a constraint on three parameters.
*
* @param firstParameter the name of the first parameter. Must not be {@code null}
* @param secondParameter the name of the second parameter. Must not be {@code null}
* @param thirdParameter the name of the third parameter. Must not be {@code null}
* @return a builder for defining the corresponding {@link ConstraintFunction}
*/
public static Constraint3Builder constrain(String firstParameter, String secondParameter, String thirdParameter) {
return new Constraint3Builder(toNonNullContainingList(firstParameter, secondParameter, thirdParameter));
}
/**
* Starts the build process for a constraint on four parameters.
*
* @param firstParameter the name of the first parameter. Must not be {@code null}
* @param secondParameter the name of the second parameter. Must not be {@code null}
* @param thirdParameter the name of the third parameter. Must not be {@code null}
* @param fourthParameter the name of the fourth parameter. Must not be {@code null}
* @return a builder for defining the corresponding {@link ConstraintFunction}
*/
public static Constraint4Builder constrain(String firstParameter, String secondParameter, String thirdParameter, String fourthParameter) {
return new Constraint4Builder(toNonNullContainingList(firstParameter, secondParameter, thirdParameter, fourthParameter));
}
/**
* Starts the build process for a constraint on five parameters.
*
* @param firstParameter the name of the first parameter. Must not be {@code null}
* @param secondParameter the name of the second parameter. Must not be {@code null}
* @param thirdParameter the name of the third parameter. Must not be {@code null}
* @param fourthParameter the name of the fourth parameter. Must not be {@code null}
* @param fifthParameter the name of the fifth parameter. Must not be {@code null}
* @return a builder for defining the corresponding {@link ConstraintFunction}
*/
public static Constraint5Builder constrain(String firstParameter, String secondParameter, String thirdParameter, String fourthParameter, String fifthParameter) {
return new Constraint5Builder(toNonNullContainingList(firstParameter, secondParameter, thirdParameter, fourthParameter, fifthParameter));
}
/**
* Starts the build process for a constraint on sic parameters.
*
* @param firstParameter the name of the first parameter. Must not be {@code null}
* @param secondParameter the name of the second parameter. Must not be {@code null}
* @param thirdParameter the name of the third parameter. Must not be {@code null}
* @param fourthParameter the name of the fourth parameter. Must not be {@code null}
* @param fifthParameter the name of the fifth parameter. Must not be {@code null}
* @param sixthParameter the name of the sixth parameter. Must not be {@code null}
* @return a builder for defining the corresponding {@link ConstraintFunction}
*/
public static Constraint6Builder constrain(String firstParameter, String secondParameter, String thirdParameter, String fourthParameter, String fifthParameter, String sixthParameter) {
return new Constraint6Builder(toNonNullContainingList(firstParameter, secondParameter, thirdParameter, fourthParameter, fifthParameter, sixthParameter));
}
/**
* Builder for giving a constraint on one parameter the corresponding {@link BooleanFunction1}.
*/
public static final class Constraint1Builder {
private final List parameterNames;
private Constraint1Builder(List parameterNames) {
this.parameterNames = parameterNames;
}
/**
* Specified the {@link ConstraintFunction} as a {@link BooleanFunction1} for the given parameter.
*
* @param constraint the constraint function on the parameter
* @return a constraint with the given parameter and constraint function
*/
public Constraint by(BooleanFunction1 constraint) {
Preconditions.notNull(constraint);
return new Constraint(parameterNames, constraint);
}
}
/**
* Builder for giving a constraint on two parameters the corresponding {@link BooleanFunction2}.
*/
public static final class Constraint2Builder {
private final List parameterNames;
private Constraint2Builder(List parameterNames) {
this.parameterNames = parameterNames;
}
/**
* Specified the {@link ConstraintFunction} as a {@link BooleanFunction2} for the given parameters.
*
* @param constraint the constraint function on the parameters
* @return a constraint with the given parameters and constraint function
*/
public Constraint by(BooleanFunction2 constraint) {
Preconditions.notNull(constraint);
return new Constraint(parameterNames, constraint);
}
}
/**
* Builder for giving a constraint on three parameters the corresponding {@link BooleanFunction3}.
*/
public static final class Constraint3Builder {
private final List parameterNames;
private Constraint3Builder(List parameterNames) {
this.parameterNames = parameterNames;
}
/**
* Specified the {@link ConstraintFunction} as a {@link BooleanFunction3} for the given parameters.
*
* @param constraint the constraint function on the parameters
* @return a constraint with the given parameters and constraint function
*/
public Constraint by(BooleanFunction3 constraint) {
Preconditions.notNull(constraint);
return new Constraint(parameterNames, constraint);
}
}
/**
* Builder for giving a constraint on four parameters the corresponding {@link BooleanFunction4}.
*/
public static final class Constraint4Builder {
private final List parameterNames;
private Constraint4Builder(List parameterNames) {
this.parameterNames = parameterNames;
}
/**
* Specified the {@link ConstraintFunction} as a {@link BooleanFunction4} for the given parameters.
*
* @param constraint the constraint function on the parameters
* @return a constraint with the given parameters and constraint function
*/
public Constraint by(BooleanFunction4 constraint) {
Preconditions.notNull(constraint);
return new Constraint(parameterNames, constraint);
}
}
/**
* Builder for giving a constraint on five parameters the corresponding {@link BooleanFunction5}.
*/
public static final class Constraint5Builder {
private final List parameterNames;
private Constraint5Builder(List parameterNames) {
this.parameterNames = parameterNames;
}
/**
* Specified the {@link ConstraintFunction} as a {@link BooleanFunction5} for the given parameters.
*
* @param constraint the constraint function on the parameters
* @return a constraint with the given parameters and constraint function
*/
public Constraint by(BooleanFunction5 constraint) {
Preconditions.notNull(constraint);
return new Constraint(parameterNames, constraint);
}
}
/**
* Builder for giving a constraint on six parameters the corresponding {@link BooleanFunction6}.
*/
public static final class Constraint6Builder {
private final List parameterNames;
private Constraint6Builder(List parameterNames) {
this.parameterNames = parameterNames;
}
/**
* Specified the {@link ConstraintFunction} as a {@link BooleanFunction6} for the given parameters.
*
* @param constraint the constraint function on the parameters
* @return a constraint with the given parameters and constraint function
*/
public Constraint by(BooleanFunction6 constraint) {
Preconditions.notNull(constraint);
return new Constraint(parameterNames, constraint);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy