KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > aspectj > ajdoc > PointcutDoc


1 /* -*- Mode: JDE; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2  *
3  * This file is part of the debugger and core tools for the AspectJ(tm)
4  * programming language; see http://aspectj.org
5  *
6  * The contents of this file are subject to the Mozilla Public License
7  * Version 1.1 (the "License"); you may not use this file except in
8  * compliance with the License. You may obtain a copy of the License at
9  * either http://www.mozilla.org/MPL/ or http://aspectj.org/MPL/.
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the
14  * License.
15  *
16  * The Original Code is AspectJ.
17  *
18  * The Initial Developer of the Original Code is Xerox Corporation. Portions
19  * created by Xerox Corporation are Copyright (C) 1999-2002 Xerox Corporation.
20  * All Rights Reserved.
21  */
22 package org.aspectj.ajdoc;
23
24 import com.sun.javadoc.ClassDoc;
25
26 import com.sun.javadoc.Type;
27
28 /**
29  * Represents a pointcut in the aspectj-world.
30  *
31  * @author Jeff Palm
32  */
33 public interface PointcutDoc extends ExecutableMemberDoc,
34                                      com.sun.javadoc.ExecutableMemberDoc
35 {
36     /**
37      * Returns the resulting type of this pointcut.
38      *
39      * @return an instance of Type representing the type
40      * this pointcut returns.
41      */
42     public Type resultType();
43
44     /**
45      * The nearest class in which this pointcut was defined.
46      *
47      * @return an instanceof ClassDoc representing the
48      * nearst class in which this pointcut was
49      * defined.
50      */
51     public ClassDoc overriddenClass();
52
53     /**
54      * Returns <code>true</code> if this pointcut
55      * is <code>abstract</code>.
56      *
57      * @return <code>true</code> if this pointcut
58      * is <code>abstract</code>.
59      */
60     public boolean isAbstract();
61 }
62
Popular Tags