patterntesting.runtime.dbc.Contract Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of patterntesting-rt Show documentation

PatternTesting Runtime (patterntesting-rt) is the runtime component for the PatternTesting framework. It provides the annotations and base classes for the PatternTesting testing framework (e.g. patterntesting-check, patterntesting-concurrent or patterntesting-exception) but can be also used standalone for classpath monitoring or profiling. It uses AOP and AspectJ to perform this feat.

There is a newer version: 2.4.0

Show newest version

/**
 * $Id: Contract.java,v 1.2 2010/06/08 21:32:53 oboehm Exp $
 *
 * Copyright (c) 2008 by Oliver Boehm
 *
 * 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 orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 29.01.2009 by oliver ([email protected])
 */
package patterntesting.runtime.dbc;

/**
 * With this Contract interface you can realize Design-by-Contract, also known
 * as DbC.
 *
 * @author oliver
 * @since 29.01.2009
 * @version $Revision: 1.2 $
 *
 * @{link "http://csd.informatik.uni-oldenburg.de/~jass/ (as another approach for DbC)"}
 */
public interface Contract {

    /**
     * This method checks if the conditions of the invariants are still true.
     * It is evaluated at the end of each method call (e.g. you can think of
     * it as a global postcondition).
     *
     * @return true otherwise the invariant contract was violated
     */
    boolean invariant();

}