KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > ccm > IDL3 > AttributeDecl


1 /*====================================================================
2
3 OpenCCM: The Open CORBA Component Model Platform
4 Copyright (C) 2000-2002 USTL - LIFL - GOAL
5 Contact: openccm-team@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): Philippe Merle, Mathieu Vadet.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.ccm.IDL3;
28
29 /**
30  * This interface manages the Attribute declaration.
31  *
32  * @author <a=href="Philippe.Merle@lifl.fr">Philippe Merle</a>
33  * <a=href="Mathieu.Vadet@lifl.fr">Mathieu Vadet</a>
34  *
35  * @version 0.3
36  */
37
38 public interface AttributeDecl
39        extends Declaration
40 {
41     /** MUST BE REMOVED **/
42     public static int ATTR_NORMAL = org.omg.CORBA.AttributeMode._ATTR_NORMAL;
43
44     /** MUST BE REMOVED **/
45     public static int ATTR_READONLY = org.omg.CORBA.AttributeMode._ATTR_READONLY;
46
47     /**
48      * Set mode as normal.
49      */
50     public void
51     setNormal();
52
53     /**
54      * Set mode as readonly.
55      */
56     public void
57     setReadonly();
58
59     /**
60      * Set the attribute type.
61      *
62      * @param type The TypeRef of the attribute declaration.
63      */
64     public void
65     setType(TypeRef type);
66
67     /**
68      * Obtain the get exceptions list.
69      *
70      * @return The getRaises ExceptionList of the attribute declaration
71      * or null if no exceptions were declared.
72      */
73     public ExceptionList
74     getGetExceptionList();
75
76     /**
77      * Obtain the put exceptions list.
78      *
79      * @return The setRaises (or raises for readonly attributes)
80      * ExceptionList of the attribute declaration
81      * or null if no exceptions were declared.
82      */
83     public ExceptionList
84     getSetExceptionList();
85
86     /**
87      * Obtain the get exceptions list.
88      *
89      * @return The getRaises ExceptionList of the attribute declaration
90      * or null if no exceptions were declared.
91      */
92     public ExceptionDecl[]
93     getGetExceptions();
94
95     /**
96      * Obtain the put exceptions list.
97      *
98      * @return The setRaises (or raises for readonly attributes)
99      * ExceptionList of the attribute declaration or
100      * null if no exceptions were declared.
101      */
102     public ExceptionDecl[]
103     getSetExceptions();
104
105     /**
106      *
107      */
108     public ExceptionDecl[]
109     getExceptions();
110
111     /**
112      * Is a readonly attribute
113      *
114      * @return True if readonly, else false.
115      */
116     public boolean
117     isReadonly();
118
119     /**
120      * Obtain the attribute type.
121      *
122      * @return The attribute type.
123      */
124     public TypeRef
125     getType();
126 }
127
Popular Tags