KickJava   Java API By Example, From Geeks To Geeks.

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


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 /**
25  * Represents a class in the aspectj-world. The difference
26  * between this and one in the javac-world, is that a class
27  * may have pointcuts and introductions.
28  *
29  * @author Jeff Palm
30  */
31 public interface ClassDoc extends com.sun.javadoc.ClassDoc,
32                                   ProgramElementDoc, Type {
33
34     /**
35      * Returns the pointcuts this class declares.
36      *
37      * @return an array of PointcutDoc representing the
38      * pointcuts declared by this class.
39      */
40     public PointcutDoc[] pointcuts();
41
42     /**
43      * Returns the introductions made by other aspects that
44      * affect the type hierarchy of this class.
45      *
46      * @return an array of IntroducedSuperDoc representing the
47      * introductions affecting the type hierarchy of
48      * this class.
49      */
50     public IntroducedSuperDoc[] introducers();
51
52     /**
53      * Return <code>true</code> if this is an aspect.
54      *
55      * @return <code>true</code> is this is an aspect.
56      */
57     public boolean isAspect();
58 }
59
Popular Tags