github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-24 18:11:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

v1.3.5 documentation

Browse Source
This commit is contained in:
Jeremy Long
2016-03-05 16:23:56 -05:00
parent 879a7165b1
commit 235a3c36cc
1164 changed files with 53112 additions and 46024 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2,26 +2,39 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_71) on Sun Jan 31 08:29:35 EST 2016 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>FileUtils (Dependency-Check Utils 1.3.4 API)</title>
<meta name="date" content="2016-01-31">
<!-- Generated by javadoc (1.8.0_31) on Sat Mar 05 13:21:25 EST 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FileUtils (Dependency-Check Utils 1.3.5 API)</title>
<meta name="date" content="2016-03-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FileUtils (Dependency-Check Utils 1.3.4 API)";
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FileUtils (Dependency-Check Utils 1.3.5 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<div class="topNav"><a name="navbar.top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
@@ -36,15 +49,15 @@
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html" title="class in org.owasp.dependencycheck.utils"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils"><span class="strong">Next Class</span></a></li>
<li><a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html" title="class in org.owasp.dependencycheck.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/owasp/dependencycheck/utils/FileUtils.html" target="_top">Frames</a></li>
<li><a href="FileUtils.html" target="_top">No Frames</a></li>
<li><a href="FileUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -64,16 +77,16 @@
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
@@ -96,11 +109,13 @@
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">FileUtils</span>
<pre>public final class <span class="typeNameLabel">FileUtils</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 collection of utilities for processing information about files.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Jeremy Long</dd></dl>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Jeremy Long</dd>
</dl>
</li>
</ul>
</div>
@@ -109,48 +124,48 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></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">
<tr id="i0" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/utils/FileUtils.html#delete(java.io.File)">delete</a></strong>(<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;file)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/utils/FileUtils.html#delete-java.io.File-">delete</a></span>(<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;file)</code>
<div class="block">Deletes a file.</div>
</td>
</tr>
<tr class="rowColor">
<tr id="i1" 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#getBitBucket()">getBitBucket</a></strong>()</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/utils/FileUtils.html#getBitBucket--">getBitBucket</a></span>()</code>
<div class="block">Return the bit bucket for the OS.</div>
</td>
</tr>
<tr class="altColor">
<tr id="i2" class="altColor">
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/utils/FileUtils.html#getFileExtension-java.lang.String-">getFileExtension</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;fileName)</code>
<div class="block">Returns the (lowercase) file extension for a specified file.</div>
</td>
</tr>
<tr class="rowColor">
<tr id="i3" 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,
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/utils/FileUtils.html#getTempFile-java.lang.String-java.lang.String-">getTempFile</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;prefix,
<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;extension)</code>
<div class="block">Generates a new temporary file name that is guaranteed to be unique.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<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,%20int)" title="class or interface in java.lang">wait</a></code></li>
<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>
@@ -162,11 +177,11 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getFileExtension(java.lang.String)">
<a name="getFileExtension-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
@@ -174,11 +189,15 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<h4>getFileExtension</h4>
<pre>public static&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;getFileExtension(<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)</pre>
<div class="block">Returns the (lowercase) file extension for a specified file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - the file name to retrieve the file extension from.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the file extension.</dd></dl>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileName</code> - the file name to retrieve the file extension from.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the file extension.</dd>
</dl>
</li>
</ul>
<a name="delete(java.io.File)">
<a name="delete-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
@@ -186,27 +205,36 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<h4>delete</h4>
<pre>public static&nbsp;boolean&nbsp;delete(<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;file)</pre>
<div class="block">Deletes a file. If the File is a directory it will recursively delete the contents.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - the File to delete</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the file was deleted successfully, otherwise false</dd></dl>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>file</code> - the File to delete</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the file was deleted successfully, otherwise false</dd>
</dl>
</li>
</ul>
<a name="getTempFile(java.lang.String, java.lang.String)">
<a name="getTempFile-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTempFile</h4>
<pre>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;getTempFile(<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,
<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;extension)
<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;extension)
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">Generates a new temporary file name that is guaranteed to be unique.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefix</code> - the prefix for the file name to generate</dd><dd><code>extension</code> - the extension of the generated file name</dd>
<dt><span class="strong">Returns:</span></dt><dd>a temporary File</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> - thrown if the temporary folder could not be created</dd></dl>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prefix</code> - the prefix for the file name to generate</dd>
<dd><code>extension</code> - the extension of the generated file name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a temporary File</dd>
<dt><span class="throwsLabel">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> - thrown if the temporary folder could not be created</dd>
</dl>
</li>
</ul>
<a name="getBitBucket()">
<a name="getBitBucket--">
<!-- -->
</a>
<ul class="blockListLast">
@@ -214,7 +242,10 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<h4>getBitBucket</h4>
<pre>public static&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;getBitBucket()</pre>
<div class="block">Return the bit bucket for the OS. '/dev/null' for Unix and 'NUL' for Windows</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a String containing the bit bucket</dd></dl>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String containing the bit bucket</dd>
</dl>
</li>
</ul>
</li>
@@ -225,9 +256,11 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
@@ -242,15 +275,15 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html" title="class in org.owasp.dependencycheck.utils"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils"><span class="strong">Next Class</span></a></li>
<li><a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html" title="class in org.owasp.dependencycheck.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/owasp/dependencycheck/utils/FileUtils.html" target="_top">Frames</a></li>
<li><a href="FileUtils.html" target="_top">No Frames</a></li>
<li><a href="FileUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -270,16 +303,16 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->