KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > openccm > generator > java > ast > api > ObjectBase


1 /*====================================================================
2
3 OpenCCM: The Open CORBA Component Model Platform
4 Copyright (C) 2000-2004 INRIA & USTL - LIFL - GOAL
5 Contact: openccm@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Christophe Demarey.
23 Contributor(s): ________________________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.openccm.generator.java.ast.api;
28
29 import org.objectweb.openccm.generator.java.ast.lib.ModifierKindImpl;
30 import java.util.ArrayList JavaDoc;
31
32 /**
33  * This is a base interface for java Objects.
34  *
35  * @author <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</A>
36  */
37
38 public interface ObjectBase
39 {
40     /**
41      * Add a comment.
42      *
43      * @param comment - The comment to add.
44      */
45     public void
46     addComment(String JavaDoc comment);
47
48     /**
49      * Get all comments.
50      *
51      * @return The list of comments.
52      */
53     public ArrayList JavaDoc
54     getComments();
55
56     /**
57      * Set its name.
58      *
59      * @param name - The name to set.
60      */
61     public void
62     setName(String JavaDoc name);
63
64     /**
65      * Obtain its name.
66      *
67      * @return Its name.
68      */
69     public String JavaDoc
70     getName();
71
72     /**
73      * Set its modifier.
74      *
75      * @param mk - The modifier to set.
76      */
77     public void
78     setModifier(ModifierKindImpl mk);
79
80     /**
81      * Obtain its modifier.
82      *
83      * @return Its modifier.
84      */
85     public ModifierKindImpl
86     getModifier();
87
88     /**
89      * Set final this object.
90      *
91      * @param b - The value to set.
92      */
93     public void
94     setFinal(boolean b);
95
96     /**
97      * Is this object final ?
98      *
99      * @return True if it is final, else false.
100      */
101     public boolean
102     isFinal();
103 }
104
Popular Tags