Open Source Repository

Home /spring/spring-aop-3.0.5 | Repository Home



org/springframework/aop/Pointcut.java
/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.aop;

/**
 * Core Spring pointcut abstraction.
 *
 <p>A pointcut is composed of a {@link ClassFilter} and a {@link MethodMatcher}.
 * Both these basic terms and a Pointcut itself can be combined to build up combinations
 * (e.g. through {@link org.springframework.aop.support.ComposablePointcut}).
 *
 @author Rod Johnson
 @see ClassFilter
 @see MethodMatcher
 @see org.springframework.aop.support.Pointcuts
 @see org.springframework.aop.support.ClassFilters
 @see org.springframework.aop.support.MethodMatchers
 */
public interface Pointcut {

  /**
   * Return the ClassFilter for this pointcut.
   @return the ClassFilter (never <code>null</code>)
   */
  ClassFilter getClassFilter();

  /**
   * Return the MethodMatcher for this pointcut.
   @return the MethodMatcher (never <code>null</code>)
   */
  MethodMatcher getMethodMatcher();


  /**
   * Canonical Pointcut instance that always matches.
   */
  Pointcut TRUE = TruePointcut.INSTANCE;

}