ParamChecks.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:41 CEST 2014 -->
  6. <title>ParamChecks (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="ParamChecks (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":9,"i1":9};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/ParamChecks.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../org/jfree/chart/util/PaintAlpha.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/util/RelativeDateFormat.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/util/ParamChecks.html" target="_top">Frames</a></li>
  57. <li><a href="ParamChecks.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.jfree.chart.util</div>
  96. <h2 title="Class ParamChecks" class="title">Class ParamChecks</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>org.jfree.chart.util.ParamChecks</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <hr>
  111. <br>
  112. <pre>public class <a href="../../../../src-html/org/jfree/chart/util/ParamChecks.html#line.48">ParamChecks</a>
  113. extends java.lang.Object</pre>
  114. <div class="block">A utility class for checking parameters.</div>
  115. <dl>
  116. <dt><span class="simpleTagLabel">Since:</span></dt>
  117. <dd>1.0.14</dd>
  118. </dl>
  119. </li>
  120. </ul>
  121. </div>
  122. <div class="summary">
  123. <ul class="blockList">
  124. <li class="blockList">
  125. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  126. <ul class="blockList">
  127. <li class="blockList"><a name="constructor.summary">
  128. <!-- -->
  129. </a>
  130. <h3>Constructor Summary</h3>
  131. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  132. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  133. <tr>
  134. <th class="colOne" scope="col">Constructor and Description</th>
  135. </tr>
  136. <tr class="altColor">
  137. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/ParamChecks.html#ParamChecks--">ParamChecks</a></span>()</code>&nbsp;</td>
  138. </tr>
  139. </table>
  140. </li>
  141. </ul>
  142. <!-- ========== METHOD SUMMARY =========== -->
  143. <ul class="blockList">
  144. <li class="blockList"><a name="method.summary">
  145. <!-- -->
  146. </a>
  147. <h3>Method Summary</h3>
  148. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  149. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  150. <tr>
  151. <th class="colFirst" scope="col">Modifier and Type</th>
  152. <th class="colLast" scope="col">Method and Description</th>
  153. </tr>
  154. <tr id="i0" class="altColor">
  155. <td class="colFirst"><code>static void</code></td>
  156. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/ParamChecks.html#nullNotPermitted-java.lang.Object-java.lang.String-">nullNotPermitted</a></span>(java.lang.Object&nbsp;param,
  157. java.lang.String&nbsp;name)</code>
  158. <div class="block">Throws an <code>IllegalArgumentException</code> if the supplied
  159. <code>param</code> is <code>null</code>.</div>
  160. </td>
  161. </tr>
  162. <tr id="i1" class="rowColor">
  163. <td class="colFirst"><code>static void</code></td>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/ParamChecks.html#requireNonNegative-int-java.lang.String-">requireNonNegative</a></span>(int&nbsp;value,
  165. java.lang.String&nbsp;name)</code>
  166. <div class="block">Throws an <code>IllegalArgumentException</code> if <code>value</code> is negative.</div>
  167. </td>
  168. </tr>
  169. </table>
  170. <ul class="blockList">
  171. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  172. <!-- -->
  173. </a>
  174. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  175. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  176. </ul>
  177. </li>
  178. </ul>
  179. </li>
  180. </ul>
  181. </div>
  182. <div class="details">
  183. <ul class="blockList">
  184. <li class="blockList">
  185. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  186. <ul class="blockList">
  187. <li class="blockList"><a name="constructor.detail">
  188. <!-- -->
  189. </a>
  190. <h3>Constructor Detail</h3>
  191. <a name="ParamChecks--">
  192. <!-- -->
  193. </a>
  194. <ul class="blockListLast">
  195. <li class="blockList">
  196. <h4>ParamChecks</h4>
  197. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/util/ParamChecks.html#line.48">ParamChecks</a>()</pre>
  198. </li>
  199. </ul>
  200. </li>
  201. </ul>
  202. <!-- ============ METHOD DETAIL ========== -->
  203. <ul class="blockList">
  204. <li class="blockList"><a name="method.detail">
  205. <!-- -->
  206. </a>
  207. <h3>Method Detail</h3>
  208. <a name="nullNotPermitted-java.lang.Object-java.lang.String-">
  209. <!-- -->
  210. </a>
  211. <ul class="blockList">
  212. <li class="blockList">
  213. <h4>nullNotPermitted</h4>
  214. <pre>public static&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/util/ParamChecks.html#line.63">nullNotPermitted</a>(java.lang.Object&nbsp;param,
  215. java.lang.String&nbsp;name)</pre>
  216. <div class="block">Throws an <code>IllegalArgumentException</code> if the supplied
  217. <code>param</code> is <code>null</code>.</div>
  218. <dl>
  219. <dt><span class="paramLabel">Parameters:</span></dt>
  220. <dd><code>param</code> - the parameter to check (<code>null</code> permitted).</dd>
  221. <dd><code>name</code> - the name of the parameter (to use in the exception message
  222. if <code>param</code> is <code>null</code>).</dd>
  223. <dt><span class="throwsLabel">Throws:</span></dt>
  224. <dd><code>java.lang.IllegalArgumentException</code> - if <code>param</code> is
  225. <code>null</code>.</dd>
  226. <dt><span class="simpleTagLabel">Since:</span></dt>
  227. <dd>1.0.14</dd>
  228. </dl>
  229. </li>
  230. </ul>
  231. <a name="requireNonNegative-int-java.lang.String-">
  232. <!-- -->
  233. </a>
  234. <ul class="blockListLast">
  235. <li class="blockList">
  236. <h4>requireNonNegative</h4>
  237. <pre>public static&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/util/ParamChecks.html#line.77">requireNonNegative</a>(int&nbsp;value,
  238. java.lang.String&nbsp;name)</pre>
  239. <div class="block">Throws an <code>IllegalArgumentException</code> if <code>value</code> is negative.</div>
  240. <dl>
  241. <dt><span class="paramLabel">Parameters:</span></dt>
  242. <dd><code>value</code> - the value.</dd>
  243. <dd><code>name</code> - the parameter name (for use in the exception message).</dd>
  244. <dt><span class="simpleTagLabel">Since:</span></dt>
  245. <dd>1.0.18</dd>
  246. </dl>
  247. </li>
  248. </ul>
  249. </li>
  250. </ul>
  251. </li>
  252. </ul>
  253. </div>
  254. </div>
  255. <!-- ========= END OF CLASS DATA ========= -->
  256. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  257. <div class="bottomNav"><a name="navbar.bottom">
  258. <!-- -->
  259. </a>
  260. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  261. <a name="navbar.bottom.firstrow">
  262. <!-- -->
  263. </a>
  264. <ul class="navList" title="Navigation">
  265. <li><a href="../../../../overview-summary.html">Overview</a></li>
  266. <li><a href="package-summary.html">Package</a></li>
  267. <li class="navBarCell1Rev">Class</li>
  268. <li><a href="class-use/ParamChecks.html">Use</a></li>
  269. <li><a href="package-tree.html">Tree</a></li>
  270. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  271. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  272. <li><a href="../../../../help-doc.html">Help</a></li>
  273. </ul>
  274. </div>
  275. <div class="subNav">
  276. <ul class="navList">
  277. <li><a href="../../../../org/jfree/chart/util/PaintAlpha.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  278. <li><a href="../../../../org/jfree/chart/util/RelativeDateFormat.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  279. </ul>
  280. <ul class="navList">
  281. <li><a href="../../../../index.html?org/jfree/chart/util/ParamChecks.html" target="_top">Frames</a></li>
  282. <li><a href="ParamChecks.html" target="_top">No&nbsp;Frames</a></li>
  283. </ul>
  284. <ul class="navList" id="allclasses_navbar_bottom">
  285. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  286. </ul>
  287. <div>
  288. <script type="text/javascript"><!--
  289. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  290. if(window==top) {
  291. allClassesLink.style.display = "block";
  292. }
  293. else {
  294. allClassesLink.style.display = "none";
  295. }
  296. //-->
  297. </script>
  298. </div>
  299. <div>
  300. <ul class="subNavList">
  301. <li>Summary:&nbsp;</li>
  302. <li>Nested&nbsp;|&nbsp;</li>
  303. <li>Field&nbsp;|&nbsp;</li>
  304. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  305. <li><a href="#method.summary">Method</a></li>
  306. </ul>
  307. <ul class="subNavList">
  308. <li>Detail:&nbsp;</li>
  309. <li>Field&nbsp;|&nbsp;</li>
  310. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  311. <li><a href="#method.detail">Method</a></li>
  312. </ul>
  313. </div>
  314. <a name="skip.navbar.bottom">
  315. <!-- -->
  316. </a></div>
  317. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  318. </body>
  319. </html>