001    /*--------------------------------------------------------------------------+
002    $Id: ILocalConstraint.java 26283 2010-02-18 11:18:57Z juergens $
003    |                                                                          |
004    | Copyright 2005-2010 Technische Universitaet Muenchen                     |
005    |                                                                          |
006    | Licensed under the Apache License, Version 2.0 (the "License");          |
007    | you may not use this file except in compliance with the License.         |
008    | You may obtain a copy of the License at                                  |
009    |                                                                          |
010    |    http://www.apache.org/licenses/LICENSE-2.0                            |
011    |                                                                          |
012    | Unless required by applicable law or agreed to in writing, software      |
013    | distributed under the License is distributed on an "AS IS" BASIS,        |
014    | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
015    | See the License for the specific language governing permissions and      |
016    | limitations under the License.                                           |
017    +--------------------------------------------------------------------------*/
018    package edu.tum.cs.commons.constraint;
019    
020    /**
021     * Interface of a constraint checking a local property, i.e. one that can be
022     * verified by only seeing one object. A constraint usually should be stateless.
023     * 
024     * @param <T>
025     *            the type of object being checked by the constraint.
026     * 
027     * @author hummelb
028     * @author $Author: juergens $
029     * @version $Rev: 26283 $
030     * @levd.rating GREEN Hash: 92D35FD04ECF2EB71E20CF1FA5E2CD24
031     */
032    public interface ILocalConstraint<T> {
033    
034            /**
035             * Checks this constraint and throws an exception only if the constraint is
036             * violated for the object.
037             * 
038             * @param object
039             *            the object to be checked by this constraint.
040             * 
041             * @throws ConstraintViolationException
042             *             if the constraint was violated.
043             */
044            void checkLocalConstraint(T object) throws ConstraintViolationException;
045    }