KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > kilim > description > NamedElement


1 /**
2  * Copyright (C) 2002 Kelua SA
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  */
18 package org.objectweb.kilim.description;
19
20 import org.objectweb.kilim.KilimException;
21
22 /**
23  * Named elements are template elements that have a name and a status
24  * (which is one of KILIM.PUBLIC, KILIM.PROTECTED, KILIM.PRIVATE).
25  * @author horn
26  */
27 public interface NamedElement extends TemplateElement {
28     /**
29      * returns the name of the element.
30      * @return String
31      */
32     String JavaDoc getLocalName();
33
34     /**
35      * sets a name to the element.
36      * @param aName : the name to be set
37      * @throws KilimException : generated when aName is null.
38      */
39     void setLocalName(String JavaDoc aName) throws KilimException;
40     
41     /**
42      * returns the status of the element.
43      * @return int. The value is one of KILIM.PRIVATE, KILIM.PROTECTED, KILIM.PUBLIC.
44      */
45     int getStatus();
46
47     /**
48      * sets the element status.
49      * @param aStatus : The value must be one of KILIM.PRIVATE, KILIM.PROTECTED, KILIM.PUBLIC.
50      * @throws KilimException generated if the value for aStatus is not valid.
51      */
52     void setStatus(int aStatus) throws KilimException;
53 }
54
Popular Tags