version 1.3.0 documentation

This commit is contained in:
Jeremy Long
2015-08-05 15:38:32 -04:00
parent 5cc29d0a00
commit 4fd8873223
1212 changed files with 86425 additions and 43448 deletions

View File

@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_71) on Mon May 11 20:35:18 EDT 2015 -->
<!-- Generated by javadoc (version 1.7.0_71) on Tue Aug 04 20:16:24 EDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>FileUtils (Dependency-Check Utils 1.2.11 API)</title>
<meta name="date" content="2015-05-11">
<title>FileUtils (Dependency-Check Utils 1.3.0 API)</title>
<meta name="date" content="2015-08-04">
<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="FileUtils (Dependency-Check Utils 1.2.11 API)";
parent.document.title="FileUtils (Dependency-Check Utils 1.3.0 API)";
}
//-->
</script>
@@ -137,8 +137,8 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/utils/FileUtils.html#getDataDirectory(java.lang.String,%20java.lang.Class)">getDataDirectory</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;configuredFilePath,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;clazz)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>This method should no longer be used. See the implementation in dependency-check-cli/App.java to see
how the data directory should be set.</i></div>
<div class="block"><i>This method should no longer be used. See the implementation in dependency-check-cli/App.java to see how the
data directory should be set.</i></div>
</div>
</td>
</tr>
@@ -235,11 +235,11 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
public static&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;getDataDirectory(<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;configuredFilePath,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;clazz)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>This method should no longer be used. See the implementation in dependency-check-cli/App.java to see
how the data directory should be set.</i></div>
<div class="block">Returns the data directory. If a path was specified in dependencycheck.properties or was specified using the
Settings object, and the path exists, that path will be returned as a File object. If it does not exist, then a
File object will be created based on the file location of the JAR containing the specified class.</div>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>This method should no longer be used. See the implementation in dependency-check-cli/App.java to see how the
data directory should be set.</i></div>
<div class="block">Returns the data directory. If a path was specified in dependencycheck.properties or was specified using the Settings
object, and the path exists, that path will be returned as a File object. If it does not exist, then a File object will be
created based on the file location of the JAR containing the specified class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>configuredFilePath</code> - the configured relative or absolute path</dd><dd><code>clazz</code> - the class to resolve the path</dd>
<dt><span class="strong">Returns:</span></dt><dd>a File object</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -256,8 +256,8 @@ public static&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/io/Fil
public static&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;getPathToJar(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;clazz)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io">UnsupportedEncodingException</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>this should no longer be used.</i></div>
<div class="block">Retrieves the physical path to the parent directory containing the provided class. For example, if a JAR file
contained a class org.something.clazz this method would return the parent directory of the JAR file.</div>
<div class="block">Retrieves the physical path to the parent directory containing the provided class. For example, if a JAR file contained a
class org.something.clazz this method would return the parent directory of the JAR file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>clazz</code> - the class to determine the parent directory of</dd>
<dt><span class="strong">Returns:</span></dt><dd>the parent directory of the file containing the specified class.</dd>
<dt><span class="strong">Throws:</span></dt>