KickJava   Java API By Example, From Geeks To Geeks.

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


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.Type;
25
26 /**
27  * Documentation for a piece of advice.
28  *
29  * @author Jeff Palm
30  */
31 public interface AdviceDoc extends ExecutableMemberDoc,
32                                    com.sun.javadoc.ExecutableMemberDoc {
33     /**
34      * Returns <code>true</code> if the advice is <code>abstract</code>.
35      *
36      * @return <code>true</code> if the advice is <code>abstract</code>.
37      */
38     public boolean isAbstract();
39
40     /**
41      * Returns a {@link #AspectDoc} representing the aspect
42      * that is overriden by this advice.
43      *
44      * @return a AspectDoc representing the aspect
45      * that is overriden by this advice.
46      */
47     public AspectDoc overriddenAspect();
48
49     /**
50      * Returns the return type of this advice -- it may be null.
51      *
52      * @return the return type of this advice -- it may be null.
53      */
54     public Type returnType();
55
56     /**
57      * Returns the array of docs this advice crosscuts.
58      *
59      * @return an array of docs this advice crosscuts.
60      */
61     public com.sun.javadoc.ExecutableMemberDoc[] crosscuts();
62
63     /**
64      * Returns <code>true</code> if this is <code>throwing</code> advice.
65      *
66      * @return <code>true</code> if this is <code>throwing</code> advice.
67      */
68     public boolean isThrowing();
69     
70     /**
71      * Returns <code>true</code> if this is <code>returning</code> advice.
72      *
73      * @return <code>true</code> if this is <code>returning</code> advice.
74      */
75     public boolean isReturning();
76
77     /**
78      * Returns the extra formal type that's the optional type
79      * to <code>after returning</code> or <code>after throwing</code>
80      * advice.
81      *
82      * @return an instance of Type that represents the the extra formal type
83      * that's the optional type to <code>after returning</code> or
84      * <code>after throwing</code> advice.
85      */
86     public Type extraType();
87 }
88
Popular Tags