net.sf.staccatocommons.restrictions.Conditionally 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;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Collections;

import net.sf.staccatocommons.restrictions.value.Unmodifiable;

/**
 * {@link Conditionally} is a restriction modifier that indicates that an
 * objects may meet set of restrictions depending on some condition. There are
 * two standard scenarios:
 * 
 * When the object's class has generic type parameter, and the set of
 * restrictions depend on the concrete type used
 * When the object has as configurable attributes - subject to dependency
 * injection - and the type of such attributes does not make any assumptions
 * about such restrictions, perhaps they are specified in its subtypes or it
 * depends on instances
 * 
 * 
 * Types annotated as {@link Conditionally} denote that all their instances
 * grant to conditionally meet the set constraints, depending on the attributes
 * injected by constructor or setters, or in its constructor type parameters.
 * Methods annotated as {@link Unmodifiable} denote that all the objects
 * returned by them conditionally meet the set constraints, depending on the
 * method type parametrization, the receptor object {@code this} and arguments.
 * 
 * 
 * Typical example of @Conditionally(Immutable.class) objects are
 * Lists returned by {@link Collections#singletonList(Object)}, which are
 * immutable as long as its argument is immutable too.
 * 
 * 
 * @author flbulgarelli
 */
@Documented
@Inherited
@Restriction
@Retention(RetentionPolicy.SOURCE)
@Target({ ElementType.TYPE, ElementType.METHOD })
public @interface Conditionally {

  /**
   * An array with interfaces and/or restriction annotations
   */
  Class[] value();
}