KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > openccm > pss > generator > common > api > StateMemberMapping


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.pss.generator.common.api;
28
29 //Package dependencies
30 import org.objectweb.openccm.ast.api.StorageTypeStateMemberDecl;
31 import org.objectweb.openccm.generator.translator.idl2java.api.PSDL_JavaTranslator;
32 import org.objectweb.openccm.generator.java.ast.api.InterfaceObject;
33 import org.objectweb.openccm.generator.java.ast.api.ClassObject;
34 import org.objectweb.openccm.generator.java.ast.api.MethodObject;
35
36
37 /**
38  * This is the interface for State Member Mapping.
39  *
40  * @author <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</a>
41  *
42  * @version 0.1
43  */
44
45 public interface StateMemberMapping
46 {
47     /**
48      * Set the State Memeber to map.
49      *
50      * @param state - The State Member to map.
51      */
52     public void
53     setStateMember(StorageTypeStateMemberDecl state);
54
55     /**
56      * Map the name of the state member.
57      *
58      * @return The name of the mapping attribute.
59      */
60     public String JavaDoc
61     mapStateName();
62
63     /**
64      * Map a Storage Type State Member.
65      *
66      * @param translator - A Java utility class to translate types.
67      * @param obj - The StorageType mapping object.
68      * @param finalAccessor - True if accessors must be final.
69      */
70     public void
71     toJavaAccessors(PSDL_JavaTranslator translator,
72                     InterfaceObject obj,
73                     boolean finalAccessor);
74
75     /**
76      * Map a Read Only Storage Type State Member to a user non-available modifier.
77      *
78      * @param translator - A Java utility class to translate types.
79      * @param clazz - The StorageType mapping object.
80      */
81     public void
82     toJavaReadOnlyStateMemberModifier(
83             PSDL_JavaTranslator translator,
84             ClassObject clazz);
85
86     /**
87      * Map a Storage Type State Member to an attribute.
88      *
89      * @param translator - A Java utility class to translate types.
90      * @param clazz - The StorageType mapping object.
91      * @param st - The StorageType declaration.
92      */
93     public void
94     toJavaAttribute(PSDL_JavaTranslator translator,
95                     ClassObject clazz,
96                     org.objectweb.openccm.ast.api.StorageTypeDecl st);
97
98     /**
99      * Map a state member to a java parmeter.
100      *
101      * @param translator - A Java utility class to translate types.
102      * @param method - The method that will contain parameters.
103      **/
104     public void
105     toJavaParameter(PSDL_JavaTranslator translator,
106                     MethodObject method);
107 }
108
Popular Tags