Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-core / apidocs / org / apache / logging / log4j / core / appender / rolling / action / AbstractPathAction.html
blob: 6204ae80afe8d12bf87c4d24d62082014ba0a3e4 [file] [log] [blame]
<!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 Tue Feb 25 21:03:09 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractPathAction (Apache Log4j Core 2.13.1 API)</title>
<meta name="date" content="2020-02-25">
<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="AbstractPathAction (Apache Log4j Core 2.13.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AbstractPathAction.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/AbstractAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html" target="_top">Frames</a></li>
<li><a href="AbstractPathAction.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.appender.rolling.action.AbstractAction">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 AbstractPathAction" class="title">Class AbstractPathAction</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>org.apache.logging.log4j.core.appender.rolling.action.AbstractPathAction</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><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="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PosixViewAttributeAction</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.38">AbstractPathAction</a>
extends <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></pre>
<div class="block">Abstract action for processing 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&nbsp;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>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#AbstractPathAction-java.lang.String-boolean-int-org.apache.logging.log4j.core.appender.rolling.action.PathCondition:A-org.apache.logging.log4j.core.lookup.StrSubstitutor-">AbstractPathAction</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>&nbsp;basePath,
boolean&nbsp;followSymbolicLinks,
int&nbsp;maxDepth,
<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>[]&nbsp;pathFilters,
<a href="../../../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a>&nbsp;subst)</code>
<div class="block">Creates a new AbstractPathAction that starts scanning for files to process from the specified base path.</div>
</td>
</tr>
</table>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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 id="i0" class="altColor">
<td class="colFirst"><code>protected abstract <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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.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>&nbsp;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>&lt;<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>&gt;&nbsp;conditions)</code>
<div class="block">Creates a new <code>FileVisitor&lt;Path&gt;</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>execute()</code></a> method is invoked.</div>
</td>
</tr>
<tr id="i1" 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/AbstractPathAction.html#execute--">execute</a></span>()</code>
<div class="block">Performs action.</div>
</td>
</tr>
<tr id="i2" 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/AbstractPathAction.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>&lt;<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>&gt;&nbsp;visitor)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><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/AbstractPathAction.html#getBasePath--">getBasePath</a></span>()</code>
<div class="block">Returns the base path from where to start scanning for files to delete.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#getBasePathString--">getBasePathString</a></span>()</code>
<div class="block">Returns the base path as it was specified in the configuration.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#getMaxDepth--">getMaxDepth</a></span>()</code>
<div class="block">Returns the the maximum number of directory levels to visit.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileVisitOption.html?is-external=true" title="class or interface in java.nio.file">FileVisitOption</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#getOptions--">getOptions</a></span>()</code>
<div class="block">Returns whether to follow symbolic links or not.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#getPathConditions--">getPathConditions</a></span>()</code>
<div class="block">Returns the list of PathCondition objects.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#getStrSubstitutor--">getStrSubstitutor</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" 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/AbstractPathAction.html#isFollowSymbolicLinks--">isFollowSymbolicLinks</a></span>()</code>
<div class="block">Returns whether to follow symbolic links or not.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<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&nbsp;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&nbsp;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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractPathAction-java.lang.String-boolean-int-org.apache.logging.log4j.core.appender.rolling.action.PathCondition:A-org.apache.logging.log4j.core.lookup.StrSubstitutor-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractPathAction</h4>
<pre>protected&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.57">AbstractPathAction</a>(<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>&nbsp;basePath,
boolean&nbsp;followSymbolicLinks,
int&nbsp;maxDepth,
<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>[]&nbsp;pathFilters,
<a href="../../../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a>&nbsp;subst)</pre>
<div class="block">Creates a new AbstractPathAction that starts scanning for files to process from the specified base path.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>basePath</code> - base path from where to start scanning for files to process.</dd>
<dd><code>followSymbolicLinks</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>pathFilters</code> - an array of path filters (if more than one, they all need to accept a path before it is
processed).</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ 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&nbsp;boolean&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.68">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:&nbsp;<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>&nbsp;in interface&nbsp;<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">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/AbstractAction.html#execute--">execute</a></code>&nbsp;in class&nbsp;<code><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></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="execute-java.nio.file.FileVisitor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.72">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>&lt;<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>&gt;&nbsp;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="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="createFileVisitor-java.nio.file.Path-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFileVisitor</h4>
<pre>protected abstract&nbsp;<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>&lt;<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>&gt;&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.95">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>&nbsp;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>&lt;<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>&gt;&nbsp;conditions)</pre>
<div class="block">Creates a new <code>FileVisitor&lt;Path&gt;</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>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="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&lt;Path&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getBasePath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBasePath</h4>
<pre>public&nbsp;<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>&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.105">getBasePath</a>()</pre>
<div class="block">Returns the base path from where to start scanning for files to delete. Lookups are resolved, so if the
configuration was <code>&lt;Delete basePath="${sys:user.home}/abc" /&gt;</code> then this method returns a path
to the "abc" file or directory in the user's home directory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the base path (all lookups resolved)</dd>
</dl>
</li>
</ul>
<a name="getBasePathString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBasePathString</h4>
<pre>public&nbsp;<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>&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.114">getBasePathString</a>()</pre>
<div class="block">Returns the base path as it was specified in the configuration. Lookups are not resolved.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the base path as it was specified in the configuration</dd>
</dl>
</li>
</ul>
<a name="getStrSubstitutor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStrSubstitutor</h4>
<pre>public&nbsp;<a href="../../../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.118">getStrSubstitutor</a>()</pre>
</li>
</ul>
<a name="getOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptions</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileVisitOption.html?is-external=true" title="class or interface in java.nio.file">FileVisitOption</a>&gt;&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.127">getOptions</a>()</pre>
<div class="block">Returns whether to follow symbolic links or not.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the options</dd>
</dl>
</li>
</ul>
<a name="isFollowSymbolicLinks--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFollowSymbolicLinks</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.136">isFollowSymbolicLinks</a>()</pre>
<div class="block">Returns whether to follow symbolic links or not.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether to follow symbolic links or not</dd>
</dl>
</li>
</ul>
<a name="getMaxDepth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxDepth</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.145">getMaxDepth</a>()</pre>
<div class="block">Returns the the maximum number of directory levels to visit.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maxDepth</dd>
</dl>
</li>
</ul>
<a name="getPathConditions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPathConditions</h4>
<pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.154">getPathConditions</a>()</pre>
<div class="block">Returns the list of PathCondition objects.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the pathFilters</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<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>&nbsp;<a href="../../../../../../../../src-html/org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html#line.159">toString</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><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></code></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/AbstractPathAction.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/AbstractAction.html" title="class in org.apache.logging.log4j.core.appender.rolling.action"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/logging/log4j/core/appender/rolling/action/Action.html" title="interface in org.apache.logging.log4j.core.appender.rolling.action"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/logging/log4j/core/appender/rolling/action/AbstractPathAction.html" target="_top">Frames</a></li>
<li><a href="AbstractPathAction.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.appender.rolling.action.AbstractAction">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 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>