Subversion Repositories sokoban

Rev

Blame | Last modification | View Log | RSS feed

  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.6.0-rc) on Sat Jan 24 19:46:55 CET 2009 -->
  6. <TITLE>
  7. ParameterOutOfRangeException
  8. </TITLE>
  9.  
  10. <META NAME="date" CONTENT="2009-01-24">
  11.  
  12. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
  13.  
  14. <SCRIPT type="text/javascript">
  15. function windowTitle()
  16. {
  17.     if (location.href.indexOf('is-external=true') == -1) {
  18.         parent.document.title="ParameterOutOfRangeException";
  19.     }
  20. }
  21. </SCRIPT>
  22. <NOSCRIPT>
  23. </NOSCRIPT>
  24.  
  25. </HEAD>
  26.  
  27. <BODY BGCOLOR="white" onload="windowTitle();">
  28. <HR>
  29.  
  30.  
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <A NAME="navbar_top"><!-- --></A>
  33. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  34. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  35. <TR>
  36. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  37. <A NAME="navbar_top_firstrow"><!-- --></A>
  38. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  39.   <TR ALIGN="center" VALIGN="top">
  40.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  42.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  43.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  47.   </TR>
  48. </TABLE>
  49. </TD>
  50. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  51. </EM>
  52. </TD>
  53. </TR>
  54.  
  55. <TR>
  56. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  57. &nbsp;<A HREF="../../gdi1sokoban/exceptions/InvalidOperationException.html" title="class in gdi1sokoban.exceptions"><B>PREV CLASS</B></A>&nbsp;
  58. &nbsp;NEXT CLASS</FONT></TD>
  59. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  60.   <A HREF="../../index.html?gdi1sokoban/exceptions/ParameterOutOfRangeException.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  61. &nbsp;<A HREF="ParameterOutOfRangeException.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  62. &nbsp;<SCRIPT type="text/javascript">
  63.   <!--
  64.   if(window==top) {
  65.     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  66.   }
  67.   //-->
  68. </SCRIPT>
  69. <NOSCRIPT>
  70.   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  71. </NOSCRIPT>
  72.  
  73.  
  74. </FONT></TD>
  75. </TR>
  76. <TR>
  77. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  78.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  80. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  81. </TR>
  82. </TABLE>
  83. <A NAME="skip-navbar_top"></A>
  84. <!-- ========= END OF TOP NAVBAR ========= -->
  85.  
  86. <HR>
  87. <!-- ======== START OF CLASS DATA ======== -->
  88. <H2>
  89. <FONT SIZE="-1">
  90. gdi1sokoban.exceptions</FONT>
  91. <BR>
  92. Class ParameterOutOfRangeException</H2>
  93. <PRE>
  94. java.lang.Object
  95.   <IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
  96.       <IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
  97.           <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>gdi1sokoban.exceptions.ParameterOutOfRangeException</B>
  98. </PRE>
  99. <DL>
  100. <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
  101. </DL>
  102. <HR>
  103. <DL>
  104. <DT><PRE>public class <B>ParameterOutOfRangeException</B><DT>extends java.lang.Exception</DL>
  105. </PRE>
  106.  
  107. <P>
  108. Exception that is thrown whenever a method's parameter falls out of the scope
  109. of allowed values
  110. <P>
  111.  
  112. <P>
  113. <DL>
  114. <DT><B>Version:</B></DT>
  115.  <DD>1.0</DD>
  116. <DT><B>Author:</B></DT>
  117.  <DD>Steven Arzt, Oren Avni, Guido Roessling</DD>
  118. <DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#gdi1sokoban.exceptions.ParameterOutOfRangeException">Serialized Form</A></DL>
  119. <HR>
  120.  
  121. <P>
  122.  
  123. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  124.  
  125. <A NAME="constructor_summary"><!-- --></A>
  126. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  127. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  128. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  129. <B>Constructor Summary</B></FONT></TH>
  130. </TR>
  131. <TR BGCOLOR="white" CLASS="TableRowColor">
  132. <TD><CODE><B><A HREF="../../gdi1sokoban/exceptions/ParameterOutOfRangeException.html#ParameterOutOfRangeException(java.lang.String)">ParameterOutOfRangeException</A></B>(java.lang.String&nbsp;paramName)</CODE>
  133.  
  134. <BR>
  135. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new instance of the ParameterOutOfRangeException class</TD>
  136. </TR>
  137. <TR BGCOLOR="white" CLASS="TableRowColor">
  138. <TD><CODE><B><A HREF="../../gdi1sokoban/exceptions/ParameterOutOfRangeException.html#ParameterOutOfRangeException(java.lang.String, java.lang.Object)">ParameterOutOfRangeException</A></B>(java.lang.String&nbsp;paramName,
  139.                             java.lang.Object&nbsp;aValue)</CODE>
  140.  
  141. <BR>
  142. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new instance of the ParameterOutOfRangeException class with the
  143. value that has caused the error</TD>
  144. </TR>
  145. <TR BGCOLOR="white" CLASS="TableRowColor">
  146. <TD><CODE><B><A HREF="../../gdi1sokoban/exceptions/ParameterOutOfRangeException.html#ParameterOutOfRangeException(java.lang.String, java.lang.Throwable)">ParameterOutOfRangeException</A></B>(java.lang.String&nbsp;paramName,
  147.                             java.lang.Throwable&nbsp;innerException)</CODE>
  148.  
  149. <BR>
  150. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new instance of the ParameterOutOfRangeException class with an
  151. inner exception for exception chaining</TD>
  152. </TR>
  153. </TABLE>
  154. &nbsp;
  155. <!-- ========== METHOD SUMMARY =========== -->
  156.  
  157. <A NAME="method_summary"><!-- --></A>
  158. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  159. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  160. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  161. <B>Method Summary</B></FONT></TH>
  162. </TR>
  163. <TR BGCOLOR="white" CLASS="TableRowColor">
  164. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  165. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  166. <TD><CODE><B><A HREF="../../gdi1sokoban/exceptions/ParameterOutOfRangeException.html#getParameterName()">getParameterName</A></B>()</CODE>
  167.  
  168. <BR>
  169. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the name of the parameter that has failed the validity check</TD>
  170. </TR>
  171. <TR BGCOLOR="white" CLASS="TableRowColor">
  172. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  173. <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
  174. <TD><CODE><B><A HREF="../../gdi1sokoban/exceptions/ParameterOutOfRangeException.html#getValue()">getValue</A></B>()</CODE>
  175.  
  176. <BR>
  177. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the value that has caused the error</TD>
  178. </TR>
  179. </TABLE>
  180. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
  181. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  182. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  183. <TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
  184. </TR>
  185. <TR BGCOLOR="white" CLASS="TableRowColor">
  186. <TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
  187. </TR>
  188. </TABLE>
  189. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  190. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  191. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  192. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  193. </TR>
  194. <TR BGCOLOR="white" CLASS="TableRowColor">
  195. <TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
  196. </TR>
  197. </TABLE>
  198. &nbsp;
  199. <P>
  200.  
  201. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  202.  
  203. <A NAME="constructor_detail"><!-- --></A>
  204. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  205. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  206. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  207. <B>Constructor Detail</B></FONT></TH>
  208. </TR>
  209. </TABLE>
  210.  
  211. <A NAME="ParameterOutOfRangeException(java.lang.String)"><!-- --></A><H3>
  212. ParameterOutOfRangeException</H3>
  213. <PRE>
  214. public <B>ParameterOutOfRangeException</B>(java.lang.String&nbsp;paramName)</PRE>
  215. <DL>
  216. <DD>Creates a new instance of the ParameterOutOfRangeException class
  217. <P>
  218. <DL>
  219. <DT><B>Parameters:</B><DD><CODE>paramName</CODE> - The name of the parameter that has failed the validity check</DL>
  220. </DL>
  221. <HR>
  222.  
  223. <A NAME="ParameterOutOfRangeException(java.lang.String, java.lang.Object)"><!-- --></A><H3>
  224. ParameterOutOfRangeException</H3>
  225. <PRE>
  226. public <B>ParameterOutOfRangeException</B>(java.lang.String&nbsp;paramName,
  227.                                    java.lang.Object&nbsp;aValue)</PRE>
  228. <DL>
  229. <DD>Creates a new instance of the ParameterOutOfRangeException class with the
  230. value that has caused the error
  231. <P>
  232. <DL>
  233. <DT><B>Parameters:</B><DD><CODE>paramName</CODE> - The name of the parameter that has failed the validity check<DD><CODE>aValue</CODE> - The value that has caused the error</DL>
  234. </DL>
  235. <HR>
  236.  
  237. <A NAME="ParameterOutOfRangeException(java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
  238. ParameterOutOfRangeException</H3>
  239. <PRE>
  240. public <B>ParameterOutOfRangeException</B>(java.lang.String&nbsp;paramName,
  241.                                    java.lang.Throwable&nbsp;innerException)</PRE>
  242. <DL>
  243. <DD>Creates a new instance of the ParameterOutOfRangeException class with an
  244. inner exception for exception chaining
  245. <P>
  246. <DL>
  247. <DT><B>Parameters:</B><DD><CODE>paramName</CODE> - The name of the parameter that has failed the validity check<DD><CODE>innerException</CODE> - The inner exception that has led to this one</DL>
  248. </DL>
  249.  
  250. <!-- ============ METHOD DETAIL ========== -->
  251.  
  252. <A NAME="method_detail"><!-- --></A>
  253. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  254. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  255. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  256. <B>Method Detail</B></FONT></TH>
  257. </TR>
  258. </TABLE>
  259.  
  260. <A NAME="getParameterName()"><!-- --></A><H3>
  261. getParameterName</H3>
  262. <PRE>
  263. public java.lang.String <B>getParameterName</B>()</PRE>
  264. <DL>
  265. <DD>Gets the name of the parameter that has failed the validity check
  266. <P>
  267. <DD><DL>
  268.  
  269. <DT><B>Returns:</B><DD>The name of the parameter that has failed the validity check</DL>
  270. </DD>
  271. </DL>
  272. <HR>
  273.  
  274. <A NAME="getValue()"><!-- --></A><H3>
  275. getValue</H3>
  276. <PRE>
  277. public java.lang.Object <B>getValue</B>()</PRE>
  278. <DL>
  279. <DD>Gets the value that has caused the error
  280. <P>
  281. <DD><DL>
  282.  
  283. <DT><B>Returns:</B><DD>The value that has caused the error</DL>
  284. </DD>
  285. </DL>
  286. <!-- ========= END OF CLASS DATA ========= -->
  287. <HR>
  288.  
  289.  
  290. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  291. <A NAME="navbar_bottom"><!-- --></A>
  292. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  293. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  294. <TR>
  295. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  296. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  297. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  298.  <TR ALIGN="center" VALIGN="top">
  299.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  300.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  301.  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  302.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  303.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  304.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  305.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  306.  </TR>
  307. </TABLE>
  308. </TD>
  309. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  310. </EM>
  311. </TD>
  312. </TR>
  313.  
  314. <TR>
  315. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  316. &nbsp;<A HREF="../../gdi1sokoban/exceptions/InvalidOperationException.html" title="class in gdi1sokoban.exceptions"><B>PREV CLASS</B></A>&nbsp;
  317. &nbsp;NEXT CLASS</FONT></TD>
  318. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  319.  <A HREF="../../index.html?gdi1sokoban/exceptions/ParameterOutOfRangeException.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  320. &nbsp;<A HREF="ParameterOutOfRangeException.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  321. &nbsp;<SCRIPT type="text/javascript">
  322.  <!--
  323.  if(window==top) {
  324.    document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  325.  }
  326.  //-->
  327. </SCRIPT>
  328. <NOSCRIPT>
  329.  <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  330. </NOSCRIPT>
  331.  
  332.  
  333. </FONT></TD>
  334. </TR>
  335. <TR>
  336. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  337.  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  338. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  339. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  340. </TR>
  341. </TABLE>
  342. <A NAME="skip-navbar_bottom"></A>
  343. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  344.  
  345. <HR>
  346.  
  347. </BODY>
  348. </HTML>
  349.