Public libsu 6.0.0 javadoc

com/topjohnwu/superuser/Shell.Builder.html

@@ -150,8 +150,7 @@ <h2>Method Summary</h2>
 <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 @@ <h3>setInitializers</h3>
 <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>

com/topjohnwu/superuser/Shell.Job.html

@@ -149,9 +149,9 @@ <h2>Method Summary</h2>
 <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 @@ <h2>Method Details</h2>
 <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>

com/topjohnwu/superuser/Shell.Task.html

@@ -86,7 +86,7 @@ <h1 title="Interface Shell.Task" class="title">Interface Shell.Task</h1>
 <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 @@ <h2>Method Summary</h2>
 <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 @@ <h3>run</h3>
  <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 @@ <h3>run</h3>
 </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>