org.conqat.lib.commons.constraint.ILocalConstraint Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of teamscale-lib-commons Show documentation

Provides common utility functions

There is a newer version: 2024.7.2

Show newest version

/*
 * Copyright (c) CQSE 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 org.conqat.lib.commons.constraint;

/**
 * Interface of a constraint checking a local property, i.e. one that can be verified by only seeing
 * one object. A constraint usually should be stateless.
 * 
 * @param 
 *            the type of object being checked by the constraint.
 * 
 * @author hummelb
 */
public interface ILocalConstraint {

	/**
	 * Checks this constraint and throws an exception only if the constraint is violated for the object.
	 * 
	 * @param object
	 *            the object to be checked by this constraint.
	 * 
	 * @throws ConstraintViolationException
	 *             if the constraint was violated.
	 */
	void checkLocalConstraint(T object) throws ConstraintViolationException;
}