Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / api / org / apache / hadoop / fs / FSDataOutputStreamBuilder.html
blob: 6567904f06be66909892245793b232bc5d9012f5 [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_292) on Tue Jun 15 06:00:48 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FSDataOutputStreamBuilder (Apache Hadoop Main 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<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="FSDataOutputStreamBuilder (Apache Hadoop Main 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":6,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":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/FSDataOutputStreamBuilder.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/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/hadoop/fs/FSError.html" title="class in org.apache.hadoop.fs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" target="_top">Frames</a></li>
<li><a href="FSDataOutputStreamBuilder.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.hadoop.fs.impl.AbstractFSBuilderImpl">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.hadoop.fs</div>
<h2 title="Class FSDataOutputStreamBuilder" class="title">Class FSDataOutputStreamBuilder&lt;S extends <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a>,B extends FSDataOutputStreamBuilder&lt;S,B&gt;&gt;</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/hadoop/fs/impl/AbstractFSBuilderImpl.html" title="class in org.apache.hadoop.fs.impl">org.apache.hadoop.fs.impl.AbstractFSBuilderImpl</a>&lt;S,B&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.fs.FSDataOutputStreamBuilder&lt;S,B&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/hadoop/fs/FSBuilder.html" title="interface in org.apache.hadoop.fs">FSBuilder</a>&lt;S,B&gt;</dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Public
@InterfaceStability.Evolving
public abstract class <span class="typeNameLabel">FSDataOutputStreamBuilder&lt;S extends <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a>,B extends FSDataOutputStreamBuilder&lt;S,B&gt;&gt;</span>
extends <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html" title="class in org.apache.hadoop.fs.impl">AbstractFSBuilderImpl</a>&lt;S,B&gt;</pre>
<div class="block">Builder for <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs"><code>FSDataOutputStream</code></a> and its subclasses.
It is used to create <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs"><code>FSDataOutputStream</code></a> when creating a new file or
appending an existing file on <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs"><code>FileSystem</code></a>.
By default, it does not create parent directory that do not exist.
<a href="../../../../org/apache/hadoop/fs/FileSystem.html#createNonRecursive-org.apache.hadoop.fs.Path-boolean-int-short-long-org.apache.hadoop.util.Progressable-"><code>FileSystem.createNonRecursive(Path, boolean, int, short, long,
Progressable)</code></a>.
To create missing parent directory, use <a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#recursive--"><code>recursive()</code></a>.
To be more generic, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#opt-java.lang.String-int-"><code>AbstractFSBuilderImpl.opt(String, int)</code></a> and <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#must-java.lang.String-int-"><code>AbstractFSBuilderImpl.must(String, int)</code></a>
variants provide implementation-agnostic way to customize the builder.
Each FS-specific builder implementation can interpret the FS-specific
options accordingly, for example:
<code>
// Don't
if (fs instanceof FooFileSystem) {
FooFileSystem fs = (FooFileSystem) fs;
OutputStream out = dfs.createFile(path)
.optionA()
.optionB("value")
.cache()
.build()
} else if (fs instanceof BarFileSystem) {
...
}
// Do
OutputStream out = fs.createFile(path)
.permission(perm)
.bufferSize(bufSize)
.opt("foofs:option.a", true)
.opt("foofs:option.b", "value")
.opt("barfs:cache", true)
.must("foofs:cache", true)
.must("barfs:cache-size", 256 * 1024 * 1024)
.build();
</code>
If the option is not related to the file system, the option will be ignored.
If the option is must, but not supported by the file system, a
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown.</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.hadoop.fs.impl.AbstractFSBuilderImpl">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.hadoop.fs.impl.<a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html" title="class in org.apache.hadoop.fs.impl">AbstractFSBuilderImpl</a></h3>
<code><a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#UNKNOWN_MANDATORY_KEY">UNKNOWN_MANDATORY_KEY</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/hadoop/fs/FSDataOutputStreamBuilder.html#FSDataOutputStreamBuilder-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-">FSDataOutputStreamBuilder</a></span>(<a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a>&nbsp;fileSystem,
<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>&nbsp;p)</code>
<div class="block">Constructor.</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><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#append--">append</a></span>()</code>
<div class="block">Append to an existing file (optional operation).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#blockSize-long-">blockSize</a></span>(long&nbsp;blkSize)</code>
<div class="block">Set block size.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#bufferSize-int-">bufferSize</a></span>(int&nbsp;bufSize)</code>
<div class="block">Set the size of the buffer to be used.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">S</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#build--">build</a></span>()</code>
<div class="block">Create the FSDataOutputStream to write on the file system.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#checksumOpt-org.apache.hadoop.fs.Options.ChecksumOpt-">checksumOpt</a></span>(org.apache.hadoop.fs.Options.ChecksumOpt&nbsp;chksumOpt)</code>
<div class="block">Set checksum opt.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#create--">create</a></span>()</code>
<div class="block">Create an FSDataOutputStream at the specified path.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#getBlockSize--">getBlockSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#getBufferSize--">getBufferSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected org.apache.hadoop.fs.Options.ChecksumOpt</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#getChecksumOpt--">getChecksumOpt</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;<a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs">CreateFlag</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#getFlags--">getFlags</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#getFS--">getFS</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#getPermission--">getPermission</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#getProgress--">getProgress</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#getReplication--">getReplication</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#getThisBuilder--">getThisBuilder</a></span>()</code>
<div class="block">Return the concrete implementation of the builder instance.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#isRecursive--">isRecursive</a></span>()</code>
<div class="block">Return true to create the parent directories if they do not exist.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#overwrite-boolean-">overwrite</a></span>(boolean&nbsp;overwrite)</code>
<div class="block">Set to true to overwrite the existing file.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#permission-org.apache.hadoop.fs.permission.FsPermission-">permission</a></span>(<a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a>&nbsp;perm)</code>
<div class="block">Set permission for the file.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#progress-org.apache.hadoop.util.Progressable-">progress</a></span>(<a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a>&nbsp;prog)</code>
<div class="block">Set the facility of reporting progress.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#recursive--">recursive</a></span>()</code>
<div class="block">Create the parent directory if they do not exist.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#replication-short-">replication</a></span>(short&nbsp;replica)</code>
<div class="block">Set replication factor.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.fs.impl.AbstractFSBuilderImpl">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.fs.impl.<a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html" title="class in org.apache.hadoop.fs.impl">AbstractFSBuilderImpl</a></h3>
<code><a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#getMandatoryKeys--">getMandatoryKeys</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#getOptionalPath--">getOptionalPath</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#getOptionalPathHandle--">getOptionalPathHandle</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#getOptions--">getOptions</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#getPath--">getPath</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#getPathHandle--">getPathHandle</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#must-java.lang.String-boolean-">must</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#must-java.lang.String-double-">must</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#must-java.lang.String-float-">must</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#must-java.lang.String-int-">must</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#must-java.lang.String-java.lang.String...-">must</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#must-java.lang.String-java.lang.String-">must</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#opt-java.lang.String-boolean-">opt</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#opt-java.lang.String-double-">opt</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#opt-java.lang.String-float-">opt</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#opt-java.lang.String-int-">opt</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#opt-java.lang.String-java.lang.String...-">opt</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#opt-java.lang.String-java.lang.String-">opt</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#rejectUnknownMandatoryKeys-java.util.Collection-java.lang.String-">rejectUnknownMandatoryKeys</a>, <a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#rejectUnknownMandatoryKeys-java.util.Set-java.util.Collection-java.lang.String-">rejectUnknownMandatoryKeys</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#toString--" title="class or interface in java.lang">toString</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="FSDataOutputStreamBuilder-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FSDataOutputStreamBuilder</h4>
<pre>protected&nbsp;FSDataOutputStreamBuilder(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a>&nbsp;fileSystem,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>&nbsp;p)</pre>
<div class="block">Constructor.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getThisBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThisBuilder</h4>
<pre>public abstract&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&nbsp;getThisBuilder()</pre>
<div class="block">Return the concrete implementation of the builder instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html#getThisBuilder--">getThisBuilder</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/hadoop/fs/impl/AbstractFSBuilderImpl.html" title="class in org.apache.hadoop.fs.impl">AbstractFSBuilderImpl</a>&lt;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">S</a> extends <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a>,<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a> extends <a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="class in org.apache.hadoop.fs">FSDataOutputStreamBuilder</a>&lt;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">S</a>,<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&gt;&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object, typecast</dd>
</dl>
</li>
</ul>
<a name="getFS--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFS</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a>&nbsp;getFS()</pre>
</li>
</ul>
<a name="getPermission--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPermission</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a>&nbsp;getPermission()</pre>
</li>
</ul>
<a name="permission-org.apache.hadoop.fs.permission.FsPermission-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>permission</h4>
<pre>public&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&nbsp;permission(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a>&nbsp;perm)</pre>
<div class="block">Set permission for the file.</div>
</li>
</ul>
<a name="getBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferSize</h4>
<pre>protected&nbsp;int&nbsp;getBufferSize()</pre>
</li>
</ul>
<a name="bufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bufferSize</h4>
<pre>public&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&nbsp;bufferSize(int&nbsp;bufSize)</pre>
<div class="block">Set the size of the buffer to be used.</div>
</li>
</ul>
<a name="getReplication--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReplication</h4>
<pre>protected&nbsp;short&nbsp;getReplication()</pre>
</li>
</ul>
<a name="replication-short-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replication</h4>
<pre>public&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&nbsp;replication(short&nbsp;replica)</pre>
<div class="block">Set replication factor.</div>
</li>
</ul>
<a name="getBlockSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBlockSize</h4>
<pre>protected&nbsp;long&nbsp;getBlockSize()</pre>
</li>
</ul>
<a name="blockSize-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>blockSize</h4>
<pre>public&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&nbsp;blockSize(long&nbsp;blkSize)</pre>
<div class="block">Set block size.</div>
</li>
</ul>
<a name="isRecursive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRecursive</h4>
<pre>protected&nbsp;boolean&nbsp;isRecursive()</pre>
<div class="block">Return true to create the parent directories if they do not exist.</div>
</li>
</ul>
<a name="recursive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recursive</h4>
<pre>public&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&nbsp;recursive()</pre>
<div class="block">Create the parent directory if they do not exist.</div>
</li>
</ul>
<a name="getProgress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProgress</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a>&nbsp;getProgress()</pre>
</li>
</ul>
<a name="progress-org.apache.hadoop.util.Progressable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>progress</h4>
<pre>public&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&nbsp;progress(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a>&nbsp;prog)</pre>
<div class="block">Set the facility of reporting progress.</div>
</li>
</ul>
<a name="getFlags--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlags</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;<a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs">CreateFlag</a>&gt;&nbsp;getFlags()</pre>
</li>
</ul>
<a name="create--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&nbsp;create()</pre>
<div class="block">Create an FSDataOutputStream at the specified path.</div>
</li>
</ul>
<a name="overwrite-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>overwrite</h4>
<pre>public&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&nbsp;overwrite(boolean&nbsp;overwrite)</pre>
<div class="block">Set to true to overwrite the existing file.
Set it to false, an exception will be thrown when calling <a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html#build--"><code>build()</code></a>
if the file exists.</div>
</li>
</ul>
<a name="append--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre>public&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&nbsp;append()</pre>
<div class="block">Append to an existing file (optional operation).</div>
</li>
</ul>
<a name="getChecksumOpt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChecksumOpt</h4>
<pre>protected&nbsp;org.apache.hadoop.fs.Options.ChecksumOpt&nbsp;getChecksumOpt()</pre>
</li>
</ul>
<a name="checksumOpt-org.apache.hadoop.fs.Options.ChecksumOpt-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checksumOpt</h4>
<pre>public&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">B</a>&nbsp;checksumOpt(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
org.apache.hadoop.fs.Options.ChecksumOpt&nbsp;chksumOpt)</pre>
<div class="block">Set checksum opt.</div>
</li>
</ul>
<a name="build--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre>public abstract&nbsp;<a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="type parameter in FSDataOutputStreamBuilder">S</a>&nbsp;build()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a>,
<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">Create the FSDataOutputStream to write on the file system.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the parameters are not valid.</dd>
<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> - on errors when file system creates or appends the file.</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/FSDataOutputStreamBuilder.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/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/hadoop/fs/FSError.html" title="class in org.apache.hadoop.fs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" target="_top">Frames</a></li>
<li><a href="FSDataOutputStreamBuilder.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.hadoop.fs.impl.AbstractFSBuilderImpl">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>Copyright &#169; 2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>