KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > browser > core > naming > AbstractObject


1 /*===========================================================================
2
3 ObjectWeb Util API
4 Copyright (C) 2002 USTL - LIFL - GOAL
5 Contact: architecture@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.
23 Contributor(s): ______________________________________.
24
25 ===========================================================================*/
26
27 package org.objectweb.util.browser.core.naming;
28
29 /**
30  * Abstract base class.
31  *
32  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>
33  * @version 0.1
34  */
35 abstract public class AbstractObject {
36
37     // ==================================================================
38 //
39 // No internal state.
40 //
41 // ==================================================================
42
43     // ==================================================================
44 //
45 // No constructors.
46 //
47 // ==================================================================
48
49     // ==================================================================
50 //
51 // No internal methods.
52 //
53 // ==================================================================
54
55     // ==================================================================
56 //
57 // Public methods for class Object.
58 //
59 // ==================================================================
60
61     /**
62      * Returns a string representation of the target entry.
63      *
64      * By default:
65      * getClass().getName() + '[' + { name=value } + ']'
66      *
67      * @return A string representation of the target entry.
68      */
69     public String JavaDoc toString() {
70         // The string buffer into the string representation is appended.
71 StringBuffer JavaDoc sb = new StringBuffer JavaDoc();
72         // Appends the full class name.
73 sb.append(getClass().getName());
74         sb.append('[');
75         // Appends internal state to the string buffer.
76 toStringBuffer(sb);
77         sb.append(']');
78         return sb.toString();
79     }
80
81     // ==================================================================
82 //
83 // Public methods.
84 //
85 // ==================================================================
86
87     /**
88      * Appends internal state representation into a given string buffer.
89      *
90      * This method does not update the target object.
91      *
92      * @param sb The string buffer where pairs <name,value> are appended.
93      *
94      * @postcondition isNotModified();
95      */
96     abstract public void toStringBuffer(StringBuffer JavaDoc sb);
97
98 }
99
Popular Tags