net.sf.staccatocommons.restrictions.processing.EnforceRestrictions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of staccatissimo-restrictions Show documentation

Library of annotations that express restrictions, that can be used to indicate preconditions, postconditions and invariants over objects and messages, focused on documentation reuse.

The newest version!

/**
 *  Copyright (c) 2010-2012, The StaccatoCommons Team
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation; version 3 of the License.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 */

package net.sf.staccatocommons.restrictions.processing;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import net.sf.staccatocommons.restrictions.Restriction;

/**
 * {@link EnforceRestrictions} is a directive for automated annotation processors,
 * indicating that {@link Restriction}s in the annotated element and its
 * descendants must be processed
 * 
 * This annotation is incompatible with {@link IgnoreRestrictions} - an element
 * must not be annotated with {@link IgnoreRestrictions} and
 * {@link EnforceRestrictions} at the same time
 * 
 * @author flbulgarelli
 * @see IgnoreRestrictions
 */
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.TYPE })
public @interface EnforceRestrictions {

}