topjohnwu/libsu
1
0
Fork 0
mirror of https://github.com/topjohnwu/libsu.git synced 2024-11-26 21:40:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Public libsu 6.0.0 javadoc

Browse Source
This commit is contained in:
topjohnwu 2024-06-27 18:24:00 -07:00
parent 414a65fc7e
commit 4f1d61db5a
7 changed files with 106 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
com/topjohnwu/superuser/Shell.Builder.html
View File

@ -150,8 +150,7 @@ loadScripts(document, 'script');</script>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="Shell.Builder.html" title="class in com.topjohnwu.superuser">Shell.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setFlags(int)" class="member-name-link">setFlags</a><wbr>(int&nbsp;flags)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Set flags that controls how <code>Shell</code> works and how a new <code>Shell</code> will be
constructed.</div>
<div class="block">Set flags to control how a new <code>Shell</code> will be constructed.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="Shell.Builder.html" title="class in com.topjohnwu.superuser">Shell.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInitializers(java.lang.Class...)" class="member-name-link">setInitializers</a><wbr>(<a href="https://developer.android.com/reference/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;? extends <a href="Shell.Initializer.html" title="class in com.topjohnwu.superuser">Shell.Initializer</a>&gt;...&nbsp;classes)</code></div>
@ -233,14 +232,12 @@ loadScripts(document, 'script');</script>
<h3>setFlags</h3>
<div class="member-signature"><span class="annotations"><a href="https://developer.android.com/reference/androidx/annotation/NonNull.html" title="class or interface in androidx.annotation" class="external-link">@NonNull</a>
</span><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="Shell.Builder.html" title="class in com.topjohnwu.superuser">Shell.Builder</a></span>&nbsp;<span class="element-name">setFlags</span><wbr><span class="parameters">(int&nbsp;flags)</span></div>
<div class="block">Set flags that controls how <code>Shell</code> works and how a new <code>Shell</code> will be
constructed.</div>
<div class="block">Set flags to control how a new <code>Shell</code> will be constructed.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>flags</code> - the desired flags.
Value is either 0 or bitwise-or'd value of
<a href="Shell.html#FLAG_NON_ROOT_SHELL"><code>Shell.FLAG_NON_ROOT_SHELL</code></a>, <a href="Shell.html#FLAG_MOUNT_MASTER"><code>Shell.FLAG_MOUNT_MASTER</code></a>, or
<a href="Shell.html#FLAG_REDIRECT_STDERR"><code>Shell.FLAG_REDIRECT_STDERR</code></a></dd>
<a href="Shell.html#FLAG_NON_ROOT_SHELL"><code>Shell.FLAG_NON_ROOT_SHELL</code></a> or <a href="Shell.html#FLAG_MOUNT_MASTER"><code>Shell.FLAG_MOUNT_MASTER</code></a></dd>
<dt>Returns:</dt>
<dd>this Builder object for chaining of calls.</dd>
</dl>

14
com/topjohnwu/superuser/Shell.Job.html
View File

@ -149,9 +149,9 @@ loadScripts(document, 'script');</script>
<div class="block">Submit the job to an internal queue to run in the background.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="Shell.Job.html" title="class in com.topjohnwu.superuser">Shell.Job</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#to(java.util.List)" class="member-name-link">to</a><wbr>(<a href="https://developer.android.com/reference/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://developer.android.com/reference/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;output)</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#to(java.util.List)" class="member-name-link">to</a><wbr>(<a href="https://developer.android.com/reference/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://developer.android.com/reference/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;stdout)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Store output to a specific list.</div>
<div class="block">Store output of STDOUT to a specific list.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="Shell.Job.html" title="class in com.topjohnwu.superuser">Shell.Job</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#to(java.util.List,java.util.List)" class="member-name-link">to</a><wbr>(<a href="https://developer.android.com/reference/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://developer.android.com/reference/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;stdout,
@ -195,15 +195,11 @@ loadScripts(document, 'script');</script>
<h3>to</h3>
<div class="member-signature"><span class="annotations"><a href="https://developer.android.com/reference/androidx/annotation/NonNull.html" title="class or interface in androidx.annotation" class="external-link">@NonNull</a>
</span><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="Shell.Job.html" title="class in com.topjohnwu.superuser">Shell.Job</a></span>&nbsp;<span class="element-name">to</span><wbr><span class="parameters">(<a href="https://developer.android.com/reference/androidx/annotation/Nullable.html" title="class or interface in androidx.annotation" class="external-link">@Nullable</a>
<a href="https://developer.android.com/reference/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://developer.android.com/reference/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;output)</span></div>
<div class="block">Store output to a specific list.
<p>
Output of STDERR will be also be stored in the same <a href="https://developer.android.com/reference/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> if the flag
<a href="Shell.html#FLAG_REDIRECT_STDERR"><code>Shell.FLAG_REDIRECT_STDERR</code></a> is set; <a href="Shell.Result.html#getErr()"><code>Shell.Result.getErr()</code></a>
will always return an empty list.</div>
<a href="https://developer.android.com/reference/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://developer.android.com/reference/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;stdout)</span></div>
<div class="block">Store output of STDOUT to a specific list.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>output</code> - the list to store outputs. Pass <code>null</code> to omit all outputs.</dd>
<dd><code>stdout</code> - the list to store STDOUT. Pass <code>null</code> to omit all outputs.</dd>
<dt>Returns:</dt>
<dd>this Job object for chaining of calls.</dd>
</dl>

16
com/topjohnwu/superuser/Shell.Task.html
View File

@ -86,7 +86,7 @@ loadScripts(document, 'script');</script>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
@ -99,6 +99,11 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">This method will be called when a task is executed by a shell.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#shellDied()" class="member-name-link">shellDied</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">This method will be called when a shell is unable to execute this task.</div>
</div>
</div>
</div>
</div>
@ -124,7 +129,7 @@ loadScripts(document, 'script');</script>
<a href="https://developer.android.com/reference/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;stderr)</span>
throws <span class="exceptions"><a href="https://developer.android.com/reference/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">This method will be called when a task is executed by a shell.
Calling <a href="https://developer.android.com/reference/java/io/Closeable.html#close--" title="class or interface in java.io" class="external-link"><code>Closeable.close()</code></a> on all streams is NOP (does nothing).</div>
Calling <a href="https://developer.android.com/reference/java/io/Closeable.html#close--" title="class or interface in java.io" class="external-link"><code>Closeable.close()</code></a> on any stream is NOP (does nothing).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>stdin</code> - the STDIN of the shell.</dd>
@ -135,6 +140,13 @@ loadScripts(document, 'script');</script>
</dl>
</section>
</li>
<li>
<section class="detail" id="shellDied()">
<h3>shellDied</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">shellDied</span>()</div>
<div class="block">This method will be called when a shell is unable to execute this task.</div>
</section>
</li>
</ul>
</section>
</li>

105
com/topjohnwu/superuser/Shell.html
View File

@ -154,29 +154,29 @@ implements <a href="https://developer.android.com/reference/java/io/Closeable.ht
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static boolean</code></div>
<div class="col-second even-row-color"><code><a href="#enableVerboseLogging" class="member-name-link">enableVerboseLogging</a></code></div>
<div class="col-second even-row-color"><code><a href="#enableLegacyStderrRedirection" class="member-name-link">enableLegacyStderrRedirection</a></code></div>
<div class="col-last even-row-color">
<div class="block">This flag exists for compatibility reasons.</div>
</div>
<div class="col-first odd-row-color"><code>static boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#enableVerboseLogging" class="member-name-link">enableVerboseLogging</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Set to <code>true</code> to enable verbose logging throughout the library.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="https://developer.android.com/reference/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a></code></div>
<div class="col-second odd-row-color"><code><a href="#EXECUTOR" class="member-name-link">EXECUTOR</a></code></div>
<div class="col-last odd-row-color">
<div class="col-first even-row-color"><code>static <a href="https://developer.android.com/reference/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a></code></div>
<div class="col-second even-row-color"><code><a href="#EXECUTOR" class="member-name-link">EXECUTOR</a></code></div>
<div class="col-last even-row-color">
<div class="block">The <a href="https://developer.android.com/reference/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link"><code>Executor</code></a> that manages all worker threads used in <code>libsu</code>.</div>
</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#FLAG_MOUNT_MASTER" class="member-name-link">FLAG_MOUNT_MASTER</a></code></div>
<div class="col-last even-row-color">
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#FLAG_MOUNT_MASTER" class="member-name-link">FLAG_MOUNT_MASTER</a></code></div>
<div class="col-last odd-row-color">
<div class="block">If set, create a root shell with the <code>--mount-master</code> option.</div>
</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#FLAG_NON_ROOT_SHELL" class="member-name-link">FLAG_NON_ROOT_SHELL</a></code></div>
<div class="col-last odd-row-color">
<div class="block">If set, create a non-root shell.</div>
</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#FLAG_REDIRECT_STDERR" class="member-name-link">FLAG_REDIRECT_STDERR</a></code></div>
<div class="col-second even-row-color"><code><a href="#FLAG_NON_ROOT_SHELL" class="member-name-link">FLAG_NON_ROOT_SHELL</a></code></div>
<div class="col-last even-row-color">
<div class="block">If set, STDERR outputs will be redirected to STDOUT outputs.</div>
<div class="block">If set, create a non-root shell.</div>
</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#NON_ROOT_SHELL" class="member-name-link">NON_ROOT_SHELL</a></code></div>
@ -286,16 +286,21 @@ implements <a href="https://developer.android.com/reference/java/io/Closeable.ht
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Override the default <a href="Shell.Builder.html" title="class in com.topjohnwu.superuser"><code>Shell.Builder</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#waitAndClose()" class="member-name-link">waitAndClose</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#submitTask(com.topjohnwu.superuser.Shell.Task)" class="member-name-link">submitTask</a><wbr>(<a href="Shell.Task.html" title="interface in com.topjohnwu.superuser">Shell.Task</a>&nbsp;task)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Submits a low-level <a href="Shell.Task.html" title="interface in com.topjohnwu.superuser"><code>Shell.Task</code></a> for execution in a queue of the shell.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#waitAndClose()" class="member-name-link">waitAndClose</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Wait indefinitely for any current/pending tasks to finish before closing this shell
and release any system resources associated with the shell.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#waitAndClose(long,java.util.concurrent.TimeUnit)" class="member-name-link">waitAndClose</a><wbr>(long&nbsp;timeout,
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#waitAndClose(long,java.util.concurrent.TimeUnit)" class="member-name-link">waitAndClose</a><wbr>(long&nbsp;timeout,
<a href="https://developer.android.com/reference/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;unit)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Wait for any current/pending tasks to finish before closing this shell
and release any system resources associated with the shell.</div>
</div>
@ -405,31 +410,6 @@ implements <a href="https://developer.android.com/reference/java/io/Closeable.ht
</section>
</li>
<li>
<section class="detail" id="FLAG_REDIRECT_STDERR">
<h3>FLAG_REDIRECT_STDERR</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">FLAG_REDIRECT_STDERR</span></div>
<div class="block">If set, STDERR outputs will be redirected to STDOUT outputs.
<p>
Note: This flag only affects the following methods:
<ul>
<li><a href="#cmd(java.lang.String...)"><code>cmd(String...)</code></a></li>
<li><a href="#cmd(java.io.InputStream)"><code>cmd(InputStream)</code></a></li>
<li><a href="Shell.Job.html#to(java.util.List)"><code>Shell.Job.to(List)</code></a></li>
</ul>
Check the descriptions of each method above for more details.
<p>
Constant value 8.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../constant-values.html#com.topjohnwu.superuser.Shell.FLAG_REDIRECT_STDERR">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="EXECUTOR">
<h3>EXECUTOR</h3>
<div class="member-signature"><span class="annotations"><a href="https://developer.android.com/reference/androidx/annotation/NonNull.html" title="class or interface in androidx.annotation" class="external-link">@NonNull</a>
@ -447,6 +427,23 @@ implements <a href="https://developer.android.com/reference/java/io/Closeable.ht
<div class="block">Set to <code>true</code> to enable verbose logging throughout the library.</div>
</section>
</li>
<li>
<section class="detail" id="enableLegacyStderrRedirection">
<h3>enableLegacyStderrRedirection</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">enableLegacyStderrRedirection</span></div>
<div class="block">This flag exists for compatibility reasons. DO NOT use unless necessary.
<p>
If enabled, STDERR outputs will be redirected to the STDOUT output list
when a <a href="Shell.Job.html" title="class in com.topjohnwu.superuser"><code>Shell.Job</code></a> is configured with <a href="Shell.Job.html#to(java.util.List)"><code>Shell.Job.to(List)</code></a>.
Since the <code>Shell.cmd(...)</code> methods are functionally equivalent to
<code>Shell.getShell().newJob().add(...).to(new ArrayList&lt;&gt;())</code>, this variable
also affects the behavior of those methods.
<p>
Note: The recommended way to redirect STDERR output to STDOUT is to assign the
same list to both STDOUT and STDERR with <a href="Shell.Job.html#to(java.util.List,java.util.List)"><code>Shell.Job.to(List, List)</code></a>.
The behavior of this flag is unintuitive and error prone.</div>
</section>
</li>
</ul>
</section>
</li>
@ -667,6 +664,24 @@ implements <a href="https://developer.android.com/reference/java/io/Closeable.ht
</section>
</li>
<li>
<section class="detail" id="submitTask(com.topjohnwu.superuser.Shell.Task)">
<h3>submitTask</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">submitTask</span><wbr><span class="parameters">(<a href="https://developer.android.com/reference/androidx/annotation/NonNull.html" title="class or interface in androidx.annotation" class="external-link">@NonNull</a>
<a href="Shell.Task.html" title="interface in com.topjohnwu.superuser">Shell.Task</a>&nbsp;task)</span></div>
<div class="block">Submits a low-level <a href="Shell.Task.html" title="interface in com.topjohnwu.superuser"><code>Shell.Task</code></a> for execution in a queue of the shell.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>task</code> - the desired task.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#execTask(com.topjohnwu.superuser.Shell.Task)"><code>execTask(Task)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="newJob()">
<h3>newJob</h3>
<div class="member-signature"><span class="annotations"><a href="https://developer.android.com/reference/androidx/annotation/NonNull.html" title="class or interface in androidx.annotation" class="external-link">@NonNull</a>

21
constant-values.html
View File

@ -70,18 +70,15 @@ loadScripts(document, 'script');</script>
<div class="col-first odd-row-color"><code id="com.topjohnwu.superuser.Shell.FLAG_NON_ROOT_SHELL">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="com/topjohnwu/superuser/Shell.html#FLAG_NON_ROOT_SHELL">FLAG_NON_ROOT_SHELL</a></code></div>
<div class="col-last odd-row-color"><code>1</code></div>
<div class="col-first even-row-color"><code id="com.topjohnwu.superuser.Shell.FLAG_REDIRECT_STDERR">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="com/topjohnwu/superuser/Shell.html#FLAG_REDIRECT_STDERR">FLAG_REDIRECT_STDERR</a></code></div>
<div class="col-last even-row-color"><code>8</code></div>
<div class="col-first odd-row-color"><code id="com.topjohnwu.superuser.Shell.NON_ROOT_SHELL">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="com/topjohnwu/superuser/Shell.html#NON_ROOT_SHELL">NON_ROOT_SHELL</a></code></div>
<div class="col-last odd-row-color"><code>0</code></div>
<div class="col-first even-row-color"><code id="com.topjohnwu.superuser.Shell.ROOT_SHELL">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="com/topjohnwu/superuser/Shell.html#ROOT_SHELL">ROOT_SHELL</a></code></div>
<div class="col-last even-row-color"><code>1</code></div>
<div class="col-first odd-row-color"><code id="com.topjohnwu.superuser.Shell.UNKNOWN">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="com/topjohnwu/superuser/Shell.html#UNKNOWN">UNKNOWN</a></code></div>
<div class="col-last odd-row-color"><code>-1</code></div>
<div class="col-first even-row-color"><code id="com.topjohnwu.superuser.Shell.NON_ROOT_SHELL">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="com/topjohnwu/superuser/Shell.html#NON_ROOT_SHELL">NON_ROOT_SHELL</a></code></div>
<div class="col-last even-row-color"><code>0</code></div>
<div class="col-first odd-row-color"><code id="com.topjohnwu.superuser.Shell.ROOT_SHELL">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="com/topjohnwu/superuser/Shell.html#ROOT_SHELL">ROOT_SHELL</a></code></div>
<div class="col-last odd-row-color"><code>1</code></div>
<div class="col-first even-row-color"><code id="com.topjohnwu.superuser.Shell.UNKNOWN">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="com/topjohnwu/superuser/Shell.html#UNKNOWN">UNKNOWN</a></code></div>
<div class="col-last even-row-color"><code>-1</code></div>
</div>
</li>
<li>

21
index-all.html
View File

@ -198,6 +198,10 @@ loadScripts(document, 'script');</script>
</dl>
<h2 class="title" id="I:E">E</h2>
<dl class="index">
<dt><a href="com/topjohnwu/superuser/Shell.html#enableLegacyStderrRedirection" class="member-name-link">enableLegacyStderrRedirection</a> - Static variable in class com.topjohnwu.superuser.<a href="com/topjohnwu/superuser/Shell.html" title="class in com.topjohnwu.superuser">Shell</a></dt>
<dd>
<div class="block">This flag exists for compatibility reasons.</div>
</dd>
<dt><a href="com/topjohnwu/superuser/Shell.html#enableVerboseLogging" class="member-name-link">enableVerboseLogging</a> - Static variable in class com.topjohnwu.superuser.<a href="com/topjohnwu/superuser/Shell.html" title="class in com.topjohnwu.superuser">Shell</a></dt>
<dd>
<div class="block">Set to <code>true</code> to enable verbose logging throughout the library.</div>
@ -269,10 +273,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">If set, create a non-root shell.</div>
</dd>
<dt><a href="com/topjohnwu/superuser/Shell.html#FLAG_REDIRECT_STDERR" class="member-name-link">FLAG_REDIRECT_STDERR</a> - Static variable in class com.topjohnwu.superuser.<a href="com/topjohnwu/superuser/Shell.html" title="class in com.topjohnwu.superuser">Shell</a></dt>
<dd>
<div class="block">If set, STDERR outputs will be redirected to STDOUT outputs.</div>
</dd>
</dl>
<h2 class="title" id="I:G">G</h2>
<dl class="index">
@ -690,8 +690,7 @@ loadScripts(document, 'script');</script>
</dd>
<dt><a href="com/topjohnwu/superuser/Shell.Builder.html#setFlags(int)" class="member-name-link">setFlags(int)</a> - Method in class com.topjohnwu.superuser.<a href="com/topjohnwu/superuser/Shell.Builder.html" title="class in com.topjohnwu.superuser">Shell.Builder</a></dt>
<dd>
<div class="block">Set flags that controls how <code>Shell</code> works and how a new <code>Shell</code> will be
constructed.</div>
<div class="block">Set flags to control how a new <code>Shell</code> will be constructed.</div>
</dd>
<dt><a href="com/topjohnwu/superuser/Shell.Builder.html#setInitializers(java.lang.Class...)" class="member-name-link">setInitializers(Class&lt;? extends Shell.Initializer&gt;...)</a> - Method in class com.topjohnwu.superuser.<a href="com/topjohnwu/superuser/Shell.Builder.html" title="class in com.topjohnwu.superuser">Shell.Builder</a></dt>
<dd>
@ -760,6 +759,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">A task that can be executed by a shell with the method <a href="com/topjohnwu/superuser/Shell.html#execTask(com.topjohnwu.superuser.Shell.Task)"><code>Shell.execTask(Task)</code></a>.</div>
</dd>
<dt><a href="com/topjohnwu/superuser/Shell.Task.html#shellDied()" class="member-name-link">shellDied()</a> - Method in interface com.topjohnwu.superuser.<a href="com/topjohnwu/superuser/Shell.Task.html" title="interface in com.topjohnwu.superuser">Shell.Task</a></dt>
<dd>
<div class="block">This method will be called when a shell is unable to execute this task.</div>
</dd>
<dt><a href="com/topjohnwu/superuser/ShellUtils.html" class="type-name-link" title="class in com.topjohnwu.superuser">ShellUtils</a> - Class in <a href="com/topjohnwu/superuser/package-summary.html">com.topjohnwu.superuser</a></dt>
<dd>
<div class="block">Some handy utility methods that are used in <code>libsu</code>.</div>
@ -790,6 +793,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Submit the job to an internal queue to run in the background.</div>
</dd>
<dt><a href="com/topjohnwu/superuser/Shell.html#submitTask(com.topjohnwu.superuser.Shell.Task)" class="member-name-link">submitTask(Shell.Task)</a> - Method in class com.topjohnwu.superuser.<a href="com/topjohnwu/superuser/Shell.html" title="class in com.topjohnwu.superuser">Shell</a></dt>
<dd>
<div class="block">Submits a low-level <a href="com/topjohnwu/superuser/Shell.Task.html" title="interface in com.topjohnwu.superuser"><code>Shell.Task</code></a> for execution in a queue of the shell.</div>
</dd>
<dt><a href="com/topjohnwu/superuser/io/SuFile.html" class="type-name-link" title="class in com.topjohnwu.superuser.io">SuFile</a> - Class in <a href="com/topjohnwu/superuser/io/package-summary.html">com.topjohnwu.superuser.io</a></dt>
<dd>
<div class="block">A <a href="https://developer.android.com/reference/java/io/File.html" title="class or interface in java.io" class="external-link"><code>File</code></a> implementation using root shell.</div>
@ -821,7 +828,7 @@ loadScripts(document, 'script');</script>
<dl class="index">
<dt><a href="com/topjohnwu/superuser/Shell.Job.html#to(java.util.List)" class="member-name-link">to(List&lt;String&gt;)</a> - Method in class com.topjohnwu.superuser.<a href="com/topjohnwu/superuser/Shell.Job.html" title="class in com.topjohnwu.superuser">Shell.Job</a></dt>
<dd>
<div class="block">Store output to a specific list.</div>
<div class="block">Store output of STDOUT to a specific list.</div>
</dd>
<dt><a href="com/topjohnwu/superuser/Shell.Job.html#to(java.util.List,java.util.List)" class="member-name-link">to(List&lt;String&gt;, List&lt;String&gt;)</a> - Method in class com.topjohnwu.superuser.<a href="com/topjohnwu/superuser/Shell.Job.html" title="class in com.topjohnwu.superuser">Shell.Job</a></dt>
<dd>

2
member-search-index.js
View File

File diff suppressed because one or more lines are too long