| <!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 (1.8.0_144) on Sun May 10 12:47:43 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DeleteAction (Apache Log4j Core 2.13.3 API)</title> |
| <meta name="date" content="2020-05-10"> |
| <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"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DeleteAction (Apache Log4j Core 2.13.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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"> |
| <!-- --> |
| </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"> |
| <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/DeleteAction.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><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/CompositeAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeletingVisitor.html" title="class in org.apache.logging.log4j.core.appender.rolling.action"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html" target="_top">Frames</a></li> |
| <li><a href="DeleteAction.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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.appender.rolling.action.AbstractAction">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.apache.logging.log4j.core.appender.rolling.action</div> |
| <h2 title="Class DeleteAction" class="title">Class DeleteAction</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/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><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">org.apache.logging.log4j.core.appender.rolling.action.AbstractAction</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">org.apache.logging.log4j.core.appender.rolling.action.AbstractPathAction</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.core.appender.rolling.action.DeleteAction</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">Action</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@Plugin</a>(<a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html#name--">name</a>="Delete", |
| <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html#category--">category</a>="Core", |
| <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html#printObject--">printObject</a>=true) |
| public class <a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#line.40">DeleteAction</a> |
| extends <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">AbstractPathAction</a></pre> |
| <div class="block">Rollover or scheduled action for deleting old log files that are accepted by the specified PathFilters.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.appender.rolling.action.AbstractAction"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.logging.log4j.core.appender.rolling.action.<a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">AbstractAction</a></h3> |
| <code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html#LOGGER">LOGGER</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">DeleteAction</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#createDeleteAction-java.lang.String-boolean-int-boolean-org.apache.logging.log4j.core.appender.rolling.action.PathSorter-org.apache.logging.log4j.core.appender.rolling.action.PathCondition:A-org.apache.logging.log4j.core.appender.rolling.action.ScriptCondition-org.apache.logging.log4j.core.config.Configuration-">createDeleteAction</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> basePath, |
| boolean followLinks, |
| int maxDepth, |
| boolean testMode, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathSorter.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">PathSorter</a> sorterParameter, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathCondition.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">PathCondition</a>[] pathConditions, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/ScriptCondition.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">ScriptCondition</a> scriptCondition, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config)</code> |
| <div class="block">Create a DeleteAction.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileVisitor.html?is-external=true" title="class or interface in java.nio.file">FileVisitor</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#createFileVisitor-java.nio.file.Path-java.util.List-">createFileVisitor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> visitorBaseDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathCondition.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">PathCondition</a>> conditions)</code> |
| <div class="block">Creates a new <code>FileVisitor<Path></code> to pass to the <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Files.html?is-external=true#walkFileTree-java.nio.file.Path-java.util.Set-int-java.nio.file.FileVisitor-" title="class or interface in java.nio.file"><code>Files.walkFileTree(Path, Set, int, FileVisitor)</code></a> |
| method when the <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#execute--"><code>AbstractPathAction.execute()</code></a> method is invoked.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#delete-java.nio.file.Path-">delete</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> path)</code> |
| <div class="block">Deletes the specified file.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#execute--">execute</a></span>()</code> |
| <div class="block">Performs action.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#execute-java.nio.file.FileVisitor-">execute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileVisitor.html?is-external=true" title="class or interface in java.nio.file">FileVisitor</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>> visitor)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#isTestMode--">isTestMode</a></span>()</code> |
| <div class="block">Returns <code>true</code> if files are not deleted even when all conditions accept a path, <code>false</code> otherwise.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.appender.rolling.action.AbstractPathAction"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.logging.log4j.core.appender.rolling.action.<a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">AbstractPathAction</a></h3> |
| <code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#getBasePath--">getBasePath</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#getBasePathString--">getBasePathString</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#getMaxDepth--">getMaxDepth</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#getOptions--">getOptions</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#getPathConditions--">getPathConditions</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#getStrSubstitutor--">getStrSubstitutor</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#isFollowSymbolicLinks--">isFollowSymbolicLinks</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#toString--">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.appender.rolling.action.AbstractAction"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.logging.log4j.core.appender.rolling.action.<a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">AbstractAction</a></h3> |
| <code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html#close--">close</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html#isComplete--">isComplete</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html#isInterrupted--">isInterrupted</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html#reportException-java.lang.Exception-">reportException</a>, <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html#run--">run</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="execute--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public boolean <a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#line.81">execute</a>() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html#execute--">AbstractAction</a></code></span></div> |
| <div class="block">Performs action.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html#execute--">execute</a></code> in interface <code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">Action</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#execute--">execute</a></code> in class <code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">AbstractPathAction</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if successful.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if IO error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="delete-java.nio.file.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre>protected void <a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#line.120">delete</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> path) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Deletes the specified file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the file to delete</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if a problem occurred deleting the file</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-java.nio.file.FileVisitor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public boolean <a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#line.131">execute</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileVisitor.html?is-external=true" title="class or interface in java.nio.file">FileVisitor</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>> visitor) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#execute-java.nio.file.FileVisitor-">execute</a></code> in class <code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">AbstractPathAction</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isTestMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTestMode</h4> |
| <pre>public boolean <a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#line.172">isTestMode</a>()</pre> |
| <div class="block">Returns <code>true</code> if files are not deleted even when all conditions accept a path, <code>false</code> otherwise.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if files are not deleted even when all conditions accept a path, <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createFileVisitor-java.nio.file.Path-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFileVisitor</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileVisitor.html?is-external=true" title="class or interface in java.nio.file">FileVisitor</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>> <a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#line.177">createFileVisitor</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> visitorBaseDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathCondition.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">PathCondition</a>> conditions)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#createFileVisitor-java.nio.file.Path-java.util.List-">AbstractPathAction</a></code></span></div> |
| <div class="block">Creates a new <code>FileVisitor<Path></code> to pass to the <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Files.html?is-external=true#walkFileTree-java.nio.file.Path-java.util.Set-int-java.nio.file.FileVisitor-" title="class or interface in java.nio.file"><code>Files.walkFileTree(Path, Set, int, FileVisitor)</code></a> |
| method when the <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#execute--"><code>AbstractPathAction.execute()</code></a> method is invoked. |
| <p> |
| The visitor is responsible for processing the files it encounters that are accepted by all filters.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#createFileVisitor-java.nio.file.Path-java.util.List-">createFileVisitor</a></code> in class <code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">AbstractPathAction</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>visitorBaseDir</code> - base dir from where to start scanning for files to process</dd> |
| <dd><code>conditions</code> - filters that determine if a file should be processed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <code>FileVisitor<Path></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createDeleteAction-java.lang.String-boolean-int-boolean-org.apache.logging.log4j.core.appender.rolling.action.PathSorter-org.apache.logging.log4j.core.appender.rolling.action.PathCondition:A-org.apache.logging.log4j.core.appender.rolling.action.ScriptCondition-org.apache.logging.log4j.core.config.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createDeleteAction</h4> |
| <pre><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginFactory</a> |
| public static <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">DeleteAction</a> <a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html#line.200">createDeleteAction</a>(<a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="basePath") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> basePath, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="followLinks") |
| boolean followLinks, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="maxDepth",<a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultInt--">defaultInt</a>=1) |
| int maxDepth, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="testMode") |
| boolean testMode, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginElement</a>(<a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginElement.html#value--">value</a>="PathSorter") |
| <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathSorter.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">PathSorter</a> sorterParameter, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginElement</a>(<a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginElement.html#value--">value</a>="PathConditions") |
| <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathCondition.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action">PathCondition</a>[] pathConditions, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginElement</a>(<a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginElement.html#value--">value</a>="ScriptCondition") |
| <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/ScriptCondition.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">ScriptCondition</a> scriptCondition, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginConfiguration.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginConfiguration</a> |
| <a href="../../../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config)</pre> |
| <div class="block">Create a DeleteAction.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>basePath</code> - base path from where to start scanning for files to delete.</dd> |
| <dd><code>followLinks</code> - whether to follow symbolic links. Default is false.</dd> |
| <dd><code>maxDepth</code> - The maxDepth parameter is the maximum number of levels of directories to visit. A value of 0 |
| means that only the starting file is visited, unless denied by the security manager. A value of |
| MAX_VALUE may be used to indicate that all levels should be visited.</dd> |
| <dd><code>testMode</code> - if true, files are not deleted but instead a message is printed to the <a |
| href="http://logging.apache.org/log4j/2.x/manual/configuration.html#StatusMessages">status logger</a> |
| at INFO level. Users can use this to do a dry run to test if their configuration works as expected. |
| Default is false.</dd> |
| <dd><code>PathSorter</code> - a plugin implementing the <a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PathSorter.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action"><code>PathSorter</code></a> interface</dd> |
| <dd><code>PathConditions</code> - an array of path conditions (if more than one, they all need to accept a path before it is |
| deleted).</dd> |
| <dd><code>config</code> - The Configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A DeleteAction.</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> |
| <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"> |
| <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/DeleteAction.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><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/CompositeAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/DeletingVisitor.html" title="class in org.apache.logging.log4j.core.appender.rolling.action"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.html" target="_top">Frames</a></li> |
| <li><a href="DeleteAction.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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.appender.rolling.action.AbstractAction">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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><p align="center">Copyright © 1999-2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p> |
| </body> |
| </html> |
