documentation update v1.4.4

This commit is contained in:
Jeremy Long
2016-11-05 09:41:16 -04:00
parent e1a447f722
commit a1b5e3f7b0
1217 changed files with 79708 additions and 51391 deletions

View File

@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Tue Sep 06 06:49:48 EDT 2016 -->
<!-- Generated by javadoc (1.8.0_92) on Sat Nov 05 07:42:40 EDT 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CliParser (Dependency-Check Command Line 1.4.3 API)</title>
<meta name="date" content="2016-09-06">
<title>CliParser (Dependency-Check Command Line 1.4.4 API)</title>
<meta name="date" content="2016-11-05">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
@@ -13,13 +13,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CliParser (Dependency-Check Command Line 1.4.3 API)";
parent.document.title="CliParser (Dependency-Check Command Line 1.4.4 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -254,263 +254,269 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
</tr>
<tr id="i12" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getHintsFile--">getHintsFile</a></span>()</code>
<div class="block">Returns the path to the hints file.</div>
</td>
</tr>
<tr id="i13" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getModifiedCve12Url--">getModifiedCve12Url</a></span>()</code>
<div class="block">Returns the URL for the modified CVE 1.2 XMl file.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<tr id="i14" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getModifiedCve20Url--">getModifiedCve20Url</a></span>()</code>
<div class="block">Returns the URL for the modified CVE 2.0 XMl file.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<tr id="i15" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getNexusUrl--">getNexusUrl</a></span>()</code>
<div class="block">Returns the url to the nexus server if one was specified.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<tr id="i16" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getPathToBundleAudit--">getPathToBundleAudit</a></span>()</code>
<div class="block">Returns the path to bundle-audit for Ruby bundle analysis.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<tr id="i17" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getPathToMono--">getPathToMono</a></span>()</code>
<div class="block">Returns the path to Mono for .NET Assembly analysis on non-windows
systems.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<tr id="i18" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getProjectName--">getProjectName</a></span>()</code>
<div class="block">Returns the application name specified on the command line.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<tr id="i19" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getPropertiesFile--">getPropertiesFile</a></span>()</code>
<div class="block">Returns the properties file specified on the command line.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<tr id="i20" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getProxyPassword--">getProxyPassword</a></span>()</code>
<div class="block">Returns the proxy password.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<tr id="i21" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getProxyPort--">getProxyPort</a></span>()</code>
<div class="block">Returns the proxy port.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<tr id="i22" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getProxyServer--">getProxyServer</a></span>()</code>
<div class="block">Returns the proxy server.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<tr id="i23" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getProxyUsername--">getProxyUsername</a></span>()</code>
<div class="block">Returns the proxy username.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<tr id="i24" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getReportDirectory--">getReportDirectory</a></span>()</code>
<div class="block">Returns the directory to write the reports to specified on the command
line.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<tr id="i25" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getReportFormat--">getReportFormat</a></span>()</code>
<div class="block">Returns the output format specified on the command line.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<tr id="i26" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getScanFiles--">getScanFiles</a></span>()</code>
<div class="block">Retrieves the file command line parameter(s) specified for the 'scan'
argument.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<tr id="i27" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getSuppressionFile--">getSuppressionFile</a></span>()</code>
<div class="block">Returns the path to the suppression file.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<tr id="i28" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getSymLinkDepth--">getSymLinkDepth</a></span>()</code>
<div class="block">Returns the symbolic link depth (how deeply symbolic links will be
followed).</div>
</td>
</tr>
<tr id="i28" class="altColor">
<tr id="i29" 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><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#getVerboseLog--">getVerboseLog</a></span>()</code>
<div class="block">Returns the path to the verbose log file.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<tr id="i30" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isArchiveDisabled--">isArchiveDisabled</a></span>()</code>
<div class="block">Returns true if the disableArchive command line argument was specified.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<tr id="i31" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isAssemblyDisabled--">isAssemblyDisabled</a></span>()</code>
<div class="block">Returns true if the disableAssembly command line argument was specified.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<tr id="i32" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isAutoconfDisabled--">isAutoconfDisabled</a></span>()</code>
<div class="block">Returns true if the disableAutoconf command line argument was specified.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<tr id="i33" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isAutoUpdate--">isAutoUpdate</a></span>()</code>
<div class="block">Checks if the auto update feature has been disabled.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<tr id="i34" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isBundleAuditDisabled--">isBundleAuditDisabled</a></span>()</code>
<div class="block">Returns true if the disableBundleAudit command line argument was
specified.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<tr id="i35" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isCentralDisabled--">isCentralDisabled</a></span>()</code>
<div class="block">Returns true if the disableCentral command line argument was specified.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<tr id="i36" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isCmakeDisabled--">isCmakeDisabled</a></span>()</code>
<div class="block">Returns true if the disableCmake command line argument was specified.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<tr id="i37" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isComposerDisabled--">isComposerDisabled</a></span>()</code>
<div class="block">Returns true if the disableComposer command line argument was specified.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<tr id="i38" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isExperimentalEnabled--">isExperimentalEnabled</a></span>()</code>
<div class="block">Returns true if the experimental analyzers are enabled.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<tr id="i39" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isGetHelp--">isGetHelp</a></span>()</code>
<div class="block">Determines if the 'help' command line argument was passed in.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<tr id="i40" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isGetVersion--">isGetVersion</a></span>()</code>
<div class="block">Determines if the 'version' command line argument was passed in.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<tr id="i41" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isJarDisabled--">isJarDisabled</a></span>()</code>
<div class="block">Returns true if the disableJar command line argument was specified.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<tr id="i42" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isNexusDisabled--">isNexusDisabled</a></span>()</code>
<div class="block">Returns true if the disableNexus command line argument was specified.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<tr id="i43" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isNexusUsesProxy--">isNexusUsesProxy</a></span>()</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 id="i43" class="rowColor">
<tr id="i44" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isNodeJsDisabled--">isNodeJsDisabled</a></span>()</code>
<div class="block">Returns true if the disableNodeJS command line argument was specified.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<tr id="i45" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isNuspecDisabled--">isNuspecDisabled</a></span>()</code>
<div class="block">Returns true if the disableNuspec command line argument was specified.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<tr id="i46" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isOpenSSLDisabled--">isOpenSSLDisabled</a></span>()</code>
<div class="block">Returns true if the disableOpenSSL command line argument was specified.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<tr id="i47" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isPurge--">isPurge</a></span>()</code>
<div class="block">Checks if the purge NVD flag has been set.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<tr id="i48" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isPythonDistributionDisabled--">isPythonDistributionDisabled</a></span>()</code>
<div class="block">Returns true if the disablePyDist command line argument was specified.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<tr id="i49" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isPythonPackageDisabled--">isPythonPackageDisabled</a></span>()</code>
<div class="block">Returns true if the disablePyPkg command line argument was specified.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<tr id="i50" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isRubyGemspecDisabled--">isRubyGemspecDisabled</a></span>()</code>
<div class="block">Returns whether the Ruby gemspec analyzer is disabled.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<tr id="i51" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isRunScan--">isRunScan</a></span>()</code>
<div class="block">Determines if the 'scan' command line argument was passed in.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<tr id="i52" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#isUpdateOnly--">isUpdateOnly</a></span>()</code>
<div class="block">Checks if the update only flag has been set.</div>
</td>
</tr>
<tr id="i52" class="altColor">
<tr id="i53" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#parse-java.lang.String:A-">parse</a></span>(<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 id="i53" class="rowColor">
<tr id="i54" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#printHelp--">printHelp</a></span>()</code>
<div class="block">Displays the command line help message to the standard output.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<tr id="i55" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/owasp/dependencycheck/CliParser.html#printVersionInfo--">printVersionInfo</a></span>()</code>
<div class="block">
@@ -1185,6 +1191,20 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
</dl>
</li>
</ul>
<a name="getHintsFile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHintsFile</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;getHintsFile()</pre>
<div class="block">Returns the path to the hints file.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the path to the hints file</dd>
</dl>
</li>
</ul>
<a name="printVersionInfo--">
<!-- -->
</a>