KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > aspectj > tools > ajdoc > MemberDocImpl


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.tools.ajdoc;
23
24 import org.aspectj.ajdoc.IntroducedDoc;
25 import org.aspectj.ajdoc.MemberDoc;
26
27 public abstract class MemberDocImpl
28     extends ProgramElementDocImpl
29     implements MemberDoc {
30     
31     /**
32      * The introduction that introduces this member
33      * to its enclosing type.
34      */
35     private IntroducedDoc introduced;
36
37     public MemberDocImpl(com.sun.javadoc.ClassDoc containingClass) {
38         super(containingClass);
39     }
40
41     /**
42      * Returns whether the passed in Object is equals
43      * based on type <b>names</b> and the name
44      * of the declaration.
45      *
46      * @return <code>true</code> if the passed in Object
47      * is equal to this based on type names
48      * and field names.
49      */
50     public abstract boolean weakEquals(Object JavaDoc other);
51
52     /**
53      * Sets this member's introduction.
54      *
55      * @param introduced the new introduction.
56      */
57     protected void setIntroduced(IntroducedDoc introduced) {
58         this.introduced = introduced;
59     }
60
61     /**
62      * Returns the introduction that introduced this member onto
63      * its enclosing type -- this value may be <code>null</code>
64      * if the member wasn't introduced.
65      *
66      * @return an IntroducedDoc representing the introduction
67      * that introduced this member onto its enclosing
68      * type. The return value may be <code>null</code>.
69      */
70     public IntroducedDoc introduced() {
71         return introduced;
72     }
73
74     /**
75      * Returns <code>true</code>if this code is <i>synthetic</i>.
76      *
77      * @return <code>true</code>if this code is <i>synthetic</i>.
78      */
79     public boolean isSynthetic() {
80         return (!dec().isLanguageVisible());
81     }
82 }
83
Popular Tags