github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-23 09:31:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation v1.3.1

Browse Source
This commit is contained in:
Jeremy Long
2015-09-20 07:41:29 -04:00
parent 4fd8873223
commit 191c5fae56
1456 changed files with 125936 additions and 63077 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
dependency-check-utils/apidocs/org/owasp/dependencycheck/utils/FileUtils.html
View File

@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_71) on Tue Aug 04 20:16:24 EDT 2015 -->
<!-- Generated by javadoc (version 1.7.0_71) on Sun Sep 20 06:42:19 EDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>FileUtils (Dependency-Check Utils 1.3.0 API)</title>
<meta name="date" content="2015-08-04">
<title>FileUtils (Dependency-Check Utils 1.3.1 API)</title>
<meta name="date" content="2015-09-20">
<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.3.0 API)";
parent.document.title="FileUtils (Dependency-Check Utils 1.3.1 API)";
}
//-->
</script>
@@ -25,8 +25,7 @@
<!-- -->
</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><a href="../../../../org/owasp/dependencycheck/utils/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FileUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
@@ -133,29 +132,11 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/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>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/utils/FileUtils.html#getFileExtension(java.lang.String)">getFileExtension</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;fileName)</code>
<div class="block">Returns the (lowercase) file extension for a specified file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/utils/FileUtils.html#getPathToJar(java.lang.Class)">getPathToJar</a></strong>(<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 should no longer be used.</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/utils/FileUtils.html#getTempFile(java.lang.String,%20java.lang.String)">getTempFile</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;prefix,
@@ -225,45 +206,6 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<dd><code><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></code> - thrown if the temporary folder could not be created</dd></dl>
</li>
</ul>
<a name="getDataDirectory(java.lang.String, java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataDirectory</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
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>
<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>
<dd><code><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></code> - is thrown if the path could not be decoded</dd></dl>
</li>
</ul>
<a name="getPathToJar(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPathToJar</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
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>
<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>
<dd><code><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></code> - thrown if UTF-8 is not supported.</dd></dl>
</li>
</ul>
<a name="getBitBucket()">
<!-- -->
</a>
@@ -289,8 +231,7 @@ public static&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/io/Fil
<!-- -->
</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><a href="../../../../org/owasp/dependencycheck/utils/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FileUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>