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

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

import net.sf.staccatocommons.restrictions.Restriction;

/**
 * A check annotation that signals that the annotated element must have an given
 * size or length.
 * 
 * This annotation should only be applied to elements that understand a length
 * or size attribute, or length, or size method, like {@link Collections},
 * {@link String}s, arrays and SizeAware's from Staccato-Commons-Defs
 * 
 * @author flbulgarelli
 * @see Restriction
 */
@Restriction
@Documented
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.PARAMETER, ElementType.FIELD, ElementType.METHOD })
public @interface Size {

  /**
   * @return The variable name of the constrained element, or the empty string
   *         if unspecified. This value may help tools that analyze this
   *         annotation without access to source code.
   */
  String var() default "";

  /**
   * @return the size the annotated element must have
   */
  int value();
}