a whole bunch of stuff
[ephemerata.git] / Toady / lib / commons-lang-2.4 / apidocs / org / apache / commons / lang / mutable / MutableObject.html
blob5a95bf3703a70259dd169f1b5e4e1c74843ee253
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.4.2_16) on Sat Mar 15 20:43:48 PDT 2008 -->
6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7 <TITLE>
8 MutableObject (Commons Lang 2.4 API)
9 </TITLE>
11 <META NAME="keywords" CONTENT="org.apache.commons.lang.mutable.MutableObject class">
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
15 <SCRIPT type="text/javascript">
16 function windowTitle()
18 parent.document.title="MutableObject (Commons Lang 2.4 API)";
20 </SCRIPT>
22 </HEAD>
24 <BODY BGCOLOR="white" onload="windowTitle();">
27 <!-- ========= START OF TOP NAVBAR ======= -->
28 <A NAME="navbar_top"><!-- --></A>
29 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
30 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
31 <TR>
32 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
33 <A NAME="navbar_top_firstrow"><!-- --></A>
34 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
35 <TR ALIGN="center" VALIGN="top">
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MutableObject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
44 </TR>
45 </TABLE>
46 </TD>
47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48 </EM>
49 </TD>
50 </TR>
52 <TR>
53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54 &nbsp;<A HREF="../../../../../org/apache/commons/lang/mutable/MutableLong.html" title="class in org.apache.commons.lang.mutable"><B>PREV CLASS</B></A>&nbsp;
55 &nbsp;<A HREF="../../../../../org/apache/commons/lang/mutable/MutableShort.html" title="class in org.apache.commons.lang.mutable"><B>NEXT CLASS</B></A></FONT></TD>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
58 &nbsp;<A HREF="MutableObject.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
59 &nbsp;<SCRIPT type="text/javascript">
60 <!--
61 if(window==top) {
62 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
64 //-->
65 </SCRIPT>
66 <NOSCRIPT>
67 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
68 </NOSCRIPT>
70 </FONT></TD>
71 </TR>
72 <TR>
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
76 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
77 </TR>
78 </TABLE>
79 <A NAME="skip-navbar_top"></A>
80 <!-- ========= END OF TOP NAVBAR ========= -->
82 <HR>
83 <!-- ======== START OF CLASS DATA ======== -->
84 <H2>
85 <FONT SIZE="-1">
86 org.apache.commons.lang.mutable</FONT>
87 <BR>
88 Class MutableObject</H2>
89 <PRE>
90 java.lang.Object
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.commons.lang.mutable.MutableObject</B>
92 </PRE>
93 <DL>
94 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/commons/lang/mutable/Mutable.html" title="interface in org.apache.commons.lang.mutable">Mutable</A>, java.io.Serializable</DD>
95 </DL>
96 <HR>
97 <DL>
98 <DT>public class <B>MutableObject</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/commons/lang/mutable/Mutable.html" title="interface in org.apache.commons.lang.mutable">Mutable</A>, java.io.Serializable</DL>
101 A mutable <code>Object</code> wrapper.
105 <DL>
106 <DT><B>Since:</B></DT>
107 <DD>2.1</DD>
108 <DT><B>Version:</B></DT>
109 <DD>$Id: MutableObject.java 437554 2006-08-28 06:21:41Z bayard $</DD>
110 <DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.apache.commons.lang.mutable.MutableObject">Serialized Form</A></DL>
111 <HR>
114 <!-- ======== NESTED CLASS SUMMARY ======== -->
117 <!-- =========== FIELD SUMMARY =========== -->
120 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
122 <A NAME="constructor_summary"><!-- --></A>
123 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
124 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
125 <TD COLSPAN=2><FONT SIZE="+2">
126 <B>Constructor Summary</B></FONT></TD>
127 </TR>
128 <TR BGCOLOR="white" CLASS="TableRowColor">
129 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableObject.html#MutableObject()">MutableObject</A></B>()</CODE>
131 <BR>
132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new MutableObject with the default value of <code>null</code>.</TD>
133 </TR>
134 <TR BGCOLOR="white" CLASS="TableRowColor">
135 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableObject.html#MutableObject(java.lang.Object)">MutableObject</A></B>(java.lang.Object&nbsp;value)</CODE>
137 <BR>
138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new MutableObject with the specified value.</TD>
139 </TR>
140 </TABLE>
141 &nbsp;
142 <!-- ========== METHOD SUMMARY =========== -->
144 <A NAME="method_summary"><!-- --></A>
145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
147 <TD COLSPAN=2><FONT SIZE="+2">
148 <B>Method Summary</B></FONT></TD>
149 </TR>
150 <TR BGCOLOR="white" CLASS="TableRowColor">
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152 <CODE>&nbsp;boolean</CODE></FONT></TD>
153 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableObject.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;obj)</CODE>
155 <BR>
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares this object against the specified object.</TD>
157 </TR>
158 <TR BGCOLOR="white" CLASS="TableRowColor">
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160 <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
161 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableObject.html#getValue()">getValue</A></B>()</CODE>
163 <BR>
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the value.</TD>
165 </TR>
166 <TR BGCOLOR="white" CLASS="TableRowColor">
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168 <CODE>&nbsp;int</CODE></FONT></TD>
169 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableObject.html#hashCode()">hashCode</A></B>()</CODE>
171 <BR>
172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value's hash code or <code>0</code> if the value is <code>null</code>.</TD>
173 </TR>
174 <TR BGCOLOR="white" CLASS="TableRowColor">
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176 <CODE>&nbsp;void</CODE></FONT></TD>
177 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableObject.html#setValue(java.lang.Object)">setValue</A></B>(java.lang.Object&nbsp;value)</CODE>
179 <BR>
180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the value.</TD>
181 </TR>
182 <TR BGCOLOR="white" CLASS="TableRowColor">
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
185 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableObject.html#toString()">toString</A></B>()</CODE>
187 <BR>
188 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the String value of this mutable.</TD>
189 </TR>
190 </TABLE>
191 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
192 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
193 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
194 <TD><B>Methods inherited from class java.lang.Object</B></TD>
195 </TR>
196 <TR BGCOLOR="white" CLASS="TableRowColor">
197 <TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
198 </TR>
199 </TABLE>
200 &nbsp;
203 <!-- ============ FIELD DETAIL =========== -->
206 <!-- ========= CONSTRUCTOR DETAIL ======== -->
208 <A NAME="constructor_detail"><!-- --></A>
209 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
210 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
211 <TD COLSPAN=1><FONT SIZE="+2">
212 <B>Constructor Detail</B></FONT></TD>
213 </TR>
214 </TABLE>
216 <A NAME="MutableObject()"><!-- --></A><H3>
217 MutableObject</H3>
218 <PRE>
219 public <B>MutableObject</B>()</PRE>
220 <DL>
221 <DD>Constructs a new MutableObject with the default value of <code>null</code>.
223 </DL>
224 <HR>
226 <A NAME="MutableObject(java.lang.Object)"><!-- --></A><H3>
227 MutableObject</H3>
228 <PRE>
229 public <B>MutableObject</B>(java.lang.Object&nbsp;value)</PRE>
230 <DL>
231 <DD>Constructs a new MutableObject with the specified value.
233 <DT><B>Parameters:</B><DD><CODE>value</CODE> - a value.</DL>
235 <!-- ============ METHOD DETAIL ========== -->
237 <A NAME="method_detail"><!-- --></A>
238 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
239 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
240 <TD COLSPAN=1><FONT SIZE="+2">
241 <B>Method Detail</B></FONT></TD>
242 </TR>
243 </TABLE>
245 <A NAME="getValue()"><!-- --></A><H3>
246 getValue</H3>
247 <PRE>
248 public java.lang.Object <B>getValue</B>()</PRE>
249 <DL>
250 <DD>Gets the value.
252 <DD><DL>
253 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/lang/mutable/Mutable.html#getValue()">getValue</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/lang/mutable/Mutable.html" title="interface in org.apache.commons.lang.mutable">Mutable</A></CODE></DL>
254 </DD>
255 <DD><DL>
257 <DT><B>Returns:</B><DD>the value</DL>
258 </DD>
259 </DL>
260 <HR>
262 <A NAME="setValue(java.lang.Object)"><!-- --></A><H3>
263 setValue</H3>
264 <PRE>
265 public void <B>setValue</B>(java.lang.Object&nbsp;value)</PRE>
266 <DL>
267 <DD>Sets the value.
269 <DD><DL>
270 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/lang/mutable/Mutable.html#setValue(java.lang.Object)">setValue</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/lang/mutable/Mutable.html" title="interface in org.apache.commons.lang.mutable">Mutable</A></CODE></DL>
271 </DD>
272 <DD><DL>
273 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to set</DL>
274 </DD>
275 </DL>
276 <HR>
278 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
279 equals</H3>
280 <PRE>
281 public boolean <B>equals</B>(java.lang.Object&nbsp;obj)</PRE>
282 <DL>
283 <DD>Compares this object against the specified object. The result is <code>true</code> if and only if the argument
284 is not <code>null</code> and is a <code>MutableObject</code> object that contains the same <code>Object</code>
285 value as this object.
287 <DD><DL>
288 </DL>
289 </DD>
290 <DD><DL>
291 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to compare with.
292 <DT><B>Returns:</B><DD><code>true</code> if the objects are the same; <code>false</code> otherwise.</DL>
293 </DD>
294 </DL>
295 <HR>
297 <A NAME="hashCode()"><!-- --></A><H3>
298 hashCode</H3>
299 <PRE>
300 public int <B>hashCode</B>()</PRE>
301 <DL>
302 <DD>Returns the value's hash code or <code>0</code> if the value is <code>null</code>.
304 <DD><DL>
305 </DL>
306 </DD>
307 <DD><DL>
309 <DT><B>Returns:</B><DD>the value's hash code or <code>0</code> if the value is <code>null</code>.</DL>
310 </DD>
311 </DL>
312 <HR>
314 <A NAME="toString()"><!-- --></A><H3>
315 toString</H3>
316 <PRE>
317 public java.lang.String <B>toString</B>()</PRE>
318 <DL>
319 <DD>Returns the String value of this mutable.
321 <DD><DL>
322 </DL>
323 </DD>
324 <DD><DL>
326 <DT><B>Returns:</B><DD>the mutable value as a string</DL>
327 </DD>
328 </DL>
329 <!-- ========= END OF CLASS DATA ========= -->
330 <HR>
333 <!-- ======= START OF BOTTOM NAVBAR ====== -->
334 <A NAME="navbar_bottom"><!-- --></A>
335 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
336 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
337 <TR>
338 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
339 <A NAME="navbar_bottom_firstrow"><!-- --></A>
340 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
341 <TR ALIGN="center" VALIGN="top">
342 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
343 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
344 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
345 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MutableObject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
346 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
347 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
348 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
349 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
350 </TR>
351 </TABLE>
352 </TD>
353 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
354 </EM>
355 </TD>
356 </TR>
358 <TR>
359 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
360 &nbsp;<A HREF="../../../../../org/apache/commons/lang/mutable/MutableLong.html" title="class in org.apache.commons.lang.mutable"><B>PREV CLASS</B></A>&nbsp;
361 &nbsp;<A HREF="../../../../../org/apache/commons/lang/mutable/MutableShort.html" title="class in org.apache.commons.lang.mutable"><B>NEXT CLASS</B></A></FONT></TD>
362 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
363 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
364 &nbsp;<A HREF="MutableObject.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
365 &nbsp;<SCRIPT type="text/javascript">
366 <!--
367 if(window==top) {
368 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
370 //-->
371 </SCRIPT>
372 <NOSCRIPT>
373 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
374 </NOSCRIPT>
376 </FONT></TD>
377 </TR>
378 <TR>
379 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
380 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
381 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
382 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
383 </TR>
384 </TABLE>
385 <A NAME="skip-navbar_bottom"></A>
386 <!-- ======== END OF BOTTOM NAVBAR ======= -->
388 <HR>
389 Copyright © 2001-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
390 </BODY>
391 </HTML>