KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > core > icon > lib > BasicIconCodeDescription


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