?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
a whole bunch of stuff
[ephemerata.git] / Toady / lib / commons-lang-2.4 / apidocs / org / apache / commons / lang / mutable / MutableDouble.html
blob177dec021c91c8ce0c5520d301e822dbc883d3fc
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 MutableDouble (Commons Lang 2.4 API)
9 </TITLE>
10
11 <META NAME="keywords" CONTENT="org.apache.commons.lang.mutable.MutableDouble class">
12
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15 <SCRIPT type="text/javascript">
16 function windowTitle()
17 {
18 parent.document.title="MutableDouble (Commons Lang 2.4 API)";
19 }
20 </SCRIPT>
21
22 </HEAD>
23
24 <BODY BGCOLOR="white" onload="windowTitle();">
25
26
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/MutableDouble.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>
51
52 <TR>
53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54 &nbsp;<A HREF="../../../../../org/apache/commons/lang/mutable/MutableByte.html" title="class in org.apache.commons.lang.mutable"><B>PREV CLASS</B></A>&nbsp;
55 &nbsp;<A HREF="../../../../../org/apache/commons/lang/mutable/MutableFloat.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="MutableDouble.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>');
63 }
64 //-->
65 </SCRIPT>
66 <NOSCRIPT>
67 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
68 </NOSCRIPT>
69
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 ========= -->
81
82 <HR>
83 <!-- ======== START OF CLASS DATA ======== -->
84 <H2>
85 <FONT SIZE="-1">
86 org.apache.commons.lang.mutable</FONT>
87 <BR>
88 Class MutableDouble</H2>
89 <PRE>
90 java.lang.Object
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by">java.lang.Number
92 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.commons.lang.mutable.MutableDouble</B>
93 </PRE>
94 <DL>
95 <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Comparable, <A HREF="../../../../../org/apache/commons/lang/mutable/Mutable.html" title="interface in org.apache.commons.lang.mutable">Mutable</A>, java.io.Serializable</DD>
96 </DL>
97 <HR>
98 <DL>
99 <DT>public class <B>MutableDouble</B><DT>extends java.lang.Number<DT>implements java.lang.Comparable, <A HREF="../../../../../org/apache/commons/lang/mutable/Mutable.html" title="interface in org.apache.commons.lang.mutable">Mutable</A></DL>
100
101 <P>
102 A mutable <code>double</code> wrapper.
103 <P>
104
105 <P>
106 <DL>
107 <DT><B>Since:</B></DT>
108 <DD>2.1</DD>
109 <DT><B>Version:</B></DT>
110 <DD>$Id: MutableDouble.java 618693 2008-02-05 16:33:29Z sebb $</DD>
111 <DT><B>See Also:</B><DD><CODE>Double</CODE>,
112 <A HREF="../../../../../serialized-form.html#org.apache.commons.lang.mutable.MutableDouble">Serialized Form</A></DL>
113 <HR>
114
115 <P>
116 <!-- ======== NESTED CLASS SUMMARY ======== -->
117
118
119 <!-- =========== FIELD SUMMARY =========== -->
120
121
122 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
123
124 <A NAME="constructor_summary"><!-- --></A>
125 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
127 <TD COLSPAN=2><FONT SIZE="+2">
128 <B>Constructor Summary</B></FONT></TD>
129 </TR>
130 <TR BGCOLOR="white" CLASS="TableRowColor">
131 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#MutableDouble()">MutableDouble</A></B>()</CODE>
132
133 <BR>
134 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new MutableDouble with the default value of zero.</TD>
135 </TR>
136 <TR BGCOLOR="white" CLASS="TableRowColor">
137 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#MutableDouble(double)">MutableDouble</A></B>(double&nbsp;value)</CODE>
138
139 <BR>
140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new MutableDouble with the specified value.</TD>
141 </TR>
142 <TR BGCOLOR="white" CLASS="TableRowColor">
143 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#MutableDouble(java.lang.Number)">MutableDouble</A></B>(java.lang.Number&nbsp;value)</CODE>
144
145 <BR>
146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new MutableDouble with the specified value.</TD>
147 </TR>
148 </TABLE>
149 &nbsp;
150 <!-- ========== METHOD SUMMARY =========== -->
151
152 <A NAME="method_summary"><!-- --></A>
153 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
154 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
155 <TD COLSPAN=2><FONT SIZE="+2">
156 <B>Method Summary</B></FONT></TD>
157 </TR>
158 <TR BGCOLOR="white" CLASS="TableRowColor">
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160 <CODE>&nbsp;void</CODE></FONT></TD>
161 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#add(double)">add</A></B>(double&nbsp;operand)</CODE>
162
163 <BR>
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a value.</TD>
165 </TR>
166 <TR BGCOLOR="white" CLASS="TableRowColor">
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168 <CODE>&nbsp;void</CODE></FONT></TD>
169 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#add(java.lang.Number)">add</A></B>(java.lang.Number&nbsp;operand)</CODE>
170
171 <BR>
172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a value.</TD>
173 </TR>
174 <TR BGCOLOR="white" CLASS="TableRowColor">
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176 <CODE>&nbsp;int</CODE></FONT></TD>
177 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#compareTo(java.lang.Object)">compareTo</A></B>(java.lang.Object&nbsp;obj)</CODE>
178
179 <BR>
180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares this mutable to another in ascending order.</TD>
181 </TR>
182 <TR BGCOLOR="white" CLASS="TableRowColor">
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184 <CODE>&nbsp;void</CODE></FONT></TD>
185 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#decrement()">decrement</A></B>()</CODE>
186
187 <BR>
188 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decrements the value.</TD>
189 </TR>
190 <TR BGCOLOR="white" CLASS="TableRowColor">
191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192 <CODE>&nbsp;double</CODE></FONT></TD>
193 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#doubleValue()">doubleValue</A></B>()</CODE>
194
195 <BR>
196 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of this MutableDouble as a double.</TD>
197 </TR>
198 <TR BGCOLOR="white" CLASS="TableRowColor">
199 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200 <CODE>&nbsp;boolean</CODE></FONT></TD>
201 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;obj)</CODE>
202
203 <BR>
204 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares this object against the specified object.</TD>
205 </TR>
206 <TR BGCOLOR="white" CLASS="TableRowColor">
207 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208 <CODE>&nbsp;float</CODE></FONT></TD>
209 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#floatValue()">floatValue</A></B>()</CODE>
210
211 <BR>
212 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of this MutableDouble as a float.</TD>
213 </TR>
214 <TR BGCOLOR="white" CLASS="TableRowColor">
215 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216 <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
217 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#getValue()">getValue</A></B>()</CODE>
218
219 <BR>
220 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the value as a Double instance.</TD>
221 </TR>
222 <TR BGCOLOR="white" CLASS="TableRowColor">
223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224 <CODE>&nbsp;int</CODE></FONT></TD>
225 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#hashCode()">hashCode</A></B>()</CODE>
226
227 <BR>
228 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a suitable hashcode for this mutable.</TD>
229 </TR>
230 <TR BGCOLOR="white" CLASS="TableRowColor">
231 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232 <CODE>&nbsp;void</CODE></FONT></TD>
233 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#increment()">increment</A></B>()</CODE>
234
235 <BR>
236 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increments the value.</TD>
237 </TR>
238 <TR BGCOLOR="white" CLASS="TableRowColor">
239 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240 <CODE>&nbsp;int</CODE></FONT></TD>
241 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#intValue()">intValue</A></B>()</CODE>
242
243 <BR>
244 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of this MutableDouble as a int.</TD>
245 </TR>
246 <TR BGCOLOR="white" CLASS="TableRowColor">
247 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248 <CODE>&nbsp;boolean</CODE></FONT></TD>
249 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#isInfinite()">isInfinite</A></B>()</CODE>
250
251 <BR>
252 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks whether the double value is infinite.</TD>
253 </TR>
254 <TR BGCOLOR="white" CLASS="TableRowColor">
255 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256 <CODE>&nbsp;boolean</CODE></FONT></TD>
257 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#isNaN()">isNaN</A></B>()</CODE>
258
259 <BR>
260 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks whether the double value is the special NaN value.</TD>
261 </TR>
262 <TR BGCOLOR="white" CLASS="TableRowColor">
263 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264 <CODE>&nbsp;long</CODE></FONT></TD>
265 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#longValue()">longValue</A></B>()</CODE>
266
267 <BR>
268 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of this MutableDouble as a long.</TD>
269 </TR>
270 <TR BGCOLOR="white" CLASS="TableRowColor">
271 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272 <CODE>&nbsp;void</CODE></FONT></TD>
273 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#setValue(double)">setValue</A></B>(double&nbsp;value)</CODE>
274
275 <BR>
276 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the value.</TD>
277 </TR>
278 <TR BGCOLOR="white" CLASS="TableRowColor">
279 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280 <CODE>&nbsp;void</CODE></FONT></TD>
281 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#setValue(java.lang.Object)">setValue</A></B>(java.lang.Object&nbsp;value)</CODE>
282
283 <BR>
284 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the value from any Number instance.</TD>
285 </TR>
286 <TR BGCOLOR="white" CLASS="TableRowColor">
287 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
288 <CODE>&nbsp;void</CODE></FONT></TD>
289 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#subtract(double)">subtract</A></B>(double&nbsp;operand)</CODE>
290
291 <BR>
292 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Subtracts a value.</TD>
293 </TR>
294 <TR BGCOLOR="white" CLASS="TableRowColor">
295 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
296 <CODE>&nbsp;void</CODE></FONT></TD>
297 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#subtract(java.lang.Number)">subtract</A></B>(java.lang.Number&nbsp;operand)</CODE>
298
299 <BR>
300 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Subtracts a value.</TD>
301 </TR>
302 <TR BGCOLOR="white" CLASS="TableRowColor">
303 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
304 <CODE>&nbsp;java.lang.Double</CODE></FONT></TD>
305 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#toDouble()">toDouble</A></B>()</CODE>
306
307 <BR>
308 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets this mutable as an instance of Double.</TD>
309 </TR>
310 <TR BGCOLOR="white" CLASS="TableRowColor">
311 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
312 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
313 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/mutable/MutableDouble.html#toString()">toString</A></B>()</CODE>
314
315 <BR>
316 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the String value of this mutable.</TD>
317 </TR>
318 </TABLE>
319 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Number"><!-- --></A>
320 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
321 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
322 <TD><B>Methods inherited from class java.lang.Number</B></TD>
323 </TR>
324 <TR BGCOLOR="white" CLASS="TableRowColor">
325 <TD><CODE>byteValue, shortValue</CODE></TD>
326 </TR>
327 </TABLE>
328 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
329 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
330 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
331 <TD><B>Methods inherited from class java.lang.Object</B></TD>
332 </TR>
333 <TR BGCOLOR="white" CLASS="TableRowColor">
334 <TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
335 </TR>
336 </TABLE>
337 &nbsp;
338 <P>
339
340 <!-- ============ FIELD DETAIL =========== -->
341
342
343 <!-- ========= CONSTRUCTOR DETAIL ======== -->
344
345 <A NAME="constructor_detail"><!-- --></A>
346 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
347 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
348 <TD COLSPAN=1><FONT SIZE="+2">
349 <B>Constructor Detail</B></FONT></TD>
350 </TR>
351 </TABLE>
352
353 <A NAME="MutableDouble()"><!-- --></A><H3>
354 MutableDouble</H3>
355 <PRE>
356 public <B>MutableDouble</B>()</PRE>
357 <DL>
358 <DD>Constructs a new MutableDouble with the default value of zero.
359 <P>
360 </DL>
361 <HR>
362
363 <A NAME="MutableDouble(double)"><!-- --></A><H3>
364 MutableDouble</H3>
365 <PRE>
366 public <B>MutableDouble</B>(double&nbsp;value)</PRE>
367 <DL>
368 <DD>Constructs a new MutableDouble with the specified value.
369 <P>
370 <DT><B>Parameters:</B><DD><CODE>value</CODE> - a value.</DL>
371 <HR>
372
373 <A NAME="MutableDouble(java.lang.Number)"><!-- --></A><H3>
374 MutableDouble</H3>
375 <PRE>
376 public <B>MutableDouble</B>(java.lang.Number&nbsp;value)</PRE>
377 <DL>
378 <DD>Constructs a new MutableDouble with the specified value.
379 <P>
380 <DT><B>Parameters:</B><DD><CODE>value</CODE> - a value.
381 <DT><B>Throws:</B>
382 <DD><CODE>java.lang.NullPointerException</CODE> - if the object is null</DL>
383
384 <!-- ============ METHOD DETAIL ========== -->
385
386 <A NAME="method_detail"><!-- --></A>
387 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
388 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
389 <TD COLSPAN=1><FONT SIZE="+2">
390 <B>Method Detail</B></FONT></TD>
391 </TR>
392 </TABLE>
393
394 <A NAME="getValue()"><!-- --></A><H3>
395 getValue</H3>
396 <PRE>
397 public java.lang.Object <B>getValue</B>()</PRE>
398 <DL>
399 <DD>Gets the value as a Double instance.
400 <P>
401 <DD><DL>
402 <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>
403 </DD>
404 <DD><DL>
405
406 <DT><B>Returns:</B><DD>the value as a Double</DL>
407 </DD>
408 </DL>
409 <HR>
410
411 <A NAME="setValue(double)"><!-- --></A><H3>
412 setValue</H3>
413 <PRE>
414 public void <B>setValue</B>(double&nbsp;value)</PRE>
415 <DL>
416 <DD>Sets the value.
417 <P>
418 <DD><DL>
419 </DL>
420 </DD>
421 <DD><DL>
422 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to set</DL>
423 </DD>
424 </DL>
425 <HR>
426
427 <A NAME="setValue(java.lang.Object)"><!-- --></A><H3>
428 setValue</H3>
429 <PRE>
430 public void <B>setValue</B>(java.lang.Object&nbsp;value)</PRE>
431 <DL>
432 <DD>Sets the value from any Number instance.
433 <P>
434 <DD><DL>
435 <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>
436 </DD>
437 <DD><DL>
438 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to set
439 <DT><B>Throws:</B>
440 <DD><CODE>java.lang.NullPointerException</CODE> - if the object is null
441 <DD><CODE>java.lang.ClassCastException</CODE> - if the type is not a <CODE>Number</CODE></DL>
442 </DD>
443 </DL>
444 <HR>
445
446 <A NAME="intValue()"><!-- --></A><H3>
447 intValue</H3>
448 <PRE>
449 public int <B>intValue</B>()</PRE>
450 <DL>
451 <DD>Returns the value of this MutableDouble as a int.
452 <P>
453 <DD><DL>
454 </DL>
455 </DD>
456 <DD><DL>
457
458 <DT><B>Returns:</B><DD>the numeric value represented by this object after conversion to type int.</DL>
459 </DD>
460 </DL>
461 <HR>
462
463 <A NAME="longValue()"><!-- --></A><H3>
464 longValue</H3>
465 <PRE>
466 public long <B>longValue</B>()</PRE>
467 <DL>
468 <DD>Returns the value of this MutableDouble as a long.
469 <P>
470 <DD><DL>
471 </DL>
472 </DD>
473 <DD><DL>
474
475 <DT><B>Returns:</B><DD>the numeric value represented by this object after conversion to type long.</DL>
476 </DD>
477 </DL>
478 <HR>
479
480 <A NAME="floatValue()"><!-- --></A><H3>
481 floatValue</H3>
482 <PRE>
483 public float <B>floatValue</B>()</PRE>
484 <DL>
485 <DD>Returns the value of this MutableDouble as a float.
486 <P>
487 <DD><DL>
488 </DL>
489 </DD>
490 <DD><DL>
491
492 <DT><B>Returns:</B><DD>the numeric value represented by this object after conversion to type float.</DL>
493 </DD>
494 </DL>
495 <HR>
496
497 <A NAME="doubleValue()"><!-- --></A><H3>
498 doubleValue</H3>
499 <PRE>
500 public double <B>doubleValue</B>()</PRE>
501 <DL>
502 <DD>Returns the value of this MutableDouble as a double.
503 <P>
504 <DD><DL>
505 </DL>
506 </DD>
507 <DD><DL>
508
509 <DT><B>Returns:</B><DD>the numeric value represented by this object after conversion to type double.</DL>
510 </DD>
511 </DL>
512 <HR>
513
514 <A NAME="isNaN()"><!-- --></A><H3>
515 isNaN</H3>
516 <PRE>
517 public boolean <B>isNaN</B>()</PRE>
518 <DL>
519 <DD>Checks whether the double value is the special NaN value.
520 <P>
521 <DD><DL>
522 </DL>
523 </DD>
524 <DD><DL>
525
526 <DT><B>Returns:</B><DD>true if NaN</DL>
527 </DD>
528 </DL>
529 <HR>
530
531 <A NAME="isInfinite()"><!-- --></A><H3>
532 isInfinite</H3>
533 <PRE>
534 public boolean <B>isInfinite</B>()</PRE>
535 <DL>
536 <DD>Checks whether the double value is infinite.
537 <P>
538 <DD><DL>
539 </DL>
540 </DD>
541 <DD><DL>
542
543 <DT><B>Returns:</B><DD>true if infinite</DL>
544 </DD>
545 </DL>
546 <HR>
547
548 <A NAME="toDouble()"><!-- --></A><H3>
549 toDouble</H3>
550 <PRE>
551 public java.lang.Double <B>toDouble</B>()</PRE>
552 <DL>
553 <DD>Gets this mutable as an instance of Double.
554 <P>
555 <DD><DL>
556 </DL>
557 </DD>
558 <DD><DL>
559
560 <DT><B>Returns:</B><DD>a Double instance containing the value from this mutable</DL>
561 </DD>
562 </DL>
563 <HR>
564
565 <A NAME="increment()"><!-- --></A><H3>
566 increment</H3>
567 <PRE>
568 public void <B>increment</B>()</PRE>
569 <DL>
570 <DD>Increments the value.
571 <P>
572 <DD><DL>
573 </DL>
574 </DD>
575 <DD><DL>
576 <DT><B>Since:</B></DT>
577 <DD>Commons Lang 2.2</DD>
578 </DL>
579 </DD>
580 </DL>
581 <HR>
582
583 <A NAME="decrement()"><!-- --></A><H3>
584 decrement</H3>
585 <PRE>
586 public void <B>decrement</B>()</PRE>
587 <DL>
588 <DD>Decrements the value.
589 <P>
590 <DD><DL>
591 </DL>
592 </DD>
593 <DD><DL>
594 <DT><B>Since:</B></DT>
595 <DD>Commons Lang 2.2</DD>
596 </DL>
597 </DD>
598 </DL>
599 <HR>
600
601 <A NAME="add(double)"><!-- --></A><H3>
602 add</H3>
603 <PRE>
604 public void <B>add</B>(double&nbsp;operand)</PRE>
605 <DL>
606 <DD>Adds a value.
607 <P>
608 <DD><DL>
609 </DL>
610 </DD>
611 <DD><DL>
612 <DT><B>Parameters:</B><DD><CODE>operand</CODE> - the value to add<DT><B>Since:</B></DT>
613 <DD>Commons Lang 2.2</DD>
614 </DL>
615 </DD>
616 </DL>
617 <HR>
618
619 <A NAME="add(java.lang.Number)"><!-- --></A><H3>
620 add</H3>
621 <PRE>
622 public void <B>add</B>(java.lang.Number&nbsp;operand)</PRE>
623 <DL>
624 <DD>Adds a value.
625 <P>
626 <DD><DL>
627 </DL>
628 </DD>
629 <DD><DL>
630 <DT><B>Parameters:</B><DD><CODE>operand</CODE> - the value to add
631 <DT><B>Throws:</B>
632 <DD><CODE>java.lang.NullPointerException</CODE> - if the object is null<DT><B>Since:</B></DT>
633 <DD>Commons Lang 2.2</DD>
634 </DL>
635 </DD>
636 </DL>
637 <HR>
638
639 <A NAME="subtract(double)"><!-- --></A><H3>
640 subtract</H3>
641 <PRE>
642 public void <B>subtract</B>(double&nbsp;operand)</PRE>
643 <DL>
644 <DD>Subtracts a value.
645 <P>
646 <DD><DL>
647 </DL>
648 </DD>
649 <DD><DL>
650 <DT><B>Parameters:</B><DD><CODE>operand</CODE> - the value to add<DT><B>Since:</B></DT>
651 <DD>Commons Lang 2.2</DD>
652 </DL>
653 </DD>
654 </DL>
655 <HR>
656
657 <A NAME="subtract(java.lang.Number)"><!-- --></A><H3>
658 subtract</H3>
659 <PRE>
660 public void <B>subtract</B>(java.lang.Number&nbsp;operand)</PRE>
661 <DL>
662 <DD>Subtracts a value.
663 <P>
664 <DD><DL>
665 </DL>
666 </DD>
667 <DD><DL>
668 <DT><B>Parameters:</B><DD><CODE>operand</CODE> - the value to add
669 <DT><B>Throws:</B>
670 <DD><CODE>java.lang.NullPointerException</CODE> - if the object is null<DT><B>Since:</B></DT>
671 <DD>Commons Lang 2.2</DD>
672 </DL>
673 </DD>
674 </DL>
675 <HR>
676
677 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
678 equals</H3>
679 <PRE>
680 public boolean <B>equals</B>(java.lang.Object&nbsp;obj)</PRE>
681 <DL>
682 <DD>Compares this object against the specified object. The result is <code>true</code> if and only if the argument
683 is not <code>null</code> and is a <code>Double</code> object that represents a double that has the identical
684 bit pattern to the bit pattern of the double represented by this object. For this purpose, two
685 <code>double</code> values are considered to be the same if and only if the method
686 <CODE>Double.doubleToLongBits(double)</CODE>returns the same long value when applied to each.
687 <p>
688 Note that in most cases, for two instances of class <code>Double</code>,<code>d1</code> and <code>d2</code>,
689 the value of <code>d1.equals(d2)</code> is <code>true</code> if and only if <blockquote>
690
691 <pre>
692 d1.doubleValue()&nbsp;== d2.doubleValue()
693 </pre>
694
695 </blockquote>
696 <p>
697 also has the value <code>true</code>. However, there are two exceptions:
698 <ul>
699 <li>If <code>d1</code> and <code>d2</code> both represent <code>Double.NaN</code>, then the
700 <code>equals</code> method returns <code>true</code>, even though <code>Double.NaN==Double.NaN</code> has
701 the value <code>false</code>.
702 <li>If <code>d1</code> represents <code>+0.0</code> while <code>d2</code> represents <code>-0.0</code>,
703 or vice versa, the <code>equal</code> test has the value <code>false</code>, even though
704 <code>+0.0==-0.0</code> has the value <code>true</code>. This allows hashtables to operate properly.
705 </ul>
706 <P>
707 <DD><DL>
708 </DL>
709 </DD>
710 <DD><DL>
711 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to compare with.
712 <DT><B>Returns:</B><DD><code>true</code> if the objects are the same; <code>false</code> otherwise.</DL>
713 </DD>
714 </DL>
715 <HR>
716
717 <A NAME="hashCode()"><!-- --></A><H3>
718 hashCode</H3>
719 <PRE>
720 public int <B>hashCode</B>()</PRE>
721 <DL>
722 <DD>Returns a suitable hashcode for this mutable.
723 <P>
724 <DD><DL>
725 </DL>
726 </DD>
727 <DD><DL>
728
729 <DT><B>Returns:</B><DD>a suitable hashcode</DL>
730 </DD>
731 </DL>
732 <HR>
733
734 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
735 compareTo</H3>
736 <PRE>
737 public int <B>compareTo</B>(java.lang.Object&nbsp;obj)</PRE>
738 <DL>
739 <DD>Compares this mutable to another in ascending order.
740 <P>
741 <DD><DL>
742 <DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable</CODE></DL>
743 </DD>
744 <DD><DL>
745 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the mutable to compare to
746 <DT><B>Returns:</B><DD>negative if this is less, zero if equal, positive if greater
747 <DT><B>Throws:</B>
748 <DD><CODE>java.lang.ClassCastException</CODE> - if the argument is not a MutableDouble</DL>
749 </DD>
750 </DL>
751 <HR>
752
753 <A NAME="toString()"><!-- --></A><H3>
754 toString</H3>
755 <PRE>
756 public java.lang.String <B>toString</B>()</PRE>
757 <DL>
758 <DD>Returns the String value of this mutable.
759 <P>
760 <DD><DL>
761 </DL>
762 </DD>
763 <DD><DL>
764
765 <DT><B>Returns:</B><DD>the mutable value as a string</DL>
766 </DD>
767 </DL>
768 <!-- ========= END OF CLASS DATA ========= -->
769 <HR>
770
771
772 <!-- ======= START OF BOTTOM NAVBAR ====== -->
773 <A NAME="navbar_bottom"><!-- --></A>
774 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
775 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
776 <TR>
777 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
778 <A NAME="navbar_bottom_firstrow"><!-- --></A>
779 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
780 <TR ALIGN="center" VALIGN="top">
781 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
782 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
783 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
784 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MutableDouble.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
785 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
786 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
787 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
788 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
789 </TR>
790 </TABLE>
791 </TD>
792 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
793 </EM>
794 </TD>
795 </TR>
796
797 <TR>
798 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
799 &nbsp;<A HREF="../../../../../org/apache/commons/lang/mutable/MutableByte.html" title="class in org.apache.commons.lang.mutable"><B>PREV CLASS</B></A>&nbsp;
800 &nbsp;<A HREF="../../../../../org/apache/commons/lang/mutable/MutableFloat.html" title="class in org.apache.commons.lang.mutable"><B>NEXT CLASS</B></A></FONT></TD>
801 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
802 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
803 &nbsp;<A HREF="MutableDouble.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
804 &nbsp;<SCRIPT type="text/javascript">
805 <!--
806 if(window==top) {
807 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
808 }
809 //-->
810 </SCRIPT>
811 <NOSCRIPT>
812 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
813 </NOSCRIPT>
814
815 </FONT></TD>
816 </TR>
817 <TR>
818 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
819 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
820 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
821 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
822 </TR>
823 </TABLE>
824 <A NAME="skip-navbar_bottom"></A>
825 <!-- ======== END OF BOTTOM NAVBAR ======= -->
826
827 <HR>
828 Copyright © 2001-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
829 </BODY>
830 </HTML>
ephemerata