org.aspectj.weaver.tools.PointcutDesignatorHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation

Tools from the AspectJ project

There is a newer version: 1.9.22.1

/* *******************************************************************
 * Copyright (c) 2005 Contributors.
 * All rights reserved.
 * This program and the accompanying materials are made available
 * under the terms of the Eclipse Public License v 2.0
 * which accompanies this distribution and is available at
 * https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt
 *
 * Contributors:
 *   Adrian Colyer			Initial implementation
 * ******************************************************************/
package org.aspectj.weaver.tools;


/**
 * The PointcutDesignator interface allows extension of the
 * AspectJ pointcut language so that third-party tools integrating
 * with AspectJ can add easily their own custom
 * domain-specific designators and have them interoperate seamlessly
 * with the standard AspectJ designators.
 *
 * A pointcut designator can only be used for matching, not for
 * binding.
 */
public interface PointcutDesignatorHandler {

	/**
	 * The name of this pointcut designator. For example,
	 * if this designator handles a "bean(<NamePattern>)
	 * format designator, this method would return "bean".
	 * @return
	 */
	String getDesignatorName() ;

	/**
	 * Parse the given expression string
	 * and return a ContextBasedMatcher that can be used
	 * for matching.
	 * @param expression  the body of the pointcut expression.
	 * For example, given the expression "bean(*DAO)" the parse
	 * method will be called with the argument "*DAO".
	 * @return a pointcut expression that can be used for
	 * matching.
	 * @throws IllegalArgumentException if the expression
	 * is ill-formed.
	 */
	ContextBasedMatcher parse(String expression);

}