1  /*
     2   * Copyright the original author or authors.
     3   * 
     4   * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   * 
     8   *      http://www.mozilla.org/MPL/MPL-1.1.html
     9   * 
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  import org.as2lib.core.BasicInterface;
    18  import org.as2lib.aop.JoinPoint;
    19  
    20  /**
    21   * {@code Pointcut} represents a pointcut in an Aspect-Oriented Programming Language
    22   * like AspectJ. A pointcut is basically a pattern that can be matched against a join
    23   * point to check whether the join point is captured. Whether it is captured depends
    24   * on the pointcut pattern, which means on the characteristics of the join point.
    25   *
    26   * @author Simon Wacker
    27   * @see <a href="http://www.simonwacker.com/blog/archives/000043.php">Pointcuts</a>
    28   */
    29  interface org.as2lib.aop.Pointcut extends BasicInterface {
    30  	
    31  	/**
    32  	 * Checks if the given {@code joinPoint} is captured by this pointcut.
    33  	 *
    34  	 * @param joinPoint the join point upon which to make the check
    35  	 * @return {@code true} if the given {@code joinPoint} is captured by this pointcut
    36  	 * else {@code false}
    37  	 */
    38  	public function captures(joinPoint:JoinPoint):Boolean;
    39  	
    40  }