KickJava   Java API By Example, From Geeks To Geeks.

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


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 an of clause describing an aspect.
26  * This declaration also contains constants to be used to
27  * identify different OfClauseDocs.
28  *
29  * @author Jeff Palm
30  */
31 public interface OfClauseDoc {
32
33     /**
34      * A typesafe-enum describing the possible kinds
35      * of OfClauseDocs.
36      */
37     public final static class Kind {
38
39         /** Internal representation. */
40         private final String JavaDoc kind;
41
42         /**
43          * Don't allow any other's to call this.
44          *
45          * @param kind The internal String representation.
46          */
47         private Kind(String JavaDoc kind) { this.kind = kind; }
48
49         /**
50          * Represents an 'of eachcflow(..)' clause.
51          */
52         public final static Kind EACH_CFLOW = new Kind("echocflow(..)");
53
54         /**
55          * Represents an 'of eachJVM()' clause.
56          */
57         public final static Kind EACH_JVM = new Kind("eachJVM()");
58         
59         /**
60          * Represents an 'of eachobject(..)' clause.
61          */
62         public final static Kind EACH_OBJECT = new Kind("eachObject()");
63
64         /**
65          * Returns a short representation of the kind.
66          *
67          * @return a short representation of the kind.
68          */
69         public String JavaDoc toString() { return kind; }
70     }
71
72     /**
73      * Returns the appropriate constant defined in Kind.
74      *
75      * @return the appropriate constant defined in Kind.
76      * @see Kind
77      */
78     public Kind kind();
79 }
80
Popular Tags