| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ArgUtils (Apache Juneau 9.0.0)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.juneau.internal, class: ArgUtils"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":9,"i1":9,"i2":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.juneau.internal</a></div> |
| <h1 title="Class ArgUtils" class="title">Class ArgUtils</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree">java.lang.Object |
| <div class="inheritance">org.apache.juneau.internal.ArgUtils</div> |
| </div> |
| <section class="description"> |
| <hr> |
| <pre>public class <a href="../../../../src-html/org/apache/juneau/internal/ArgUtils.html#line.20">ArgUtils</a> |
| extends java.lang.Object</pre> |
| <div class="block">Method argument utility methods.</div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ArgUtils</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertArg(boolean,java.lang.String,java.lang.Object...)">assertArg</a></span>​(boolean expression, |
| java.lang.String msg, |
| java.lang.Object... args)</code></th> |
| <td class="colLast"> |
| <div class="block">Throws an <code>IllegalArgumentException</code> if the specified expression is <jk>false</jk>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>static <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertArgNotNull(java.lang.String,T)">assertArgNotNull</a></span>​(java.lang.String name, |
| T o)</code></th> |
| <td class="colLast"> |
| <div class="block">Throws an <code>IllegalArgumentException</code> if the specified argument is <jk>null</jk>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>static <E> java.lang.Class<E>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertClassArrayArgIsType(java.lang.String,java.lang.Class,java.lang.Class%5B%5D)">assertClassArrayArgIsType</a></span>​(java.lang.String name, |
| java.lang.Class<E> type, |
| java.lang.Class<?>[] value)</code></th> |
| <td class="colLast"> |
| <div class="block">Throws an <code>IllegalArgumentException</code> if the specified value doesn't have all subclasses of the specified type.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>()">ArgUtils</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName"><a href="../../../../src-html/org/apache/juneau/internal/ArgUtils.html#line.20">ArgUtils</a></span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="assertArgNotNull(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a><a id="assertArgNotNull(java.lang.String,T)">assertArgNotNull</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="typeParameters"><T></span> <span class="returnType">T</span> <span class="memberName"><a href="../../../../src-html/org/apache/juneau/internal/ArgUtils.html#line.41">assertArgNotNull</a></span>​(<span class="arguments">java.lang.String name, |
| T o)</span> |
| throws <span class="exceptions">java.lang.IllegalArgumentException</span></div> |
| <div class="block">Throws an <code>IllegalArgumentException</code> if the specified argument is <jk>null</jk>. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bjava'> |
| <jk>import static</jk> org.apache.juneau.internal.ArgUtils.*; |
| |
| <jk>public</jk> String setFoo(String <jv>foo</jv>) { |
| <jsm>assertArgNotNull</jsm>(<js>"foo"</js>, <jv>foo</jv>); |
| ... |
| } |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The argument data type.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The argument name.</dd> |
| <dd><code>o</code> - The object to check.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The same argument.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - Constructed exception.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="assertArg(boolean,java.lang.String,java.lang.Object...)">assertArg</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType">void</span> <span class="memberName"><a href="../../../../src-html/org/apache/juneau/internal/ArgUtils.html#line.64">assertArg</a></span>​(<span class="arguments">boolean expression, |
| java.lang.String msg, |
| java.lang.Object... args)</span> |
| throws <span class="exceptions">java.lang.IllegalArgumentException</span></div> |
| <div class="block">Throws an <code>IllegalArgumentException</code> if the specified expression is <jk>false</jk>. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bjava'> |
| <jk>import static</jk> org.apache.juneau.internal.ArgUtils.*; |
| |
| <jk>public</jk> String setFoo(List<String> <jv>foo</jv>) { |
| <jsm>assertArg</jsm>(<jv>foo</jv> != <jk>null</jk> && ! <jv>foo</jv>.isEmpty(), <js>"'foo' cannot be null or empty."</js>); |
| ... |
| } |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expression</code> - The boolean expression to check.</dd> |
| <dd><code>msg</code> - The exception message.</dd> |
| <dd><code>args</code> - The exception message args.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - Constructed exception.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="assertClassArrayArgIsType(java.lang.String,java.lang.Class,java.lang.Class[])">assertClassArrayArgIsType</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="typeParameters"><E></span> <span class="returnType">java.lang.Class<E>[]</span> <span class="memberName"><a href="../../../../src-html/org/apache/juneau/internal/ArgUtils.html#line.79">assertClassArrayArgIsType</a></span>​(<span class="arguments">java.lang.String name, |
| java.lang.Class<E> type, |
| java.lang.Class<?>[] value)</span> |
| throws <span class="exceptions">java.lang.IllegalArgumentException</span></div> |
| <div class="block">Throws an <code>IllegalArgumentException</code> if the specified value doesn't have all subclasses of the specified type.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>E</code> - The element type.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The argument name.</dd> |
| <dd><code>type</code> - The expected parent class.</dd> |
| <dd><code>value</code> - The array value being checked.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The value cast to the specified array type.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - Constructed exception.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2016–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
