EqualToIntValue.java

/* Copyright 2015 Laurent COCAULT
 * Licensed to Laurent COCAULT under one or more contributor license agreements.
 * See the NOTICE file distributed with this work for additional information
 * regarding copyright ownership. Laurent COCAULT licenses this file to You
 * 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 org.csp.constraint.model.integer;

/**
 * Constraint specifying that one specific integer variable is equal to a value.
 */
public class EqualToIntValue extends UnaryIntConstraint {

    /**
     * Constructor of the constraint "VAR = VALUE".
     * @param variable
     *            Variable constrained
     * @param value
     *            Fixed value for the constraint
     */
    public EqualToIntValue(final IntVar variable, final IntValue value) {
        super(variable.getName() + "=" + value, variable, value);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void propagate() {
        getVariable().setValue(getValue());
    }

}