KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > core > menu > lib > BasicMnemonicDescription


1 /*====================================================================
2
3 Objectweb Explorer Framework
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): Jerome Moroy, Philippe Merle.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26 package org.objectweb.util.explorer.core.menu.lib;
27
28 import org.objectweb.util.explorer.core.common.api.Description;
29 import org.objectweb.util.explorer.core.menu.api.MnemonicDescription;
30
31 /**
32  * Basic implementation of the <code>MnemonicDescription</code> interface.
33  *
34  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>,
35  * <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>.
36  *
37  * @version 0.1
38  */
39 public class BasicMnemonicDescription
40   implements MnemonicDescription
41 {
42
43     //==================================================================
44 //
45 // Internal States.
46 //
47 // ==================================================================
48
49     protected char char_=0;
50     
51     // ==================================================================
52 //
53 // Constructors.
54 //
55 // ==================================================================
56
57     // ==================================================================
58 //
59 // Internal methods.
60 //
61 // ==================================================================
62
63     // ==================================================================
64 //
65 // Public methods for Description interface.
66 //
67 // ==================================================================
68
69     /* (non-Javadoc)
70      * @see org.objectweb.util.explorer.core.common.api.Description#getDescriptionType()
71      */
72     public String JavaDoc getDescriptionType() {
73         return Description.MNEMONIC_DESCRIPTION;
74     }
75
76     /* (non-Javadoc)
77      * @see boolean#isNull()
78      */
79     public boolean isEmpty() {
80         return char_==0;
81     }
82     
83     // ==================================================================
84 //
85 // Public methods for ... interface.
86 //
87 // ==================================================================
88
89     /* (non-Javadoc)
90      * @see org.objectweb.util.explorer.core.menu.api.MnemonicDescription#setMnemonicCharacter(char)
91      */
92     public void setMnemonicCharacter(char car) {
93         char_ = car;
94     }
95
96     /* (non-Javadoc)
97      * @see org.objectweb.util.explorer.core.menu.api.MnemonicDescription#getMnemonicCharacter()
98      */
99     public char getMnemonicCharacter() {
100         return char_;
101     }
102
103     // ==================================================================
104 //
105 // Public methods surcharging Object class.
106 //
107 // ==================================================================
108
109     /**
110      * Surcharging the Object.equals method.
111      * @see Object#equals(java.lang.Object)
112      */
113     public boolean equals(Object JavaDoc o){
114         if(o!=null && o instanceof BasicMnemonicDescription){
115             return (char_==((BasicMnemonicDescription)o).char_);
116         }
117         return false;
118     }
119    
120     /**
121      * Return a String representation of a BasicMnemonicDescription
122      * @see Object#toString()
123      */
124     public String JavaDoc toString(){
125         return "BasicMnemonicDescription[char=" + char_ + "]";
126     }
127     
128 }
129
Popular Tags