org.parallelj.Capacity Maven / Gradle / Ivy

Go to download
/*
 *     ParallelJ, framework for parallel computing
 *
 *     Copyright (C) 2010, 2011, 2012 Atos Worldline or third-party contributors as
 *     indicated by the @author tags or express copyright attribution
 *     statements applied by the authors.
 *
 *     This library 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; either
 *     version 2.1 of the License.
 *
 *     This library 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.
 *
 *     You should have received a copy of the GNU Lesser General Public
 *     License along with this library; if not, write to the Free Software
 *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
package org.parallelj;

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;

/**
 * Capacity of a {@link Program} or a procedure.
 * 
 * If placed on a class definition, it corresponds to the number of procedure
 * calls that can run in parallel.
 * 
 * If placed on a entry method, it corresponds to the number of calls of that
 * procedure that can run in parallel for an instance of a {@link Program}.
 * 
 * On class definition, the default value is {@link Short#MAX_VALUE}. On method,
 * the default value is 1.
 * 
 * @author Atos Worldline
 * @since 0.3.0
 * 
 */
@Documented
@Target( { ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface Capacity {

	/**
	 * The capacity of the element.
	 * 
	 * @return the capacity of the element.
	 */
	short value() default 0;
}