github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-01-17 00:56:54 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f601cfb362d3e6be462debabde14d3695efb238c
DependencyCheck/dependency-check-cli/apidocs/org/owasp/dependencycheck/cli/CliParser.html
Jeremy Long f601cfb362 version 1.2.0 of the documentation
2014-04-28 09:08:21 -04:00

858 lines
41 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Mon Apr 28 08:38:29 EDT 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>CliParser (Dependency-Check Command Line 1.2.0 API)</title>
<meta name="date" content="2014-04-28">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CliParser (Dependency-Check Command Line 1.2.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CliParser.html">Use</a></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">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/owasp/dependencycheck/cli/CliParser.ArgumentName.html" title="class in org.owasp.dependencycheck.cli"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/owasp/dependencycheck/cli/CliParser.html" target="_top">Frames</a></li>
<li><a href="CliParser.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.owasp.dependencycheck.cli</div>
<h2 title="Class CliParser" class="title">Class CliParser</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.owasp.dependencycheck.cli.CliParser</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">CliParser</span>
extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">A utility to parse command line arguments for the DependencyCheck.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Jeremy Long <jeremy.long@owasp.org></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.ArgumentName.html" title="class in org.owasp.dependencycheck.cli">CliParser.ArgumentName</a></strong></code>
<div class="block">A collection of static final strings that represent the possible command line arguments.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#CliParser()">CliParser</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getAdditionalZipExtensions()">getAdditionalZipExtensions</a></strong>()</code>
<div class="block">Returns the additional Extensions if specified; otherwise null is returned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getApplicationName()">getApplicationName</a></strong>()</code>
<div class="block">Returns the application name specified on the command line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getConnectionString()">getConnectionString</a></strong>()</code>
<div class="block">Returns the database connection string if specified; otherwise null is returned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getConnectionTimeout()">getConnectionTimeout</a></strong>()</code>
<div class="block">Returns the connection timeout.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getDatabaseDriverName()">getDatabaseDriverName</a></strong>()</code>
<div class="block">Returns the database driver name if specified; otherwise null is returned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getDatabaseDriverPath()">getDatabaseDriverPath</a></strong>()</code>
<div class="block">Returns the database driver path if specified; otherwise null is returned.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getDatabasePassword()">getDatabasePassword</a></strong>()</code>
<div class="block">Returns the database database password if specified; otherwise null is returned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getDatabaseUser()">getDatabaseUser</a></strong>()</code>
<div class="block">Returns the database database user name if specified; otherwise null is returned.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getDataDirectory()">getDataDirectory</a></strong>()</code>
<div class="block">Get the value of dataDirectory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getNexusUrl()">getNexusUrl</a></strong>()</code>
<div class="block">Returns the url to the nexus server if one was specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getPathToMono()">getPathToMono</a></strong>()</code>
<div class="block">Returns the path to Mono for .NET Assembly analysis on non-windows systems.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getPropertiesFile()">getPropertiesFile</a></strong>()</code>
<div class="block">Returns the properties file specified on the command line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getProxyPassword()">getProxyPassword</a></strong>()</code>
<div class="block">Returns the proxy password.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getProxyPort()">getProxyPort</a></strong>()</code>
<div class="block">Returns the proxy port.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getProxyUrl()">getProxyUrl</a></strong>()</code>
<div class="block">Returns the proxy url.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getProxyUsername()">getProxyUsername</a></strong>()</code>
<div class="block">Returns the proxy username.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getReportDirectory()">getReportDirectory</a></strong>()</code>
<div class="block">Returns the directory to write the reports to specified on the command line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getReportFormat()">getReportFormat</a></strong>()</code>
<div class="block">Returns the output format specified on the command line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getScanFiles()">getScanFiles</a></strong>()</code>
<div class="block">Retrieves the file command line parameter(s) specified for the 'scan' argument.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getSuppressionFile()">getSuppressionFile</a></strong>()</code>
<div class="block">Returns the path to the suppression file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getVerboseLog()">getVerboseLog</a></strong>()</code>
<div class="block">Returns the path to the verbose log file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#isArchiveDisabled()">isArchiveDisabled</a></strong>()</code>
<div class="block">Returns true if the disableArchive command line argument was specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#isAssemblyDisabled()">isAssemblyDisabled</a></strong>()</code>
<div class="block">Returns true if the disableAssembly command line argument was specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#isAutoUpdate()">isAutoUpdate</a></strong>()</code>
<div class="block">Checks if the auto update feature has been disabled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#isGetHelp()">isGetHelp</a></strong>()</code>
<div class="block">Determines if the 'help' command line argument was passed in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#isGetVersion()">isGetVersion</a></strong>()</code>
<div class="block">Determines if the 'version' command line argument was passed in.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#isJarDisabled()">isJarDisabled</a></strong>()</code>
<div class="block">Returns true if the disableJar command line argument was specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#isNexusDisabled()">isNexusDisabled</a></strong>()</code>
<div class="block">Returns true if the disableNexus command line argument was specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#isNexusUsesProxy()">isNexusUsesProxy</a></strong>()</code>
<div class="block">Returns true if the Nexus Analyzer should use the configured proxy to connect to Nexus; otherwise false is
returned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#isNuspecDisabled()">isNuspecDisabled</a></strong>()</code>
<div class="block">Returns true if the disableNuspec command line argument was specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#isRunScan()">isRunScan</a></strong>()</code>
<div class="block">Determines if the 'scan' command line argument was passed in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#parse(java.lang.String[])">parse</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>
<div class="block">Parses the arguments passed in and captures the results for later use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#printHelp()">printHelp</a></strong>()</code>
<div class="block">Displays the command line help message to the standard output.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#printVersionInfo()">printVersionInfo</a></strong>()</code>
<div class="block">
Prints the manifest information to standard output.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CliParser()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CliParser</h4>
<pre>public&nbsp;CliParser()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="parse(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre>public&nbsp;void&nbsp;parse(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>,
org.apache.commons.cli.ParseException</pre>
<div class="block">Parses the arguments passed in and captures the results for later use.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - the command line arguments</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - is thrown when a 'file' argument does not point to a file that exists.</dd>
<dd><code>org.apache.commons.cli.ParseException</code> - is thrown when a Parse Exception occurs.</dd></dl>
</li>
</ul>
<a name="isGetVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGetVersion</h4>
<pre>public&nbsp;boolean&nbsp;isGetVersion()</pre>
<div class="block">Determines if the 'version' command line argument was passed in.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether or not the 'version' command line argument was passed in</dd></dl>
</li>
</ul>
<a name="isGetHelp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGetHelp</h4>
<pre>public&nbsp;boolean&nbsp;isGetHelp()</pre>
<div class="block">Determines if the 'help' command line argument was passed in.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether or not the 'help' command line argument was passed in</dd></dl>
</li>
</ul>
<a name="isRunScan()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRunScan</h4>
<pre>public&nbsp;boolean&nbsp;isRunScan()</pre>
<div class="block">Determines if the 'scan' command line argument was passed in.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether or not the 'scan' command line argument was passed in</dd></dl>
</li>
</ul>
<a name="isJarDisabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isJarDisabled</h4>
<pre>public&nbsp;boolean&nbsp;isJarDisabled()</pre>
<div class="block">Returns true if the disableJar command line argument was specified.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the disableJar command line argument was specified; otherwise false</dd></dl>
</li>
</ul>
<a name="isArchiveDisabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isArchiveDisabled</h4>
<pre>public&nbsp;boolean&nbsp;isArchiveDisabled()</pre>
<div class="block">Returns true if the disableArchive command line argument was specified.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the disableArchive command line argument was specified; otherwise false</dd></dl>
</li>
</ul>
<a name="isNuspecDisabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNuspecDisabled</h4>
<pre>public&nbsp;boolean&nbsp;isNuspecDisabled()</pre>
<div class="block">Returns true if the disableNuspec command line argument was specified.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the disableNuspec command line argument was specified; otherwise false</dd></dl>
</li>
</ul>
<a name="isAssemblyDisabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAssemblyDisabled</h4>
<pre>public&nbsp;boolean&nbsp;isAssemblyDisabled()</pre>
<div class="block">Returns true if the disableAssembly command line argument was specified.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the disableAssembly command line argument was specified; otherwise false</dd></dl>
</li>
</ul>
<a name="isNexusDisabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNexusDisabled</h4>
<pre>public&nbsp;boolean&nbsp;isNexusDisabled()</pre>
<div class="block">Returns true if the disableNexus command line argument was specified.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the disableNexus command line argument was specified; otherwise false</dd></dl>
</li>
</ul>
<a name="getNexusUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNexusUrl</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getNexusUrl()</pre>
<div class="block">Returns the url to the nexus server if one was specified.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the url to the nexus server; if none was specified this will return null;</dd></dl>
</li>
</ul>
<a name="isNexusUsesProxy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNexusUsesProxy</h4>
<pre>public&nbsp;boolean&nbsp;isNexusUsesProxy()</pre>
<div class="block">Returns true if the Nexus Analyzer should use the configured proxy to connect to Nexus; otherwise false is
returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the Nexus Analyzer should use the configured proxy to connect to Nexus; otherwise false</dd></dl>
</li>
</ul>
<a name="printHelp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printHelp</h4>
<pre>public&nbsp;void&nbsp;printHelp()</pre>
<div class="block">Displays the command line help message to the standard output.</div>
</li>
</ul>
<a name="getScanFiles()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScanFiles</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getScanFiles()</pre>
<div class="block">Retrieves the file command line parameter(s) specified for the 'scan' argument.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the file paths specified on the command line for scan</dd></dl>
</li>
</ul>
<a name="getReportDirectory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReportDirectory</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getReportDirectory()</pre>
<div class="block">Returns the directory to write the reports to specified on the command line.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the path to the reports directory.</dd></dl>
</li>
</ul>
<a name="getPathToMono()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPathToMono</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPathToMono()</pre>
<div class="block">Returns the path to Mono for .NET Assembly analysis on non-windows systems.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the path to Mono</dd></dl>
</li>
</ul>
<a name="getReportFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReportFormat</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getReportFormat()</pre>
<div class="block">Returns the output format specified on the command line. Defaults to HTML if no format was specified.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the output format name.</dd></dl>
</li>
</ul>
<a name="getApplicationName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getApplicationName()</pre>
<div class="block">Returns the application name specified on the command line.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the application name.</dd></dl>
</li>
</ul>
<a name="getConnectionTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionTimeout</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getConnectionTimeout()</pre>
<div class="block">Returns the connection timeout.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the connection timeout</dd></dl>
</li>
</ul>
<a name="getProxyUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProxyUrl</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getProxyUrl()</pre>
<div class="block">Returns the proxy url.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the proxy url</dd></dl>
</li>
</ul>
<a name="getProxyPort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProxyPort</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getProxyPort()</pre>
<div class="block">Returns the proxy port.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the proxy port</dd></dl>
</li>
</ul>
<a name="getProxyUsername()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProxyUsername</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getProxyUsername()</pre>
<div class="block">Returns the proxy username.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the proxy username</dd></dl>
</li>
</ul>
<a name="getProxyPassword()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProxyPassword</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getProxyPassword()</pre>
<div class="block">Returns the proxy password.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the proxy password</dd></dl>
</li>
</ul>
<a name="getDataDirectory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataDirectory</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDataDirectory()</pre>
<div class="block">Get the value of dataDirectory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the value of dataDirectory</dd></dl>
</li>
</ul>
<a name="getPropertiesFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertiesFile</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getPropertiesFile()</pre>
<div class="block">Returns the properties file specified on the command line.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the properties file specified on the command line</dd></dl>
</li>
</ul>
<a name="getVerboseLog()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVerboseLog</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getVerboseLog()</pre>
<div class="block">Returns the path to the verbose log file.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the path to the verbose log file</dd></dl>
</li>
</ul>
<a name="getSuppressionFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSuppressionFile</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getSuppressionFile()</pre>
<div class="block">Returns the path to the suppression file.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the path to the suppression file</dd></dl>
</li>
</ul>
<a name="printVersionInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printVersionInfo</h4>
<pre>public&nbsp;void&nbsp;printVersionInfo()</pre>
<div class="block"><p>
Prints the manifest information to standard output.</p>
<ul><li>Implementation-Title: ${pom.name}</li>
<li>Implementation-Version: ${pom.version}</li></ul></div>
</li>
</ul>
<a name="isAutoUpdate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAutoUpdate</h4>
<pre>public&nbsp;boolean&nbsp;isAutoUpdate()</pre>
<div class="block">Checks if the auto update feature has been disabled. If it has been disabled via the command line this will
return false.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>if auto-update is allowed.</dd></dl>
</li>
</ul>
<a name="getDatabaseDriverName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabaseDriverName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDatabaseDriverName()</pre>
<div class="block">Returns the database driver name if specified; otherwise null is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the database driver name if specified; otherwise null is returned</dd></dl>
</li>
</ul>
<a name="getDatabaseDriverPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabaseDriverPath</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDatabaseDriverPath()</pre>
<div class="block">Returns the database driver path if specified; otherwise null is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the database driver name if specified; otherwise null is returned</dd></dl>
</li>
</ul>
<a name="getConnectionString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionString</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getConnectionString()</pre>
<div class="block">Returns the database connection string if specified; otherwise null is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the database connection string if specified; otherwise null is returned</dd></dl>
</li>
</ul>
<a name="getDatabaseUser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabaseUser</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDatabaseUser()</pre>
<div class="block">Returns the database database user name if specified; otherwise null is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the database database user name if specified; otherwise null is returned</dd></dl>
</li>
</ul>
<a name="getDatabasePassword()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabasePassword</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDatabasePassword()</pre>
<div class="block">Returns the database database password if specified; otherwise null is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the database database password if specified; otherwise null is returned</dd></dl>
</li>
</ul>
<a name="getAdditionalZipExtensions()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAdditionalZipExtensions</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getAdditionalZipExtensions()</pre>
<div class="block">Returns the additional Extensions if specified; otherwise null is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the additional Extensions; otherwise null is returned</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CliParser.html">Use</a></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">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/owasp/dependencycheck/cli/CliParser.ArgumentName.html" title="class in org.owasp.dependencycheck.cli"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/owasp/dependencycheck/cli/CliParser.html" target="_top">Frames</a></li>
<li><a href="CliParser.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink